Transaction definition additional GL account details

This object provides the GL account mapping for purchasing transaction definitions that are configured to post cost of goods (COGS) adjustments to the General Ledger. The additional GL account detail is relevant when reversing or posting Cost of Goods for a purchasing transaction.

List transaction definition additional GL account details

get/objects/purchasing/txn-definition-additional-gl-detail

Returns a collection with a key, ID, and link for each transaction definition additional GL account detail object.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "239",
      • "id": "239",
      • "href": "/objects/purchasing/txn-definition-additional-gl-detail/239"
      },
    • {
      • "key": "240",
      • "id": "240",
      • "href": "/objects/purchasing/txn-definition-additional-gl-detail/240"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a transaction definition additional GL account detail object
post/objects/purchasing/txn-definition-additional-gl-detail
Creates a new transaction definition additional GL account detail object.


SecurityOAuth2 
Request 
Request Body schema: application/json
txnType
required
string
Indicate whether to debit or credit the corresponding GL account.


 Enum: "credit" "debit"  
 Example:  "debit"
isOffset
boolean
 Default:  false
If set to true, the GL account is marked as offset.


 
 Example:  true
lineNumber
integer  <= 8 characters 
Line number of the COGs GL detail on the transaction definition. If not provided, the system automatically assigns a unique line number. If you specify a lineNumber already used, the application sets other lines to unique numbers. The application uses this line number to post to the GL in the order provided.


 
 Example:  1
object
Set the GL account to which this transaction posts for the specified account mapping (itemGLGroup and warehouse).


 
id
required
string
Unique ID for the GL account.


 
 Example:  "1501.04"
key
string
Unique key for the GL account.


 
 Example:  "384"
object
Set the default location against which the line item will be recorded.


 
key
string
Unique key for the location.


 
 Example:  "56"
id
string
Unique ID for the location.


 
 Example:  "AZ"
object
Set the default department against which the line item will be recorded.


 
key
string
Unique key for the department.


 
 Example:  "29"
id
string
Unique ID for the department.


 
 Example:  "Sales"
object
The Item GL group and Warehouse together form the criteria set for the account mapping.


 
key
string
System-assigned key for the item GL group.


 
 Example:  "88"
id
string
Name of the item GL group.


 
 Example:  "Computers and parts"
object
The Item GL group and Warehouse together form the criteria set for the account mapping.


 
key
string
Unique key for the warehouse.


 
 Example:  "77"
id
string
Unique ID for the warehouse.


 
 Example:  "ARZ"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
Purchasing transaction definition associated with this additional GL account detail object.


 
key
required
string  <= 8 characters 
Unique key for the purchasing transaction definition.


 
 Example:  "77"
id
string  <= 30 characters 
Unique ID for the purchasing transaction definition.


 
 Example:  "Purchase Quote"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "purchasingTxnDefinition": {
    • "key": "91"
    },
  • "glAccount": {
    • "id": "1003"
    },
  • "txnType": "credit",
  • "lineNumber": 1
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "208",
    • "id": "208",
    • "href": "/objects/purchasing/txn-definition-additional-gl-detail/208"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a transaction definition additional GL account detail object
get/objects/purchasing/txn-definition-additional-gl-detail/{key}
Returns detailed information for a specified transaction definition additional GL account detail object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition additional GL account detail object.


 
 Example:  78
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "240",
    • "key": "240",
    • "purchasingTxnDefinition": {
      • "key": "91",
      • "id": "Purchase Order",
      • "href": "/objects/purchasing/txn-definition/91"
      },
    • "itemGLGroup": {
      • "key": "6",
      • "id": "Auto GL Group",
      • "href": "/objects/inventory-control/item-group/6"
      },
    • "warehouse": {
      • "id": "WH01",
      • "key": "6",
      • "href": "/objects/inventory-control/warehouse/6"
      },
    • "isOffset": false,
    • "txnType": "credit",
    • "moduleType": "inventory",
    • "glAccount": {
      • "id": "1003",
      • "key": "6",
      • "href": "/objects/general-ledger/account/6"
      },
    • "lineNumber": 1,
    • "href": "/objects/purchasing/txn-definition-additional-gl-detail/240"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a transaction definition additional GL account detail object
patch/objects/purchasing/txn-definition-additional-gl-detail/{key}
Updates an existing transaction definition additional GL account detail object by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition additional GL account detail object.


 
 Example:  78
Request Body schema: application/json
isOffset
boolean
 Default:  false
If set to true, the GL account is marked as offset.


 
 Example:  true
txnType
string
Indicate whether to debit or credit the corresponding GL account.


 Enum: "credit" "debit"  
 Example:  "debit"
lineNumber
integer  <= 8 characters 
Line number of the COGs GL detail on the transaction definition. If not provided, the system automatically assigns a unique line number. If you specify a lineNumber already used, the application sets other lines to unique numbers. The application uses this line number to post to the GL in the order provided.


 
 Example:  1
object
Set the GL account to which this transaction posts for the specified account mapping (itemGLGroup and warehouse).


 
key
string
Unique key for the GL account.


 
 Example:  "384"
id
string
Unique ID for the GL account.


 
 Example:  "1501.04"
object
Set the default location against which the line item will be recorded.


 
key
string
Unique key for the location.


 
 Example:  "56"
id
string
Unique ID for the location.


 
 Example:  "AZ"
object
Set the default department against which the line item will be recorded.


 
key
string
Unique key for the department.


 
 Example:  "29"
id
string
Unique ID for the department.


 
 Example:  "Sales"
object
The Item GL group and Warehouse together form the criteria set for the account mapping.


 
key
string
System-assigned key for the item GL group.


 
 Example:  "88"
id
string
Name of the item GL group.


 
 Example:  "Computers and parts"
object
The Item GL group and Warehouse together form the criteria set for the account mapping.


 
key
string
Unique key for the warehouse.


 
 Example:  "77"
id
string
Unique ID for the warehouse.


 
 Example:  "ARZ"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
Purchasing transaction definition associated with this additional GL account detail object.


 
key
string  <= 8 characters 
Unique key for the purchasing transaction definition.


 
 Example:  "77"
id
string  <= 30 characters 
Unique ID for the purchasing transaction definition.


 
 Example:  "Purchase Quote"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "glAccount": {
    • "id": "1400"
    },
  • "purchasingTxnDefinition": {
    • "key": "64"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "191",
    • "id": "191",
    • "href": "/objects/purchasing/txn-definition-additional-gl-detail/191"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction definition additional GL account detail object
delete/objects/purchasing/txn-definition-additional-gl-detail/{key}
Deletes a transaction definition additional GL account detail object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition additional GL account detail object.


 
 Example:  78
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query transaction definition additional GL details
post/services/core/query
Use the query service to find transaction definition additional GL details that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples