Order Entry tax details

Order Entry tax details describe a specific type of tax that applies to lines in Accounts Receivable and Order Entry transactions. When Sage Intacct calculates taxes, the tax schedule map applies the tax details to the taxable lines. See Tax details—Taxes application for more information.

List Order Entry tax details

get/objects/tax/order-entry-tax-detail

Returns a collection with a key, ID, and link for each Order Entry tax detail. 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
SubscriptionAccounts Receivable, Order Entry
User typeBusiness
PermissionsList, View Tax Detail
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "82",
      • "id": "UK Sale Goods Exempt Rate",
      • "href": "/objects/tax/order-entry-tax-detail/82"
      },
    • {
      • "key": "83",
      • "id": "UK Sale Goods Reduced Rate",
      • "href": "/objects/tax/order-entry-tax-detail/83"
      },
    • {
      • "key": "84",
      • "id": "UK Sale Goods Standard Rate",
      • "href": "/objects/tax/order-entry-tax-detail/84"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an Order Entry tax detail
post/objects/tax/order-entry-tax-detail
Creates a new Order Entry tax detail.



Permissions and other requirements



SubscriptionAccounts Receivable, Order Entry


User typeBusiness


PermissionsList, View, Add Tax Detail







SecurityOAuth2 
Request 
Request Body schema: application/json
id
required
string
Unique identifier for the Order Entry tax detail.


 
 Example:  "State Tax Texas"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
taxUniqueId
string
A valid identifier for Australia GST, South Africa VAT, or United Kingdom VAT compliance. Valid identifiers are predetermined by internal Sage requirements.


 
 Example:  "GB.ECOutput_GB.ExemptGB.VAT"
taxRate
string or null
The category for the tax detail.


 Enum: "exempt" "federal" null "provincial" "reduced" "standard" "zero"  
 Example:  "exempt"
amountToTax
string or null
Amount to include in taxable amount:


    

  • fullAmount - Include the cost from zero up to the maximum taxable amount.
    • 

  • amountWithinRange - Include the amount between the minimum and maximum taxable amount.
    • 



 Enum: "amountWithinRange" "fullAmount" null  
 Example:  "fullAmount"
description
string
The description of the Order Entry tax detail, which appears in the transaction subtotals if configured.


 
 Example:  "Standard Rate for AU Import Services"
taxPercent
number
The tax rate. For example, enter 10 to apply a tax of 10%.


 
 Example:  10
object
 
minTaxable
number
Minimum taxable amount. If the amount of a line item is at or below this value, tax is not applied.


 
 Example:  10
maxTaxable
number
Maximum taxable amount. Tax is applied to line item amounts up to this value, but not over.


 
 Example:  2000
minTax
number
The least amount of tax that will be applied. If the calculated tax is below this amount, this amount is applied.


 
 Example:  10
maxTax
number
The most amount of tax that will be applied. If the calculated tax exceeds this amount, this amount is applied.


 
 Example:  150
reverseCharge
boolean
 Default:  false
Indicates if the tax detail is used to reclaim tax for a reverse-charge transaction. This field is most commonly used for VAT or GST tax solutions.


 
 Example:  true
useExpenseAccount
boolean
 Default:  false
Set to true to override the GL account and assign taxes to the expense account.


 
 Example:  true
object
AR account label.


 
id
string
Unique ID for the account label.


 
 Example:  "Accounting Fees"
key
string
System-generated key for the account label.


 
 Example:  "14"
object
The tax authority for whom you are collecting taxes (such as the City of San Jose).


 
id
string
Unique identifier for the tax authority.


 
 Example:  "California"
key
string
System-assigned key for the tax authority.


 
 Example:  "24"
object
The general ledger account to which this tax is to be assigned.


 
id
string
Unique identifier for the GL account.


 
 Example:  "00.01--Accounts Receivable - a/c label offset"
key
string
System-assigned key for the GL account.


 
 Example:  "57"
object
Tax solution to which this tax detail belongs.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "1"
id
string
Unique identifier for the tax solution.


 
 Example:  "United Kingdom - VAT"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "UK General Export Reduced Rate",
  • "taxUniqueId": "GB.ECOutput_GB.ExemptGB.VAT",
  • "description": "Reduced Rate for UK General Export",
  • "taxPercent": 10.02,
  • "taxLimit": {
    • "minTax": 10,
    • "maxTax": 150,
    • "minTaxable": 10,
    • "maxTaxable": 2000
    },
  • "amountToTax": "fullAmount",
  • "salesGLAccount": {
    • "id": "1200.01"
    },
  • "taxAuthority": {
    • "id": "California"
    },
  • "taxSolution": {
    • "id": "United Kingdom - VAT"
    },
  • "status": "active",
  • "taxRate": "standard",
  • "useExpenseAccount": false
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "308",
    • "id": "UK General Export Reduced Rate",
    • "href": "/objects/tax/order-entry-tax-detail/308"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an Order Entry tax detail
get/objects/tax/order-entry-tax-detail/{key}
Returns detailed information for a specified Order Entry tax detail.



Permissions and other requirements



SubscriptionAccounts Receivable, Order Entry


User typeBusiness


PermissionsList, View Tax Detail







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the Order Entry tax detail.


 
 Example:  308
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "308",
    • "id": "UK General Export Reduced Rate",
    • "taxUniqueId": "GB.ECOutput_GB.ExemptGB.VAT",
    • "description": "Reduced Rate for UK General Export",
    • "taxPercent": 10.02,
    • "taxLimit": {
      • "minTax": 10,
      • "maxTax": 150,
      • "minTaxable": 10,
      • "maxTaxable": 2000
      },
    • "amountToTax": "fullAmount",
    • "salesGLAccount": {
      • "id": "1200.01--Accounts Receivable - a/c label offset"
      },
    • "accountLabel": {
      • "id": "Accounting Fees",
      • "key": "14"
      },
    • "taxAuthority": {
      • "id": "California",
      • "key": "24",
      • "href": "/objects/tax/tax-authority/24"
      },
    • "status": "active",
    • "isSystemGenerated": false,
    • "reverseCharge": false,
    • "taxRate": "standard",
    • "taxSolution": {
      • "id": "United Kingdom - VAT",
      • "key": "1",
      • "href": "/objects/tax/tax-solution/1"
      },
    • "useExpenseAccount": false,
    • "href": "/objects/tax/order-entry-tax-detail/308"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update an Order Entry tax detail
patch/objects/tax/order-entry-tax-detail/{key}
Updates an existing Order Entry tax detail by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionAccounts Receivable, Order Entry


User typeBusiness


PermissionsList, View, Edit Tax Detail







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the Order Entry tax detail.


 
 Example:  308
Request Body schema: application/json
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
taxUniqueId
string
A valid identifier for Australia GST, South Africa VAT, or United Kingdom VAT compliance. Valid identifiers are predetermined by internal Sage requirements.


 
 Example:  "GB.ECOutput_GB.ExemptGB.VAT"
taxRate
string or null
The category for the tax detail.


 Enum: "exempt" "federal" null "provincial" "reduced" "standard" "zero"  
 Example:  "exempt"
amountToTax
string or null
Amount to include in taxable amount:


    

  • fullAmount - Include the cost from zero up to the maximum taxable amount.
    • 

  • amountWithinRange - Include the amount between the minimum and maximum taxable amount.
    • 



 Enum: "amountWithinRange" "fullAmount" null  
 Example:  "fullAmount"
description
string
The description of the Order Entry tax detail, which appears in the transaction subtotals if configured.


 
 Example:  "Standard Rate for AU Import Services"
taxPercent
number
The tax rate. For example, enter 10 to apply a tax of 10%.


 
 Example:  10
object
 
minTaxable
number
Minimum taxable amount. If the amount of a line item is at or below this value, tax is not applied.


 
 Example:  10
maxTaxable
number
Maximum taxable amount. Tax is applied to line item amounts up to this value, but not over.


 
 Example:  2000
minTax
number
The least amount of tax that will be applied. If the calculated tax is below this amount, this amount is applied.


 
 Example:  10
maxTax
number
The most amount of tax that will be applied. If the calculated tax exceeds this amount, this amount is applied.


 
 Example:  150
reverseCharge
boolean
 Default:  false
Indicates if the tax detail is used to reclaim tax for a reverse-charge transaction. This field is most commonly used for VAT or GST tax solutions.


 
 Example:  true
useExpenseAccount
boolean
 Default:  false
Set to true to override the GL account and assign taxes to the expense account.


 
 Example:  true
object
AR account label.


 
id
string
Unique ID for the account label.


 
 Example:  "Accounting Fees"
key
string
System-generated key for the account label.


 
 Example:  "14"
object
The tax authority for whom you are collecting taxes (such as the City of San Jose).


 
id
string
Unique identifier for the tax authority.


 
 Example:  "California"
key
string
System-assigned key for the tax authority.


 
 Example:  "24"
object
The general ledger account to which this tax is to be assigned.


 
id
string
Unique identifier for the GL account.


 
 Example:  "00.01--Accounts Receivable - a/c label offset"
key
string
System-assigned key for the GL account.


 
 Example:  "57"
object
Tax solution to which this tax detail belongs.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "1"
id
string
Unique identifier for the tax solution.


 
 Example:  "United Kingdom - VAT"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "inactive"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "308",
    • "id": "UK General Export Reduced Rate",
    • "href": "/objects/tax/order-entry-tax-detail/308"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an Order Entry tax detail
delete/objects/tax/order-entry-tax-detail/{key}
Deletes an Order Entry tax detail. Deleted tax details are removed from the system and can't be recovered.



Permissions and other requirements



SubscriptionAccounts Receivable, Order Entry


User typeBusiness


PermissionsList, View, Delete Tax Detail







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the Order Entry tax detail.


 
 Example:  308
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 order entry tax details
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:  "tax/order-entry-tax-detail"
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": "tax/order-entry-tax-detail",
  • "fields": [
    • "key",
    • "id",
    • "href",
    • "taxUniqueId"
    ],
  • "filters": [
    • {
      • "$gte": {
        }
      }
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "39",
      • "id": "Other Input Tax Adjustments",
      • "href": "/objects/tax/order-entry-tax-detail/39",
      • "taxUniqueId": "ZA.OTAInput_ZAR.AdjustmentZAR.VAT"
      },
    • {
      • "key": "251",
      • "id": "UK General Export Services Standard Rate Input",
      • "href": "/objects/tax/order-entry-tax-detail/251",
      • "taxUniqueId": "GB.EXServicesOutput_GB.StandardGB.Input"
      },
    • {
      • "key": "98",
      • "id": "UK Sale Goods Standard Rate",
      • "href": "/objects/tax/order-entry-tax-detail/98",
      • "taxUniqueId": "GB.Output_GB.StandardGB.VAT"
      },
    • {
      • "key": "104",
      • "id": "UK Sale Services Standard Rate",
      • "href": "/objects/tax/order-entry-tax-detail/104",
      • "taxUniqueId": "GB.OutputServices_GB.StandardGB.VAT"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}