Transaction definition account details

This object defines the account mapping for purchasing transactions that post to either Accounts Payable or the General Ledger. It provides the necessary details for managing the financial transactions associated with purchasing.

List transaction definition account details

get/objects/purchasing/txn-definition-ap-direct-gl-detail

Returns a collection with a key, ID, and link for each transaction definition Account Payable or direct GL account detail object.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "43",
      • "id": "43",
      • "href": "/objects/purchasing/txn-definition-ap-direct-gl-detail/43"
      },
    • {
      • "key": "44",
      • "id": "44",
      • "href": "/objects/purchasing/txn-definition-ap-direct-gl-detail/44"
      },
    • {
      • "key": "45",
      • "id": "45",
      • "href": "/objects/purchasing/txn-definition-ap-direct-gl-detail/45"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Create a transaction definition account detail object

post/objects/purchasing/txn-definition-ap-direct-gl-detail

Creates a new transaction definition Account Payable or direct GL account detail object.

SecurityOAuth2
Request
Request Body schema: application/json
txnType
required
string

Indicates whether to debit or credit the corresponding GL account.

Enum: "credit" "debit"
Example: "debit"
isOffset
boolean
Default: false

If set to true, the line is marked as offset.

Example: true
lineNumber
integer <= 8 characters

Line number of AP account detail on the transaction definition. If not provided, the system automatically assigns a unique line number. If you specify a lineNumber that is 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

The General Ledger account to which this transaction posts.

id
required
string

Unique ID for the account.

Example: "1501.04"
key
string

Unique key for the account.

Example: "384"
object

Location associated with the transaction definition account detail object.

key
string

Unique key for the location.

Example: "3345"
id
string

Unique ID for the location.

Example: "AZ"
object

Department associated with the transaction definition account detail object.

key
string

Unique key for the department.

Example: "28"
id
string

Unique ID for the department.

Example: "Sales"
object

Item GL group associated with the transaction definition account detail object.

key
string

Unique key for the item GL group.

Example: "13"
id
string

unique ID for the item GL group.

Example: "Stockable Kit"
object

Warehouse associated with the transaction definition account detail object.

key
string

Warehouse key.

Example: "23"
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 transaction definition 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": "2"
    },
  • "glAccount": {
    • "id": "44"
    },
  • "txnType": "credit",
  • "isOffset": true,
  • "lineNumber": 1
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "208",
    • "id": "208",
    • "href": "/objects/purchasing/txn-definition-ap-direct-gl-detail/208"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}

Get a transaction definition account detail object

get/objects/purchasing/txn-definition-ap-direct-gl-detail/{key}

Returns detailed information for a specified transaction definition Account Payable or direct GL account detail object.

SecurityOAuth2
Request
path Parameters
key
required
string

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

Example: 85
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "66",
    • "key": "66",
    • "purchasingTxnDefinition": {
      • "key": "2",
      • "id": "Vendor Invoice",
      • "href": "/objects/purchasing/txn-definition/2"
      },
    • "itemGLGroup": {
      • "key": "2",
      • "id": "OS GL Group",
      • "href": "/objects/inventory-control/item-group/2"
      },
    • "isOffset": true,
    • "txnType": "credit",
    • "moduleType": "subledger",
    • "glAccount": {
      • "id": "2000",
      • "key": "44",
      • "href": "/objects/general-ledger/account/44"
      },
    • "lineNumber": 3,
    • "href": "/objects/purchasing/txn-definition-ap-direct-gl-detail/66"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update a transaction definition account detail object

patch/objects/purchasing/txn-definition-ap-direct-gl-detail/{key}

Updates an existing transaction definition Account Payable or direct GL account detail object. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

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

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

If set to true, the line is marked as offset.

Example: true
txnType
string

Indicates whether to debit or credit the corresponding GL account.

Enum: "credit" "debit"
Example: "debit"
lineNumber
integer <= 8 characters

Line number of AP account detail on the transaction definition. If not provided, the system automatically assigns a unique line number. If you specify a lineNumber that is 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

The General Ledger account to which this transaction posts.

key
string

Unique key for the account.

Example: "384"
id
string

Unique ID for the account.

Example: "1501.04"
object

Location associated with the transaction definition account detail object.

key
string

Unique key for the location.

Example: "3345"
id
string

Unique ID for the location.

Example: "AZ"
object

Department associated with the transaction definition account detail object.

key
string

Unique key for the department.

Example: "28"
id
string

Unique ID for the department.

Example: "Sales"
object

Item GL group associated with the transaction definition account detail object.

key
string

Unique key for the item GL group.

Example: "13"
id
string

unique ID for the item GL group.

Example: "Stockable Kit"
object

Warehouse associated with the transaction definition account detail object.

key
string

Warehouse key.

Example: "23"
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 transaction definition 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": "193",
    • "id": "193",
    • "href": "/objects/purchasing-txn-definition-ap-direct-gl-detail/193"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete a transaction definition account detail object

delete/objects/purchasing/txn-definition-ap-direct-gl-detail/{key}

Delete a transaction definition Account Payable or direct GL account detail object.

SecurityOAuth2
Request
path Parameters
key
required
string

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

Example: 85
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 AP direct GL details

post/services/core/query

Use the query service to find transaction definition AP direct GL details that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

Request samples