Transaction definition account details

If an order entry transaction is posting to either Accounts Receivable or the General Ledger, the applicable account mapping is defined using this object.

List transaction definition account detail objects

get/objects/order-entry/txn-definition-ar-direct-gl-detail

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "98",
      • "id": "98",
      • "href": "/objects/order-entry/txn-definition-ar-direct-gl-detail/98"
      },
    • {
      • "key": "163",
      • "id": "163",
      • "href": "/objects/order-entry/txn-definition-ar-direct-gl-detail/163"
      },
    • {
      • "key": "164",
      • "id": "164",
      • "href": "/objects/order-entry/txn-definition-ar-direct-gl-detail/164"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a transaction definition account detail object
get/objects/order-entry/txn-definition-ar-direct-gl-detail/{key}
Returns detailed information for a specified transaction definition Account Receivable 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:  127
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "167",
    • "id": "167",
    • "order-entry-txn-definition": {
      • "key": "43",
      • "id": "Sales Invoice",
      • "href": "/objects/order-entry-txn-definition/43"
      },
    • "itemGLGroup": {
      • "key": "2",
      • "id": "OS GL Group",
      • "href": "/objects/item-gl-group/2"
      },
    • "isOffset": false,
    • "txnType": "credit",
    • "moduleType": "subledger",
    • "glAccount": {
      • "id": "4030",
      • "key": "69",
      • "href": "/objects/gl-account/69"
      },
    • "lineNumber": 1,
    • "href": "/objects/order-entry/txn-definition-ar-direct-gl-detail/167"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a transaction definition account detail object
patch/objects/order-entry/txn-definition-ar-direct-gl-detail/{key}
Updates an existing transaction definition Account Receivable or direct 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 account detail object.


 
 Example:  127
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.


 Enum: "additional" "inventory" "subledger"  
 Example:  "subledger"
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": "193",
    • "id": "193",
    • "href": "/objects/order-entry/txn-definition-ar-direct-gl-detail/193"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction definition account detail object
delete/objects/order-entry/txn-definition-ar-direct-gl-detail/{key}
Delete a transaction definition Account Receivable 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:  127
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 AR direct GL details
post/services/core/query
Use the query service to find transaction definition AR direct GL details that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples