Tax Rates

Retrieve available tax rate definitions. Tax rates are used when creating charges.

Endpoints Overview

Method	Endpoint	Description
`GET`	`/v1/tax-rates`	Get a page of tax rates

Get Tax Rates Page

Retrieve a paginated list of tax rates.

Endpoint: GET /v1/tax-rates

Query Parameters

Parameter	Type	Required	Description
`PageIndex`	integer	No	Page number (default: 1)
`PageSize`	integer	No	Items per page (default: 25, max: 500)
`SearchText`	string	No	Filter by tax rate name

Request Example

curl -X GET "https://api.consignlyhq.com/v1/tax-rates?PageIndex=1&PageSize=50" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example

{
  "index": 1,
  "total": 4,
  "taxRates": [
    {
      "id": "550e8400-e29b-41d4-a716-446655449600",
      "name": "GST 15%",
      "percent": 15.0
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655449601",
      "name": "GST Exempt",
      "percent": 0.0
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655449602",
      "name": "Zero Rated",
      "percent": 0.0
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655449603",
      "name": "GST 10%",
      "percent": 10.0
    }
  ]
}

Response Fields

Field	Type	Description
`id`	uuid	Tax rate ID
`name`	string	Tax rate name
`percent`	number	Tax rate percentage

Using Tax Rate IDs

Tax rate IDs are required when creating adhoc charges:

{
  "particulars": "Special handling fee",
  "metricValue": 1,
  "chargeApplication": 2,
  "chargeRateExclTax": 45.00,
  "taxRateId": "550e8400-e29b-41d4-a716-446655449600"
}

Consignment Charges - Create charges with tax rates
Revenue Accounts - Revenue account lookup
Cost Centres - Cost centre lookup

Task Types

Warehouses