List Tax Rates

GET 
/accounting/tax-rates

Returns a list of Tax Rates.

Request

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber string

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

remoteId string

Used to filter tax rates with this third-party application ID.

descriptionContains string

Used to filter tax rates whose descriptions contain the provided value.

totalTaxRate float

Used to filter tax rates with the exact total tax rate.

totalTaxRateMin float

Used to filter tax rates with the minimum total tax rate.

totalTaxRateMax float

Used to filter tax rates with the maximum total tax rate.

totalTaxRateNotEquals float

Used to filter tax rates whose total tax rate to exclude.

effectiveTaxRate float

Used to filter tax rates with the exact effective tax rate.

effectiveTaxRateMin float

Used to filter tax rates with the minimum effective tax rate.

effectiveTaxRateMax float

Used to filter tax rates with the maximum effective tax rate.

effectiveTaxRateNotEquals float

Used to filter tax rates whose effective tax rate to exclude.

companyId string

Used to filter tax rates with this company ID.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

taxRates

object[]

Array [

id string

remoteId string

description string

totalTaxRate integer

Default value: 0

effectiveTaxRate

companyId

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

]

Example (from schema)

{
  "taxRates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "remoteId": "9",
      "description": "Sales Tax",
      "totalTaxRate": 2,
      "effectiveTaxRate": {},
      "companyId": {},
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z"
    }
  ]
}

Result

{
  "taxRates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "remoteId": "9",
      "description": "Sales Tax",
      "totalTaxRate": 2,
      "effectiveTaxRate": null,
      "companyId": null,
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z"
    }
  ] 
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...