Retrieve Tax Rate

GET 
/accounting/tax-rates/:id

Retrieve a Tax Rate with the given id.

Request

Path Parameters

id stringrequired

The ID of the tax rate.

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

taxRate

object

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)

{
  "taxRate": {
    "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

{
  "taxRate": {
    "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...