Transaction definition entity setting details

This object provides details about the entities that can create transactions, and also includes settings for each entity, such as numbering sequences and document templates. These details and settings are applicable to transaction definitions that are configured to create transactions at the Top level or entity or Entity only level.

List transaction definition entity setting details

get/objects/purchasing-txn-definition-entity-setting-detail

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "212",
      • "id": "212",
      • "href": "/objects/purchasing/txn-definition-entity-setting-detail/212"
      },
    • {
      • "key": "233",
      • "id": "233",
      • "href": "/objects/purchasing/txn-definition-entity-setting-detail/233"
      },
    • {
      • "key": "244",
      • "id": "244",
      • "href": "/objects/purchasing/txn-definition-entity-setting-detail/244"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a transaction definition entity setting detail object
post/objects/purchasing-txn-definition-entity-setting-detail
Creates a new transaction definition entity setting detail object.


SecurityOAuth2 
Request 
Request Body schema: application/json
enableNumberingSequence
boolean
 Default:  false
Set to true to enable sequence numbering.


 
 Example:  false
preserveNumberingSequence
boolean
 Default:  false
Set to true to preserve sequence numbering. Ensures that numbers are never skipped.


 
 Example:  false
canInheritSourceDocumentNumber
boolean
 Default:  false
Set to true to inherit source document number. For example, if you convert transfer out TO-001 into a transfer in, the number for the transfer in will be TO-001 if the transfer in is set to inherit the source transaction number.


 
 Example:  false
object
Provide the printed document template to use as the default for printed output (PDFs) for the corresponding entity. The template for the transaction definition document is used if a template is not specified in this field.


 
key
string  <= 8 characters 
Unique key for the template.


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


 
 Example:  "Purchasing transfer"
object
Specify the template to use to populate the transaction subtotals table.


 
key
string
Unique key for the subtotal template.


 
 Example:  "22"
id
string
Name of the subtotal template.


 
 Example:  "PS2 Subtotal template"
showExpandedTaxDetail
boolean
 Default:  false
Indicates whether to show expanded tax details in the user interface and in the printed output.
For example, you might have State, Territory, Local, and District taxes. If you want the transaction
printed output to show all taxes, set this field to true. 
If you want the printed output to have one
tax subtotal, set this field to false. 
This field is only applicable to companies that use
Avalara AvaTax or Advanced Tax and applies only if subtotals are enabled.


 
 Example:  false
enableOverrideTax
boolean
 Default:  false
Set to true to enable users to override whether an item is taxable. This field is only applicable if subtotals are enabled.


 
 Example:  false
enableLineLevelSimpleTax
boolean
 Default:  false
Set to true to allow the tax rate to be overridden at the line level when using Simple Tax. This field is only applicable if subtotals are enabled.


 
 Example:  false
object
Entity associated with the transaction definition.


 
id
required
string
Unique ID for the entity. The ID cannot be changed after the entity has been created.


 
 Example:  "Lyon"
key
string
Unique key for the entity.


 
 Example:  "48"
object
Specifies the numbering sequence to use to automatically number transactions for the corresponding entity.


 
key
string
Unique key for the document numbering sequence.


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


 
 Example:  "Adjustment Decrease"
object
Purchasing transaction definition


 
key
required
string  <= 8 characters 
Unique key for the purchasing transaction debitefinition.


 
 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": "96"
    },
  • "entity": {
    • "id": "Central Region"
    },
  • "enableNumberingSequence": false,
  • "documentSequence": {
    • "id": "6777_ACH_BatchNo"
    },
  • "preserveNumberingSequence": false,
  • "canInheritSourceDocumentNumber": false,
  • "enableCreateTransactionRule": true,
  • "showExpandedTaxDetail": false,
  • "enableOverrideTax": false,
  • "enableLineLevelSimpleTax": false
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "266",
    • "id": "266",
    • "href": "/objects/purchasing/txn-definition-entity-setting-detail/266"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a transaction definition entity setting detail object
