Transaction definition subtotal details

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

List transaction definition subtotal detail objects

get/objects/purchasing-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": "1",
      • "id": "1",
      • "href": "/objects/purchasing/txn-definition-subtotal-detail/1"
      },
    • {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/purchasing/txn-definition-subtotal-detail/13"
      },
    • {
      • "key": "147",
      • "id": "147",
      • "href": "/objects/purchasing/txn-definition-subtotal-detail/147"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a transaction definition subtotal detail object
post/objects/purchasing-txn-definition-subtotal-detail
Creates a new transaction definition subtotal detail object.


SecurityOAuth2 
Request 
Request Body schema: application/json
subtotalType
required
string or null
 Default:  null
Indicates whether the subtotal type is discount or charge.


 Enum: "charge" "discount" null  
 Example:  "discount"
valueType
required
string or null
 Default:  null
Value type for the subtotal. Options are amount or percent.


 Enum: "amount" null "percent"  
 Example:  "amount"
description
required
string  <= 100 characters 
Provide a text description of the subtotal. A unique description is required to create a transaction definition subtotal detail object.


 
 Example:  "Discount"
lineNumber
integer  <= 8 characters 
Line number for the subtotal on the transaction definition. If not provided, the system automatically assigns a unique line number. If you specify a lineNumber already used, the application sets other lines to unique numbers. The transaction definition uses the line numbers to display the order of subtotals.


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


 
 Example:  "10"
isApportioned
boolean
 Default:  false
If set to true, the subtotal will be apportioned across all line items in the transaction.


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


 
key
string
System-assigned key for the GL account.


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


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


 
key
string
System-assigned key for the GL ledger account.


 
 Example:  "6"
id
string
Unique ID for the GL account.


 
 Example:  "1501.04"
txnType
string or null
 Default:  null
Indicates the transaction type, which can be debit or credit.


 Enum: "credit" "debit" null  
 Example:  "credit"
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 field does not apply if enableLineLevelSimpleTax is set to true.


 
 Example:  1
isTax
boolean
 Default:  false
Set this field to true for tax subtotal lines if your organization uses Simple Tax, Advanced Tax, or Avalara AvaTax. When the transaction posts, the tax will post separately based on the items in the transaction.


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


 
key
string
Unique key for the department.


 
 Example:  "28"
id
string
Unique ID for the department.


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


 
 Example:  true
object
Purchasing transaction definition associated with this transaction definition subtotal detail.


 
key
required
string  <= 8 characters 
Unique key for the transaction definition.


 
 Example:  "77"
id
string  <= 30 characters 
Unique ID for the transaction definition.


 
 Example:  "Purchase Quote"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "purchasingTxnDefinition": {
    • "key": "96"
    },
  • "subtotalType": "discount",
  • "description": "discount",
  • "isApportioned": false,
  • "glAccount": {
    • "id": "1000"
    },
  • "offsetGLAccount": {
    • "id": "1000.01"
    },
  • "valueType": "percent",
  • "txnType": "debit",
  • "isTax": false
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "180",
    • "id": "180",
    • "href": "/objects/purchasing/txn-definition-subtotal-detail/180"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a transaction definition subtotal detail object
get/objects/purchasing/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:  158
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "180",
    • "key": "180",
    • "purchasingTxnDefinition": {
      • "key": "96",
      • "id": "Purchase Order",
      • "href": "/objects/purchasing/txn-definition/96"
      },
    • "subtotalType": "discount",
    • "lineNumber": 1,
    • "description": "discount",
    • "valueType": "percent",
    • "isApportioned": false,
    • "txnType": "debit",
    • "appliedToLineNumber": 0,
    • "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,
    • "href": "/objects/purchasing/txn-definition-subtotal-detail/180"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a transaction definition subtotal detail object
patch/objects/purchasing/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:  158
Request Body schema: application/json
subtotalType
string or null
 Default:  null
Indicates whether the subtotal type is discount or charge.


 Enum: "charge" "discount" null  
 Example:  "discount"
lineNumber
integer  <= 8 characters 
Line number for the subtotal on the transaction definition. If not provided, the system automatically assigns a unique line number. If you specify a lineNumber already used, the application sets other lines to unique numbers. The transaction definition uses the line numbers to display the order of subtotals.


 
 Example:  1
description
string  <= 100 characters 
Provide a text description of the subtotal. A unique description is required to create a transaction definition subtotal detail object.


 
 Example:  "Discount"
valueType
string or null
 Default:  null
Value type for the subtotal. Options are amount or percent.


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


 
 Example:  "10"
isApportioned
boolean
 Default:  false
If set to true, the subtotal will be apportioned across all line items in the transaction.


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


 
key
string
System-assigned key for the GL account.


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


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


 
key
string
System-assigned key for the GL ledger account.


 
 Example:  "6"
id
string
Unique ID for the GL account.


 
 Example:  "1501.04"
txnType
string or null
 Default:  null
Indicates the transaction type, which can be debit or credit.


 Enum: "credit" "debit" null  
 Example:  "credit"
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 field does not apply if enableLineLevelSimpleTax is set to true.


 
 Example:  1
isTax
boolean
 Default:  false
Set this field to true for tax subtotal lines if your organization uses Simple Tax, Advanced Tax, or Avalara AvaTax. When the transaction posts, the tax will post separately based on the items in the transaction.


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


 
key
string
Unique key for the department.


 
 Example:  "28"
id
string
Unique ID for the department.


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


 
 Example:  true
object
Purchasing transaction definition associated with this transaction definition subtotal detail.


 
key
string  <= 8 characters 
Unique key for the transaction definition.


 
 Example:  "77"
id
string  <= 30 characters 
Unique ID for the transaction definition.


 
 Example:  "Purchase Quote"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "purchasingTxnDefinition": {
    • "key": "96"
    },
  • "subtotalType": "discount",
  • "txnType": "credit"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "182",
    • "id": "182",
    • "href": "/objects/purchasing/txn-definition-subtotal-detail/182"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction definition subtotal detail object
delete/objects/purchasing/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:  158
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