Tax authorities are agencies for whom you collect sales tax or other taxes. For example, in the United States, you might report and pay any tax you owe to city, county, and state agencies. Tax authorities are shared across Accounts Payable, Accounts Receivable, Order Entry, and Purchasing. See Tax authorities—Taxes application for more information.
Returns a collection with a key, ID, and link for each tax authority. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Accounts Receivable, Order Entry, Purchasing |
---|---|
User type | Business |
Permissions | List, View Tax Authority |
OK
Bad Request
{- "ia::result": [
- {
- "key": "2",
- "id": "Alaska",
- "href": "/objects/tax/tax-authority/2"
}, - {
- "key": "5",
- "id": "California",
- "href": "/objects/tax/tax-authority/5"
}, - {
- "key": "3",
- "id": "Arizona",
- "href": "/objects/tax/tax-authority/3"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new tax authority.
Subscription | Accounts Receivable, Order Entry, Purchasing |
---|---|
User type | Business |
Permissions | List, View, Add Tax Authority |
id required | string Unique identifier for the tax authority. Example: "Texas" | ||||
description | string Description of the tax authority or other additional information. Example: "Texas tax authority" | ||||
vendorId | string The unique identifier of the vendor to whom you'll pay the taxes collected for this tax authority. Example: "Vendor_Visa_C" | ||||
object Parent tax authority. | |||||
|
Created
Bad Request
{- "id": "Texas",
- "description": "Texas tax authority",
- "vendorId": "Vendor_Visa_C",
- "parent": {
- "id": "5"
}
}
{- "ia::result": {
- "key": "105",
- "id": "Texas",
- "href": "/objects/tax/tax-authority/105"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified tax authority.
Subscription | Accounts Receivable, Order Entry, Purchasing |
---|---|
User type | Business |
Permissions | List, View Tax Authority |
key required | integer System-assigned key for the tax authority. Example: 93 |
OK
Bad Request
{- "ia::result": {
- "key": "105",
- "id": "Texas",
- "description": "Texas tax authority",
- "vendorId": "Vendor_Visa_C",
- "parent": {
- "name": "California",
- "href": "/objects/tax/tax-authority/24"
}, - "href": "/objects/tax/tax-authority/105"
}, - "ia::meta": {
- "totalCount": 1
}
}
Updates an existing tax authority by setting field values. Any fields not provided remain unchanged.
Subscription | Accounts Receivable, Order Entry, Purchasing |
---|---|
User type | Business |
Permissions | List, View, Edit Tax Authority |
key required | integer System-assigned key for the tax authority. Example: 93 |
description | string Description of the tax authority or other additional information. Example: "Texas tax authority" | ||||
vendorId | string The unique identifier of the vendor to whom you'll pay the taxes collected for this tax authority. Example: "Vendor_Visa_C" | ||||
object Parent tax authority. | |||||
|
OK
Bad Request
{- "description": "Updated description"
}
{- "ia::result": {
- "key": "105",
- "id": "Texas",
- "href": "/objects/tax/tax-authority/105"
}, - "ia::meta": {
- "totalCount": 1
}
}
Delete a tax authority that is no longer in use. After a tax authority is deleted, it can't be recovered.
Subscription | Accounts Receivable, Order Entry, Purchasing |
---|---|
User type | Business |
Permissions | List, View, Delete Tax Authority |
key required | integer System-assigned key for the tax authority. Example: 93 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "tax/tax-authority" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
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 |
OK
Bad Request
{- "object": "tax/tax-authority",
- "fields": [
- "id",
- "vendorId",
- "href"
], - "filters": [
- {
- "$eq": {
- "id": "MPC"
}
}
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "MPC",
- "vendorId": "1099 Int",
- "href": "/objects/tax/tax-authority/1"
}
], - "ia::meta": {
- "totalCount": 1,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}