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.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

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.


 
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.


 
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.


 
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
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "purchasing/txn-definition-entity-setting-detail"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 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 asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
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 
property name*
additional property
string
 Enum: "asc" "desc"  
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
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "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
    }
}