Subtotal template lines

This object contains detailed information for Order Entry subtotal template lines.

List subtotal template lines

get/objects/order-entry/subtotal-template-line

Returns up to 100 object references from the collection with a key, ID, and link for each subtotal template details. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "4",
      • "id": "4",
      • "href": "/objects/order-entry/subtotal-template-line/4"
      },
    • {
      • "key": "5",
      • "id": "5",
      • "href": "/objects/order-entry/subtotal-template-line/5"
      },
    • {
      • "key": "6",
      • "id": "6",
      • "href": "/objects/order-entry/subtotal-template-line/6"
      },
    • {
      • "key": "7",
      • "id": "7",
      • "href": "/objects/order-entry/subtotal-template-line/7"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a subtotal template line
post/objects/order-entry/subtotal-template-line
Creates a new subtotal template line object.


SecurityOAuth2 
Request 
Request Body schema: application/json
description
required
string  <= 100 characters 
Description of the subtotal. Each subtotal description must be unique.


 
 Example:  "FreightCharge"
subtotalType
required
string
Indicates whether the subtotal is  a discount or charge.


 Enum: "charge" "discount"  
 Example:  "discount"
valueType
required
string
The subtotal can be either the amount type or the percent type.


 Enum: "amount" "percent"  
 Example:  "amount"
txnType
required
string or null
Indicates whether the subtotal will debit or credit the corresponding GL account and GL offset account.


 Enum: "credit" "debit" null  
 Example:  "debit"
lineNumber
integer  <= 8 characters 
Line number for the subtotal template line.


 
 Example:  1
defaultValue
string <decimal-precision-10>   <= 12 characters 
Default value for the subtotal. If valueType is amount, specify the amount of the subtotal. 
For example, enter 250. If valueType is percent, specify a percentage as a whole number. For example,  10 for 10%.
End Users can override the default subtotal value in the transaction. It can have up to 10 decimals and should be a positive numeric field


 
 Example:  "10.00"
isApportioned
boolean
 Default:  false
Indicates whether the discount subtotal will be apportioned across all line items in the transaction. Cannot be enabled if isTax is set to true.


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


 
 Example:  "6850.03"
id
required
string
Unique number for the account.


 
 Example:  "6850.03"
key
string
Unique key for the account.


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


 
 Example:  "1200"
id
required
string
Unique ID for the account.


 
 Example:  "1200"
key
string
Unique key for the account.


 
 Example:  "36"
applyToLineNumber
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.


 
 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 to true if the subtotal line is for tax.


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


 
 Example:  false
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "description": "FreightCharge",
  • "subtotalTemplate": {
    • "key": "3"
    },
  • "subtotalType": "discount",
  • "valueType": "amount",
  • "defaultValue": "10.00",
  • "isApportioned": false,
  • "glAccount": {
    • "id": "6850.03"
    },
  • "offsetGLAccount": {
    • "id": "1200"
    },
  • "txnType": "debit",
  • "applyToLineNumber": 0,
  • "isTax": false,
  • "isAvalaraTax": false
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "4",
    • "href": "/objects/order-entry/subtotal-template-line/4"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a subtotal template line
get/objects/order-entry/subtotal-template-line/{key}
Returns detailed information for a specified subtotal template line object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the subtotal template line.


 
 Example:  4
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "4",
    • "description": "FreightCharge",
    • "subtotalTemplate": {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/order-entry/subtotal-template/3"
      },
    • "subtotalType": "discount",
    • "lineNumber": 0,
    • "valueType": "amount",
    • "defaultValue": "10.00",
    • "isApportioned": false,
    • "glAccount": {
      • "key": "297",
      • "id": "6850.03",
      • "href": "/objects/general-ledger/account/297"
      },
    • "offsetGLAccount": {
      • "key": "36",
      • "id": "1200",
      • "href": "/objects/general-ledger/account/36"
      },
    • "txnType": "debit",
    • "applyToLineNumber": 0,
    • "isTax": false,
    • "isAvalaraTax": false,
    • "href": "/objects/order-entry/subtotal-template-line/4"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a subtotal template line
patch/objects/order-entry/subtotal-template-line/{key}
Updates an existing subtotal template line object by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the subtotal template line.


 
 Example:  4
Request Body schema: application/json
description
string  <= 100 characters 
Description of the subtotal. Each subtotal description must be unique.


 
 Example:  "FreightCharge"
subtotalType
string
Indicates whether the subtotal is  a discount or charge.


 Enum: "charge" "discount"  
 Example:  "discount"
lineNumber
integer  <= 8 characters 
Line number for the subtotal template line.


 
 Example:  1
valueType
string
The subtotal can be either the amount type or the percent type.


 Enum: "amount" "percent"  
 Example:  "amount"
defaultValue
string <decimal-precision-10>   <= 12 characters 
Default value for the subtotal. If valueType is amount, specify the amount of the subtotal. 
For example, enter 250. If valueType is percent, specify a percentage as a whole number. For example,  10 for 10%.
End Users can override the default subtotal value in the transaction. It can have up to 10 decimals and should be a positive numeric field


 
 Example:  "10.00"
isApportioned
boolean
 Default:  false
Indicates whether the discount subtotal will be apportioned across all line items in the transaction. Cannot be enabled if isTax is set to true.


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


 
key
string
Unique key for the account.


 
 Example:  "297"
id
string
Unique number for the account.


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


 
key
string
Unique key for the account.


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


 
 Example:  "1200"
txnType
string or null
Indicates whether the subtotal will debit or credit the corresponding GL account and GL offset account.


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


 
 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 to true if the subtotal line is for tax.


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


 
 Example:  false
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "subtotalType": "discount",
  • "defaultValue": "15.00"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "4",
    • "href": "/objects/order-entry/subtotal-template-line/4"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a subtotal template line
delete/objects/order-entry/subtotal-template-line/{key}
Deletes a subtotal template line object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the subtotal template line.


 
 Example:  4
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 subtotal template lines
post/services/core/query
Use the query service to find subtotal template lines that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples