Transaction definition additional GL posting account details

Use this object for additional General Ledger entry account mapping. When additional posting is enabled for a transaction definition, additional GL posting account mapping is available for the posting configuration of that definition.

List additional GL posting account 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 posting account detail.

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 posting account detail object

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

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

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the transaction definition additional GL posting account details.

Example: 197
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/item-gl-group/6"
      },
    • "isOffset": false,
    • "txnType": "debit",
    • "moduleType": "additional",
    • "glAccount": {
      • "id": "1000",
      • "key": "3",
      • "href": "/objects/gl-account/3"
      },
    • "lineNumber": 1,
    • "href": "/objects/order-entry/txn-definition-additional-gl-detail/195"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update an additional GL posting account detail object

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

Updates an existing transaction definition additional GL posting 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 posting account details.

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

If true then the line is marked as offset.

Example: true
txnType
string

Debit or credit type.

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

Module type.

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

Line no.

Example: 1
object
key
string

System-assigned key for the account.

Example: "384"
id
string

User-assigned number for the account.

Example: "1501.04"
object
key
string

System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location.

Example: "3345"
id
string

Location.

Example: "Arizona"
object
key
string

Department key

Example: "28"
id
string

Department.

Example: "Sales"
object
key
string

System-assigned key for the item GL group.

Example: "13"
id
string

Name or other unique identifier for the item GL group.

Example: "Stockable Kit"
object
key
string

Default warehouse key.

Example: "23"
id
string

Unique identifier for the warehouse.

Example: "Warehouse-001"
object

Customer GL Group

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
{
  • "glAccount": {
    • "id": "1400"
    },
  • "order-entry-txn-definition": {
    • "key": "64"
    }
}
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 posting account detail object

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

Deletes an additional GL posting account detail object.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the transaction definition additional GL posting account details.

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