Subtotal templates

In a multi-entity organization, subtotal templates enable you to create different sets of subtotals and then refer to them by name within a transaction definition. They simplify setting up and managing transactions definitions.

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 subtotal templates

get/objects/order-entry/subtotal-template

Returns a collection with a key, ID, and link for each order entry subtotal template.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "UK VAT",
      • "href": "/objects/order-entry/subtotal-template/1"
      },
    • {
      • "key": "2",
      • "id": "InvoiceTax",
      • "href": "/objects/order-entry/subtotal-template/2"
      },
    • {
      • "key": "3",
      • "id": "SalesInvoiceCharges",
      • "href": "/objects/order-entry/subtotal-template/3"
      },
    • {
      • "key": "4",
      • "id": "Avalara",
      • "href": "/objects/order-entry/subtotal-template/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a subtotal template
post/objects/order-entry/subtotal-template
Creates a new order entry subtotal template.


SecurityOAuth2 
Request 
Request Body schema: application/json
id
required
string  <= 100 characters 
The name of the order entry subtotal template.


 
 Example:  "SalesInvoiceCharges"
Array of objects
Details of the order entry subtotal template.


 
 Array 
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.


 
object
Specify the offset GL account to which the subtotal will post.


 
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
{
  • "id": "SalesInvoiceCharges",
  • "lines": [
    • {
      • "description": "FreightCharge",
      • "subtotalType": "discount",
      • "lineNumber": 0,
      • "valueType": "amount",
      • "defaultValue": "10.00",
      • "glAccount": {
        },
      • "offsetGLAccount": {
        },
      • "txnType": "debit"
      },
    • {
      • "description": "Discount",
      • "subtotalType": "discount",
      • "lineNumber": 1,
      • "valueType": "percent",
      • "defaultValue": "5",
      • "isApportioned": false,
      • "glAccount": {
        },
      • "offsetGLAccount": {
        },
      • "txnType": "debit"
      },
    • {
      • "description": "CASTax",
      • "subtotalType": "charge",
      • "lineNumber": 2,
      • "valueType": "percent",
      • "defaultValue": "6",
      • "isApportioned": false,
      • "glAccount": {
        },
      • "offsetGLAccount": {
        },
      • "txnType": "debit"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "SalesInvoiceCharges",
    • "href": "/objects/order-entry/subtotal-template/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a subtotal template
get/objects/order-entry/subtotal-template/{key}
Returns detailed information for a specified order entry subtotal template.


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


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "SalesInvoiceCharges",
    • "moduleKey": "8.SO",
    • "lines": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "audit": {
      • "createdDateTime": "2024-05-15T16:46:11Z",
      • "modifiedDateTime": "2024-05-15T16:46:11Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/order-entry/subtotal-template/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a subtotal template
patch/objects/order-entry/subtotal-template/{key}
Updates an existing order entry subtotal template by setting field values. Any fields not provided remain unchanged.


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


 
Request Body schema: application/json
Array of objects
Details of the order entry subtotal template.


 
 Array 
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.


 
object
Specify the offset GL account to which the subtotal will post.


 
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
{
  • "lines": [
    • {
      • "key": "4",
      • "glAccount": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "SalesInvoiceCharges",
    • "href": "/objects/order-entry/subtotal-template/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a subtotal template
delete/objects/order-entry/subtotal-template/{key}
Deletes an order entry subtotal template.


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


 
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 templates
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/subtotal-template"
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
    }
}