Transaction definition subtotal details

This object provides details about the type of subtotals that are supported by each order entry transaction definition.

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 subtotal detail objects

get/objects/order-entry/txn-definition-subtotal-detail

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "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
    }
}

Create a transaction definition subtotal detail object

post/objects/order-entry/txn-definition-subtotal-detail

Creates a new transaction definition subtotal detail object.

SecurityOAuth2
Request
Request Body schema: application/json
required
object

Select the GL account to which the subtotal will post.

key
string

System-assigned key for the general ledger account.

Example: "5"
id
string

User-assigned number for the GL account.

Example: "1501.04"
required
object

Select the offset GL account to which the subtotal will post

key
string

System-assigned key for the general ledger account.

Example: "5"
id
string

Unique ID for the account.

Example: "1501.04"
subtotalType
required
string or null
Default: null

Subtotal type.

Enum: "charge" "discount" null
Example: "discount"
valueType
required
string or null
Default: null

Value type.

Enum: "amount" null "percent"
Example: "amount"
txnType
required
string or null
Default: null

Transaction type - debit or credit.

Enum: "credit" "debit" null
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

key
string

Department key

Example: "28"
id
string

Department.

Example: "Sales"
enableAvalaraTax
boolean
Default: false

If set to true then the subtotal line item applies to AvaTax.

Example: true
Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "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
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "113",
    • "id": "113",
    • "href": "/objects/order-entry/txn-definition-subtotal-detail/113"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get a transaction definition subtotal detail object

get/objects/order-entry/txn-definition-subtotal-detail/{key}

Returns detailed information for a specified transaction definition subtotal detail object.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the transaction definition subtotal detail object.

Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "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
    }
}

Update a transaction definition subtotal detail object

patch/objects/order-entry/txn-definition-subtotal-detail/{key}

Updates an existing transaction definition subtotal detail object by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the transaction definition subtotal detail object.

Request Body schema: application/json
subtotalType
string or null
Default: null

Subtotal type.

Enum: "charge" "discount" null
Example: "discount"
lineNumber
integer <= 8 characters

Line number.

Example: 1
description
string

Description.

Example: "Discount"
valueType
string or null
Default: null

Value type.

Enum: "amount" null "percent"
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.

key
string

System-assigned key for the general ledger account.

Example: "5"
id
string

User-assigned number for the GL account.

Example: "1501.04"
object

Select the offset GL account to which the subtotal will post

key
string

System-assigned key for the general ledger account.

Example: "5"
id
string

Unique ID for the account.

Example: "1501.04"
txnType
string or null
Default: null

Transaction type - debit or credit.

Enum: "credit" "debit" null
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

key
string

Department key

Example: "28"
id
string

Department.

Example: "Sales"
enableAvalaraTax
boolean
Default: false

If set to true then the subtotal line item applies to AvaTax.

Example: true
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "order-entry-txn-definition": {
    • "key": "64"
    },
  • "subtotalType": "discount",
  • "txnType": "credit"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "94",
    • "id": "94",
    • "href": "/objects/order-entry/txn-definition-subtotal-detail/94"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete a transaction definition subtotal detail object

delete/objects/order-entry/txn-definition-subtotal-detail/{key}

Deletes a transaction definition subtotal detail object.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the transaction definition subtotal 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 subtotal 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-subtotal-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
    }
}