Transaction definition additional GL details

Use this object for additional General Ledger account mapping. When additional GL posting is enabled for the owning transaction definition, the postToGL field is set to true, additional GL posting account mapping is available.

The item GL group and warehouse together form the criteria set for the account mapping. For more information, see Transaction definitions - Order Entry in the Sage Intacct Help Center.

List additional GL detail objects

get/objects/order-entry/txn-definition-additional-gl-detail

Returns a collection with a key, ID, and link for each transaction definition additional GL detail object. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "195",
      • "id": "195",
      • "href": "/objects/order-entry/txn-definition-additional-gl-detail/195"
      },
    • {
      • "key": "196",
      • "id": "196",
      • "href": "/objects/order-entry/txn-definition-additional-gl-detail/196"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get an additional GL detail object

get/objects/order-entry/txn-definition-additional-gl-detail/{key}

Returns detailed information for a specified transaction definition additional GL detail object.

Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the transaction definition additional GL detail object.

Example: 196
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "195",
    • "id": "195",
    • "order-entry-txn-definition": {
      • "key": "64",
      • "id": "Sales Order",
      • "href": "/objects/order-entry/txn-definition/64"
      },
    • "itemGLGroup": {
      • "key": "6",
      • "id": "Auto GL Group",
      • "href": "/objects/inventory-control/item-gl-group/6"
      },
    • "isOffset": false,
    • "txnType": "debit",
    • "moduleType": "additional",
    • "glAccount": {
      • "id": "1000",
      • "key": "3",
      • "href": "/objects/general-ledger/account/3"
      },
    • "lineNumber": 10,
    • "href": "/objects/order-entry/txn-definition-additional-gl-detail/195"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update an additional GL detail object

patch/objects/order-entry/txn-definition-additional-gl-detail/{key}

Updates an existing transaction definition additional GL detail object by setting field values. Any fields not provided remain unchanged.

Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit transaction definitions
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the transaction definition additional GL detail object.

Example: 196
Request Body schema: application/json
isOffset
boolean
Default: false

Set to true if the GL account specified in the glAccount field is an offset account. Each itemGLGroup and warehouse set must have one offset account.

Example: true
txnType
string

Specify whether to debit or credit the account.

Enum: "credit" "debit"
Example: "debit"
moduleType
string

Module type.

Value: "additional"
Example: "additional"
lineNumber
integer <= 8 characters

Line number of the transaction.

Example: 1
object

The GL account to which the transaction posts for the mapped criteria set.

key
string

Unique key for the GL account.

Example: "384"
id
string

User-assigned ID for the account.

Example: "1501.04"
object

Location associated with the transaction definition.

key
string

Unique key for the location.

Example: "3345"
id
string

Unique ID for the location.

Example: "Arizona"
object

Department associated with the transaction definition.

key
string

Unique key for the department.

Example: "28"
id
string

Unique ID for the department.

Example: "Sales"
object

The itemGLgroup and warehouse together form the criteria set for the account mapping.

key
string

Unique key for the item GL group.

Example: "13"
id
string

Name or other unique ID for the item GL group.

Example: "Stockable Kit"
object

The itemGLgroup and warehouse together form the criteria set for the account mapping.

key
string

Unique key for the warehouse.

Example: "23"
id
string

Unique ID for the warehouse.

Example: "Warehouse-001"
object

Customer GL groups are categories of customers grouped together so that transactions can be posted to specific GL accounts.

id
string

Customer GL group name.

Example: "Group 1"
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"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "isOffset": true
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "195",
    • "id": "195",
    • "href": "/objects/order-entry/txn-definition-additional-gl-detail/195"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete an additional GL detail object

delete/objects/order-entry/txn-definition-additional-gl-detail/{key}

Deletes an additional GL detail object.

Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete transaction definitions
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the transaction definition additional GL detail object.

Example: 196
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

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
    }
}