Transaction definition subtotal details

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

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.


 
 Example:  112
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.


 
 Example:  112
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.


 
 Example:  112
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


Request samples