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.

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


 
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.


 
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.


 
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:  "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:


    

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