Transaction definition entity details

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.

List transaction definition entity detail objects

get/objects/order-entry/txn-definition-entity-setting-detail

Returns a collection with a key, ID, and link for each transaction definition entity detail object.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create a transaction definition entity detail object
post/objects/order-entry/txn-definition-entity-setting-detail
Creates a new transaction definition entity detail object.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
object
 
key
string
System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity.


 
 Example:  "23"
id
string
Unique identifier of the entity. 20 characters max. The ID cannot be changed after the entity has been created.


 
 Example:  "Lyon"
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.


 
key
string  <= 8 characters 
The system generated key document template.


 
 Example:  "65"
id
string  <= 100 characters 
The name of document template.


 
 Example:  "Sales Order"
enableCreateTransactionRule
boolean
 Default:  false
Create transactions in.


 
 Example:  false
object
Specifies the template for populating the transaction subtotals table.


 
key
string
Subtotal template.


 
 Example:  "22"
id
string
Name of a order entry subtotal template.


 
 Example:  "Subtotal template"
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
 
key
string
Document sequence Key


 
 Example:  "23"
id
string
The ID of the numbering sequence.


 
 Example:  "Adjustment Decrease"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "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
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "170",
    • "id": "170",
    • "href": "/objects/order-entry/txn-definition-entity-setting-detail/170"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a transaction definition entity detail object
get/objects/order-entry/txn-definition-entity-setting-detail/{key}
Returns detailed information for a specified transaction definition entity detail object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition entity detail object.


 
 Example:  133
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "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
    }
}
Update a transaction definition entity detail object
patch/objects/order-entry/txn-definition-entity-setting-detail/{key}
Updates an existing transaction definition entity detail object. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition entity detail object.


 
 Example:  133
Request Body schema: application/json
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.


 
key
string  <= 8 characters 
The system generated key document template.


 
 Example:  "65"
id
string  <= 100 characters 
The name of document template.


 
 Example:  "Sales Order"
enableCreateTransactionRule
boolean
 Default:  false
Create transactions in.


 
 Example:  false
object
Specifies the template for populating the transaction subtotals table.


 
key
string
Subtotal template.


 
 Example:  "22"
id
string
Name of a order entry subtotal template.


 
 Example:  "Subtotal template"
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
 
key
string
System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity.


 
 Example:  "23"
id
string
Unique identifier of the entity. 20 characters max. The ID cannot be changed after the entity has been created.


 
 Example:  "Lyon"
object
 
key
string
Document sequence Key


 
 Example:  "23"
id
string
The ID of the numbering sequence.


 
 Example:  "Adjustment Decrease"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "order-entry-txn-definition": {
    • "key": "64"
    },
  • "enableLineLevelSimpleTax": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "174",
    • "id": "174",
    • "href": "/objects/order-entry/txn-definition-entity-setting-detail/174"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction definition entity detail object
delete/objects/order-entry/txn-definition-entity-setting-detail/{key}
Deletes a transaction definition entity detail object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition entity detail object.


 
 Example:  133
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 entity setting details
post/services/core/query
Use the query service to find transaction definition entity setting details that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples