Specify which entities can create transactions. Also use this object to define different settings for each desired entity; numbering sequences, document templates, and so on.
Returns a collection with a key, ID, and link for each transaction definition entity detail object.
OK
Bad Request
{- "ia::result": [
- {
- "key": "160",
- "id": "160",
- "href": "/objects/order-entry/txn-definition-entity-setting-detail/160"
}, - {
- "key": "161",
- "id": "161",
- "href": "/objects/order-entry/txn-definition-entity-setting-detail/161"
}, - {
- "key": "162",
- "id": "162",
- "href": "/objects/order-entry/txn-definition-entity-setting-detail/162"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new transaction definition entity detail object.
required | object | ||||
| |||||
enableNumberingSequence | boolean Default: false If true then enable sequence numbering. Example: false | ||||
preserveNumberingSequence | boolean Default: false If true then preserve sequence numbering. Example: false | ||||
canInheritSourceDocumentNumber | boolean Default: false Inherit source document number. Example: false | ||||
object Provide printed document template to use as the default for printed output (PDFs) for the corresponding entity. Order entry transaction definition document template is used if you not provide this field. | |||||
| |||||
enableCreateTransactionRule | boolean Default: false Create transactions in. Example: false | ||||
object Specifies the template for populating the transaction subtotals table. | |||||
| |||||
showExpandedTaxDetail | boolean Default: false Show expanded tax details. Example: false | ||||
enableOverrideTax | boolean Default: false Line-item tax. Example: false | ||||
enableLineLevelSimpleTax | boolean Default: false Enable line-level Simple Tax. Example: false | ||||
object | |||||
|
Created
Bad Request
{- "order-entry-txn-definition": {
- "key": "50"
}, - "entity": {
- "id": "Mountain Region"
}, - "enableNumberingSequence": false,
- "documentSequence": {
- "id": "AR Inv"
}, - "preserveNumberingSequence": true,
- "canInheritSourceDocumentNumber": true,
- "enableCreateTransactionRule": true,
- "showExpandedTaxDetail": false,
- "enableOverrideTax": true,
- "enableLineLevelSimpleTax": false
}
{- "ia::result": {
- "key": "170",
- "id": "170",
- "href": "/objects/order-entry/txn-definition-entity-setting-detail/170"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified transaction definition entity detail object.
key required | string System-assigned unique key for the transaction definition entity detail object. |
OK
Bad Request
{- "ia::result": {
- "key": "162",
- "id": "162",
- "order-entry-txn-definition": {
- "key": "50",
- "id": "Sales Return",
- "href": "/objects/order-entry-txn-definition/50"
}, - "entity": {
- "key": "3",
- "id": "Mountain Region",
- "href": "/objects/entity/3"
}, - "enableNumberingSequence": false,
- "documentSequence": {
- "key": "11",
- "id": "AR Inv",
- "href": "/objects/document-sequence-number/11"
}, - "preserveNumberingSequence": true,
- "canInheritSourceDocumentNumber": true,
- "enableCreateTransactionRule": true,
- "showExpandedTaxDetail": false,
- "enableOverrideTax": true,
- "enableLineLevelSimpleTax": false,
- "href": "/objects/order-entry/txn-definition-entity-setting-detail/162"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing transaction definition entity detail object. Any fields not provided remain unchanged.
key required | string System-assigned unique key for the transaction definition entity detail object. |
enableNumberingSequence | boolean Default: false If true then enable sequence numbering. Example: false | ||||
preserveNumberingSequence | boolean Default: false If true then preserve sequence numbering. Example: false | ||||
canInheritSourceDocumentNumber | boolean Default: false Inherit source document number. Example: false | ||||
object Provide printed document template to use as the default for printed output (PDFs) for the corresponding entity. Order entry transaction definition document template is used if you not provide this field. | |||||
| |||||
enableCreateTransactionRule | boolean Default: false Create transactions in. Example: false | ||||
object Specifies the template for populating the transaction subtotals table. | |||||
| |||||
showExpandedTaxDetail | boolean Default: false Show expanded tax details. Example: false | ||||
enableOverrideTax | boolean Default: false Line-item tax. Example: false | ||||
enableLineLevelSimpleTax | boolean Default: false Enable line-level Simple Tax. Example: false | ||||
object | |||||
| |||||
object | |||||
|
OK
Bad Request
{- "order-entry-txn-definition": {
- "key": "64"
}, - "enableLineLevelSimpleTax": true
}
{- "ia::result": {
- "key": "174",
- "id": "174",
- "href": "/objects/order-entry/txn-definition-entity-setting-detail/174"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a transaction definition entity detail object.
key required | string System-assigned unique key for the transaction definition entity detail object. |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "order-entry/txn-definition-entity-setting-detail" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}