Transaction definition subtotal details

When enableSubtotals in the owning transaction definition is set to true, use this object to provide subtotal details for that transaction definition.

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

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



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
Specify the GL account to which the subtotal will post.


 
key
string
Unique key for the GL account.


 
 Example:  "5"
id
string
User-assigned number for the GL account.


 
 Example:  "1501.04"
required
object
Specify the offset GL account to which the subtotal will post.


 
key
string
Unique key for the GL account.


 
 Example:  "16"
id
string
Unique ID for the account.


 
 Example:  "1501.04"
subtotalType
required
string or null
 Default:  null
Specify the subtotal type.


 Enum: "charge" "discount" null  
 Example:  "discount"
valueType
required
string or null
 Default:  null
Specify the value type for the subtotal.


 Enum: "amount" null "percent"  
 Example:  "amount"
txnType
required
string or null
 Default:  null
Specify whether to debit or credit the account.


 Enum: "credit" "debit" null  
 Example:  "debit"
description
required
string
Description of the subtotal.


 
 Example:  "Discount"
lineNumber
integer  <= 8 characters 
Line number to which the subtotal applies.


 
 Example:  1
subtotalValue
string <decimal-precision-2>   <= 12 characters 
Provide a default value for the subtotal. If valueType is amount, provide the amount of the subtotal. For example, enter 250. If valueType is percent, specify a percentage as a whole number. For example, specify 10 for 10%. Users can override the default subtotal value in the transaction.


 
 Example:  "10"
isApportioned
boolean
 Default:  false
Set to true to distribute the discount subtotal proportionally across all line items in the transaction. Set this field to true if you are enabling MEA allocations in Order Entry. Leave this field false if you are enabling MEA allocations in Contracts.


 
 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 appliedToLineNumber is implicitly assumed to be 0. Taxes, all other charges, and discounts are computed at the line level. This fields does not apply if lineLevelSimpleTax is set to true in the owning transaction definition.


 
 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. Set this field to true for tax subtotal lines if your organization uses Simple Tax, Advanced Tax, or Avalara AvaTax.


 
 Example:  true
object
Specify a default department for the subtotal.


 
key
string
Unique key for the department.


 
 Example:  "19"
id
string
Name or other unique ID for the department.


 
 Example:  "Sales"
enableAvalaraTax
boolean
 Default:  false
Set to true if the subtotal line item applies to AvaTax. This field applies only if your company uses Avalara AvaTax integration.


 
 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.



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 subtotal detail object.


 
 Example:  113
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/general-ledger/account/3"
      },
    • "offsetGLAccount": {
      • "key": "160",
      • "id": "1000.01",
      • "href": "/objects/general-ledger/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.



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 subtotal detail object.


 
 Example:  113
Request Body schema: application/json
subtotalType
string or null
 Default:  null
Specify the subtotal type.


 Enum: "charge" "discount" null  
 Example:  "discount"
lineNumber
integer  <= 8 characters 
Line number to which the subtotal applies.


 
 Example:  1
description
string
Description of the subtotal.


 
 Example:  "Discount"
valueType
string or null
 Default:  null
Specify the value type for the subtotal.


 Enum: "amount" null "percent"  
 Example:  "amount"
subtotalValue
string <decimal-precision-2>   <= 12 characters 
Provide a default value for the subtotal. If valueType is amount, provide the amount of the subtotal. For example, enter 250. If valueType is percent, specify a percentage as a whole number. For example, specify 10 for 10%. Users can override the default subtotal value in the transaction.


 
 Example:  "10"
isApportioned
boolean
 Default:  false
Set to true to distribute the discount subtotal proportionally across all line items in the transaction. Set this field to true if you are enabling MEA allocations in Order Entry. Leave this field false if you are enabling MEA allocations in Contracts.


 
 Example:  true
object
Specify the GL account to which the subtotal will post.


 
key
string
Unique key for the GL account.


 
 Example:  "5"
id
string
User-assigned number for the GL account.


 
 Example:  "1501.04"
object
Specify the offset GL account to which the subtotal will post.


 
key
string
Unique key for the GL account.


 
 Example:  "16"
id
string
Unique ID for the account.


 
 Example:  "1501.04"
txnType
string or null
 Default:  null
Specify whether to debit or credit the account.


 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 appliedToLineNumber is implicitly assumed to be 0. Taxes, all other charges, and discounts are computed at the line level. This fields does not apply if lineLevelSimpleTax is set to true in the owning transaction definition.


 
 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. Set this field to true for tax subtotal lines if your organization uses Simple Tax, Advanced Tax, or Avalara AvaTax.


 
 Example:  true
object
Specify a default department for the subtotal.


 
key
string
Unique key for the department.


 
 Example:  "19"
id
string
Name or other unique ID for the department.


 
 Example:  "Sales"
enableAvalaraTax
boolean
 Default:  false
Set to true if the subtotal line item applies to AvaTax. This field applies only if your company uses Avalara AvaTax integration.


 
 Example:  true
Responses 
200
OK


400
Bad Request


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



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 subtotal detail object.


 
 Example:  113
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
Use the query service to find transaction definition subtotal 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
    }
}