Settings Tax Rates

List Tax Rates

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of tax rates

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

500

Unexpected error

application/json

get/settings/taxRates

HTTPcURLJavaScriptPython

GET /v2/settings/taxRates HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalRows": 1,
  "rows": [
    {
      "id": "standard-tax",
      "description": "Standard Tax",
      "rate": 5,
      "isDefault": true
    }
  ]
}

Create Tax Rate

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

descriptionstringOptional

The description of the tax rate.

ratenumberRequired

The tax rate percentage (e.g., 20 for 20%).

isDefaultbooleanOptional

Indicates if this is included on new quotes by default.

Responses

200

Successfully created tax rate

application/json

idstringRequired

The unique ID of the tax rate.

descriptionstringOptional

The description of the tax rate.

ratenumberRequired

The tax rate percentage (e.g., 20 for 20%).

isDefaultbooleanOptional

Indicates if this is included on new quotes by default.

400

Bad Request

application/json

401

Not Authorized

application/json

409

Conflict - Tax Rate already exists

application/json

500

Unexpected error

application/json

post/settings/taxRates

HTTPcURLJavaScriptPython

POST /v2/settings/taxRates HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "description": "Standard Tax",
  "rate": 5,
  "isDefault": true
}

{
  "id": "standard-tax",
  "description": "Standard Tax",
  "rate": 5,
  "isDefault": true
}

Retrieve Tax Rate

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Tax Rate

Responses

200

Details about the tax rate

application/json

idstringRequired

The unique ID of the tax rate.

descriptionstringOptional

The description of the tax rate.

ratenumberRequired

The tax rate percentage (e.g., 20 for 20%).

isDefaultbooleanOptional

Indicates if this is included on new quotes by default.

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/settings/taxRates/{id}

HTTPcURLJavaScriptPython

GET /v2/settings/taxRates/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "standard-tax",
  "description": "Standard Tax",
  "rate": 5,
  "isDefault": true
}

Update Tax Rate

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Tax Rate

Body

application/json

idstringRequired

The unique ID of the tax rate.

descriptionstringOptional

The description of the tax rate.

ratenumberRequired

The tax rate percentage (e.g., 20 for 20%).

isDefaultbooleanOptional

Indicates if this is included on new quotes by default.

Responses

200

Successfully updated tax rate

application/json

idstringRequired

The unique ID of the tax rate.

descriptionstringOptional

The description of the tax rate.

ratenumberRequired

The tax rate percentage (e.g., 20 for 20%).

isDefaultbooleanOptional

Indicates if this is included on new quotes by default.

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/settings/taxRates/{id}

HTTPcURLJavaScriptPython

PUT /v2/settings/taxRates/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "id": "standard-tax",
  "description": "Standard Tax",
  "rate": 5,
  "isDefault": true
}

{
  "id": "standard-tax",
  "description": "Standard Tax",
  "rate": 5,
  "isDefault": true
}

Delete Tax Rate

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Tax Rate

Responses

204

Tax Rate successfully deleted

No content

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

delete/settings/taxRates/{id}

HTTPcURLJavaScriptPython

DELETE /v2/settings/taxRates/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content