get/objects/purchasing/txn-definition-entity-setting-detail/{key}
Returns detailed information for a specified transaction definition entity setting detail object.


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


 
 Example:  82
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "251",
    • "key": "251",
    • "purchasingTxnDefinition": {
      • "key": "96",
      • "id": "PO Receiver",
      • "href": "/objects/purchasing/txn-definition/96"
      },
    • "entity": {
      • "key": "4",
      • "id": "Central Region",
      • "href": "/objects/company-config/entity/4"
      },
    • "enableNumberingSequence": false,
    • "documentSequence": {
      • "key": "39",
      • "id": "6777_ACH_BatchNo",
      • "href": "/objects/company-config/document-sequence/39"
      },
    • "preserveNumberingSequence": false,
    • "canInheritSourceDocumentNumber": false,
    • "enableCreateTransactionRule": true,
    • "showExpandedTaxDetail": false,
    • "enableOverrideTax": false,
    • "enableLineLevelSimpleTax": false,
    • "href": "/objects/purchasing/txn-definition-entity-setting-detail/251"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a transaction definition entity setting detail object
patch/objects/purchasing/txn-definition-entity-setting-detail/{key}
Updates an existing transaction definition entity setting detail object. Any fields not provided remain unchanged.


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


 
 Example:  82
Request Body schema: application/json
enableNumberingSequence
boolean
 Default:  false
Set to true to enable sequence numbering.


 
 Example:  false
preserveNumberingSequence
boolean
 Default:  false
Set to true to preserve sequence numbering. Ensures that numbers are never skipped.


 
 Example:  false
canInheritSourceDocumentNumber
boolean
 Default:  false
Set to true to inherit source document number. For example, if you convert transfer out TO-001 into a transfer in, the number for the transfer in will be TO-001 if the transfer in is set to inherit the source transaction number.


 
 Example:  false
object
Provide the printed document template to use as the default for printed output (PDFs) for the corresponding entity. The template for the transaction definition document is used if a template is not specified in this field.


 
key
string  <= 8 characters 
Unique key for the template.


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


 
 Example:  "Purchasing transfer"
object
Specify the template to use to populate the transaction subtotals table.


 
key
string
Unique key for the subtotal template.


 
 Example:  "22"
id
string
Name of the subtotal template.


 
 Example:  "PS2 Subtotal template"
showExpandedTaxDetail
boolean
 Default:  false
Indicates whether to show expanded tax details in the user interface and in the printed output.
For example, you might have State, Territory, Local, and District taxes. If you want the transaction
printed output to show all taxes, set this field to true. 
If you want the printed output to have one
tax subtotal, set this field to false. 
This field is only applicable to companies that use
Avalara AvaTax or Advanced Tax and applies only if subtotals are enabled.


 
 Example:  false
enableOverrideTax
boolean
 Default:  false
Set to true to enable users to override whether an item is taxable. This field is only applicable if subtotals are enabled.


 
 Example:  false
enableLineLevelSimpleTax
boolean
 Default:  false
Set to true to allow the tax rate to be overridden at the line level when using Simple Tax. This field is only applicable if subtotals are enabled.


 
 Example:  false
object
Entity associated with the transaction definition.


 
key
string
Unique key for the entity.


 
 Example:  "48"
id
string
Unique ID for the entity. The ID cannot be changed after the entity has been created.


 
 Example:  "Lyon"
object
Specifies the numbering sequence to use to automatically number transactions for the corresponding entity.


 
key
string
Unique key for the document numbering sequence.


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


 
 Example:  "Adjustment Decrease"
object
Purchasing transaction definition


 
key
string  <= 8 characters 
Unique key for the purchasing transaction debitefinition.


 
 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
{
  • "purchasing-txn-definition": {
    • "key": "64"
    },
  • "enableLineLevelSimpleTax": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "174",
    • "id": "174",
    • "href": "/objects/purchasing/txn-definition-entity-setting-detail/174"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction definition entity setting detail object
delete/objects/purchasing/txn-definition-entity-setting-detail/{key}
Deletes a transaction definition entity setting detail object.


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


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