This object provides details about the type of subtotals that are supported by each order entry transaction definition.
Returns a collection with a key, ID, and link for each transaction definition subtotal detail object.
OK
Bad Request
{- "ia::result": [
- {
- "key": "15",
- "id": "15",
- "href": "/objects/order-entry/txn-definition-subtotal-detail/15"
}, - {
- "key": "19",
- "id": "19",
- "href": "/objects/order-entry/txn-definition-subtotal-detail/19"
}, - {
- "key": "3",
- "id": "3",
- "href": "/objects/order-entry/txn-definition-subtotal-detail/3"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new transaction definition subtotal detail object.
required | object Select the GL account to which the subtotal will post. | ||||
| |||||
required | object Select the offset GL account to which the subtotal will post | ||||
| |||||
subtotalType required | string or null Default: null Subtotal type. Example: "discount" | ||||
valueType required | string or null Default: null Value type. Example: "amount" | ||||
txnType required | string or null Default: null Transaction type - debit or credit. Example: "debit" | ||||
description required | string Description. Example: "Discount" | ||||
lineNumber | integer <= 8 characters Line number. Example: 1 | ||||
subtotalValue | string <decimal-precision-2> <= 12 characters Provide a default value for the subtotal. If Value type is Amount, enter the amount of the subtotal. For example, enter 250. If Value type is Percent, enter a percentage as a whole number. For example, enter 10 for 10%. Users can override the default subtotal value in the transaction. Example: "10.23" | ||||
isApportioned | boolean Default: false If true, then the discount subtotal will be apportioned across all line items in the transaction. Example: true | ||||
appliedToLineNumber | integer <= 8 characters Specify the subtotal line number to which the subtotal will apply. Sage Intacct treats the initial subtotal line as line number 0. The first defined subtotal from the transaction definition is line number 1, the second defined subtotal is line number 2, and so on. The value of Applied to line is implicitly assumed to be 0. Taxes, all other charges, and discounts are computed at the line level. This fields does not apply if is set to line-level Simple Tax. Example: 1 | ||||
isTax | boolean Default: false Flags the subtotal as a tax. When the transaction posts, the tax will post separately based on the items in the transaction. Example: true | ||||
object Select a default department for the subtotal | |||||
| |||||
enableAvalaraTax | boolean Default: false If set to true then the subtotal line item applies to AvaTax. Example: true |
Created
Bad Request
{- "order-entry-txn-definition": {
- "key": "64"
}, - "subtotalType": "discount",
- "description": "discount",
- "appliedToLineNumber": 1,
- "isApportioned": false,
- "glAccount": {
- "id": "1000"
}, - "offsetGLAccount": {
- "id": "1000.01"
}, - "valueType": "percent",
- "txnType": "debit",
- "isTax": false
}
{- "ia::result": {
- "key": "113",
- "id": "113",
- "href": "/objects/order-entry/txn-definition-subtotal-detail/113"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified transaction definition subtotal detail object.
key required | string System-assigned unique key for the transaction definition subtotal detail object. |
OK
Bad Request
{- "ia::result": {
- "key": "98",
- "id": "98",
- "order-entry-txn-definition": {
- "key": "64",
- "id": "Sales Order",
- "href": "/objects/order-entry-txn-definition/64"
}, - "subtotalType": "discount",
- "lineNumber": 0,
- "description": "Discount",
- "valueType": "amount",
- "isApportioned": false,
- "txnType": "debit",
- "appliedToLineNumber": 1,
- "isTax": false,
- "glAccount": {
- "key": "3",
- "id": "1000",
- "href": "/objects/gl-account/3"
}, - "offsetGLAccount": {
- "key": "160",
- "id": "1000.01",
- "href": "/objects/gl-account/160"
}, - "enableAvalaraTax": false
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing transaction definition subtotal detail object by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned unique key for the transaction definition subtotal detail object. |
subtotalType | string or null Default: null Subtotal type. Example: "discount" | ||||
lineNumber | integer <= 8 characters Line number. Example: 1 | ||||
description | string Description. Example: "Discount" | ||||
valueType | string or null Default: null Value type. Example: "amount" | ||||
subtotalValue | string <decimal-precision-2> <= 12 characters Provide a default value for the subtotal. If Value type is Amount, enter the amount of the subtotal. For example, enter 250. If Value type is Percent, enter a percentage as a whole number. For example, enter 10 for 10%. Users can override the default subtotal value in the transaction. Example: "10.23" | ||||
isApportioned | boolean Default: false If true, then the discount subtotal will be apportioned across all line items in the transaction. Example: true | ||||
object Select the GL account to which the subtotal will post. | |||||
| |||||
object Select the offset GL account to which the subtotal will post | |||||
| |||||
txnType | string or null Default: null Transaction type - debit or credit. Example: "debit" | ||||
appliedToLineNumber | integer <= 8 characters Specify the subtotal line number to which the subtotal will apply. Sage Intacct treats the initial subtotal line as line number 0. The first defined subtotal from the transaction definition is line number 1, the second defined subtotal is line number 2, and so on. The value of Applied to line is implicitly assumed to be 0. Taxes, all other charges, and discounts are computed at the line level. This fields does not apply if is set to line-level Simple Tax. Example: 1 | ||||
isTax | boolean Default: false Flags the subtotal as a tax. When the transaction posts, the tax will post separately based on the items in the transaction. Example: true | ||||
object Select a default department for the subtotal | |||||
| |||||
enableAvalaraTax | boolean Default: false If set to true then the subtotal line item applies to AvaTax. Example: true |
OK
Bad Request
{- "order-entry-txn-definition": {
- "key": "64"
}, - "subtotalType": "discount",
- "txnType": "credit"
}
{- "ia::result": {
- "key": "94",
- "id": "94",
- "href": "/objects/order-entry/txn-definition-subtotal-detail/94"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a transaction definition subtotal detail object.
key required | string System-assigned unique key for the transaction definition subtotal detail object. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "order-entry/txn-definition-subtotal-detail" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
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 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "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
}
}