Purchasing tax schedules

A Purchasing tax schedule identifies the tax details that are applied when the schedule is referenced by a Purchasing tax schedule map. See Tax schedules—Taxes application for more information.

List Purchasing tax schedules

get/objects/tax/purchasing-tax-schedule

Returns a collection with a key, ID, and link for each Purchasing tax schedule. This operation is mostly for use in testing; use the query service 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": "1",
      • "id": "1",
      • "href": "/objects/tax/purchasing-tax-schedule/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/tax/purchasing-tax-schedule/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/tax/purchasing-tax-schedule/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a Purchasing tax schedule
post/objects/tax/purchasing-tax-schedule
Creates a new Purchasing tax schedule.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
name
string
Name or other unique identifier for the Purchasing tax schedule.


 
 Example:  "TaxSched-00003"
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"
description
string
Description of the Purchasing tax schedule or other additional information.


 
 Example:  "Description of the Tax Schedule"
Array of objects
Purchasing tax schedule details for the tax schedule.


 
 Array 
effectiveDate
string <date> 
Date when the Purchasing tax schedule detail becomes effective.


 
 Example:  "2022-01-08"
object
Purchasing tax details describe specific types of taxes that apply to lines in Purchasing transactions.


 
object
Different tax solutions are available for different countries. Examples include Australia GST, South Africa VAT, and UK VAT.


 
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
{
  • "name": "TaxSched-00005",
  • "description": "Purchase Tax for New York City",
  • "taxSolution": {
    • "key": 10
    },
  • "status": "active",
  • "lines": [
    • {
      • "taxDetail": {
        },
      • "effectiveDate": "2022-02-26"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "308",
    • "id": "308",
    • "href": "/objects/tax/purchasing-tax-schedule/308"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a Purchasing tax schedule
get/objects/tax/purchasing-tax-schedule/{key}
Returns detailed information for a specified Purchasing tax schedule.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the Purchasing tax schedule.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "name": "Tax Florida",
    • "id": "165",
    • "key": "165",
    • "description": "Purchase tax for Florida",
    • "status": "active",
    • "isSystemGenerated": false,
    • "taxSolution": {
      • "id": "Avalara Tax",
      • "key": "1",
      • "href": "/objects/tax/tax-solution/1"
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/tax/purchasing-tax-schedule/167"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a Purchasing tax schedule
patch/objects/tax/purchasing-tax-schedule/{key}
Updates an existing Purchasing tax schedule by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the Purchasing tax schedule.


 
 Example:  99
Request Body schema: application/json
name
string
Name or other unique identifier for the Purchasing tax schedule.


 
 Example:  "TaxSched-00003"
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"
description
string
Description of the Purchasing tax schedule or other additional information.


 
 Example:  "Description of the Tax Schedule"
Array of objects
Purchasing tax schedule details for the tax schedule.


 
 Array 
effectiveDate
string <date> 
Date when the Purchasing tax schedule detail becomes effective.


 
 Example:  "2022-01-08"
object
Purchasing tax details describe specific types of taxes that apply to lines in Purchasing transactions.


 
object
Different tax solutions are available for different countries. Examples include Australia GST, South Africa VAT, and UK VAT.


 
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": "162",
    • "href": "/objects/tax/purchasing-tax-schedule/162"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a Purchasing tax schedule
delete/objects/tax/purchasing-tax-schedule/{key}
Deletes a Purchasing tax schedule. Delete a tax schedule if it is no longer needed. Deleting a tax schedule removes it from the system so that it can't be recovered.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the Purchasing tax schedule.


 
 Example:  99
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
    }
}