Transaction definition entity details

The fields in this object are applicable if the owning transaction definition allows transactions to be created from the top level or entity (topLevelOrEntity) or entity level only (entityOnly). You can use this object to define different settings for each entity.

For more information, see Transaction definitions - Order Entry in the Sage Intacct Help Center.

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. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Add transaction definitions







SecurityOAuth2 
Request 
Request Body schema: application/json
required
object
 
key
string
Unique key for the entity.


 
 Example:  "41"
id
string
Unique ID for the entity. The ID cannot be changed after the entity has been created and the maximum number of characters for the ID is 20.


 
 Example:  "Lyon"
enableNumberingSequence
boolean
 Default:  false
Set to true to enable numbering sequences to be set for transactions.


 
 Example:  false
preserveNumberingSequence
boolean
 Default:  false
Set to true to ensure that numbers in a sequence are never skipped. Enabling this option can affect performance when a large volume of transactions is entered at the same time.


 
 Example:  false
canInheritSourceDocumentNumber
boolean
 Default:  false
Set to true if transactions should inherit source document numbers. For example, a transaction could inherit a sales invoice number.


 
 Example:  false
object
Specify a printed document template to use as the default for printed output (PDFs) for the corresponding entity. If you do not specify a value for this field, the Order Entry transaction definition document template is used.


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


 
 Example:  "65"
id
string  <= 100 characters 
The name or other ID for the document template.


 
 Example:  "Sales Order"
enableCreateTransactionRule
boolean
 Default:  false
The value for this field is set by Sage Intacct and is derived from the value specified for the multiEntityRuleForTransaction field in the owning transaction definition.


 
 Example:  false
object
If enableSubtotals is set to truein the owning transaction definition, you can specify the subtotal template to use to calculate subtotals.


 
key
string
Unique key for the subtotal template.


 
 Example:  "23"
id
string
Name or other ID for the subtotal template.


 
 Example:  "Subtotal template"
showExpandedTaxDetail
boolean
 Default:  false
Set to true to show expanded tax details in the transaction user interface and in printed output. This field applies only to companies that use Avalara AvaTax or Sage Intacct Advanced Tax.


 
 Example:  false
enableOverrideTax
boolean
 Default:  false
Indicates whether users can override whether a line item is taxable.


 
 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.


 
 Example:  false
object
Specify the document numbering sequence to use to automatically number transactions for the corresponding entity. Omit a numbering sequence here if you want to use the numbering sequence defined for the owning transaction definition, or if you want converted transactions to inherit the source document number.


 
key
string
Unique key for the document numbering sequence.


 
 Example:  "10"
id
string
ID of the document 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,
  • "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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, transaction definitions







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


 
 Example:  170
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/company-config/entity/3"
      },
    • "enableNumberingSequence": true,
    • "documentSequence": {
      • "key": "11",
      • "id": "AR Inv",
      • "href": "/objects/company-config/document-sequence/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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Edit transaction definitions







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


 
 Example:  170
Request Body schema: application/json
enableNumberingSequence
boolean
 Default:  false
Set to true to enable numbering sequences to be set for transactions.


 
 Example:  false
preserveNumberingSequence
boolean
 Default:  false
Set to true to ensure that numbers in a sequence are never skipped. Enabling this option can affect performance when a large volume of transactions is entered at the same time.


 
 Example:  false
canInheritSourceDocumentNumber
boolean
 Default:  false
Set to true if transactions should inherit source document numbers. For example, a transaction could inherit a sales invoice number.


 
 Example:  false
object
Specify a printed document template to use as the default for printed output (PDFs) for the corresponding entity. If you do not specify a value for this field, the Order Entry transaction definition document template is used.


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


 
 Example:  "65"
id
string  <= 100 characters 
The name or other ID for the document template.


 
 Example:  "Sales Order"
enableCreateTransactionRule
boolean
 Default:  false
The value for this field is set by Sage Intacct and is derived from the value specified for the multiEntityRuleForTransaction field in the owning transaction definition.


 
 Example:  false
object
If enableSubtotals is set to truein the owning transaction definition, you can specify the subtotal template to use to calculate subtotals.


 
key
string
Unique key for the subtotal template.


 
 Example:  "23"
id
string
Name or other ID for the subtotal template.


 
 Example:  "Subtotal template"
showExpandedTaxDetail
boolean
 Default:  false
Set to true to show expanded tax details in the transaction user interface and in printed output. This field applies only to companies that use Avalara AvaTax or Sage Intacct Advanced Tax.


 
 Example:  false
enableOverrideTax
boolean
 Default:  false
Indicates whether users can override whether a line item is taxable.


 
 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.


 
 Example:  false
object
 
key
string
Unique key for the entity.


 
 Example:  "41"
id
string
Unique ID for the entity. The ID cannot be changed after the entity has been created and the maximum number of characters for the ID is 20.


 
 Example:  "Lyon"
object
Specify the document numbering sequence to use to automatically number transactions for the corresponding entity. Omit a numbering sequence here if you want to use the numbering sequence defined for the owning transaction definition, or if you want converted transactions to inherit the source document number.


 
key
string
Unique key for the document numbering sequence.


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


 
 Example:  "Adjustment Decrease"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "showExpandedTaxDetail": true,
  • "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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Delete transaction definitions







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


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


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
    }
}