Skip to main content
GST Taxes API

Authentication

All requests require an API key in the request headers. Headers:
The permission required on your API key is Tax with the Read action enabled.

Request

This endpoint takes no path parameters, query parameters, or body. Every GST tax configured for the organization is returned in a single response — there is no pagination.
GST taxes are configured per GSTIN entity, so an organization with multiple registered entities returns one entry per rate per entity. Use entityGstin to pick the rows belonging to the entity you’re raising the transaction for.

Code Examples

Success Response

HTTP Status: 200 OK Response Fields:

Response Example

Empty Result

An organization with no GST taxes configured returns 200 with an empty array, not an error:

Error Responses

Authentication Errors

HTTP Status: 401 Unauthorized

Permission Errors

HTTP Status: 403 Forbidden Returned when the API key doesn’t have the Tax resource with the Read action enabled.

Rate Limiting

HTTP Status: 429 Too Many Requests

Server Errors

HTTP Status: 500 Internal Server Error

Best Practices

  • Use id as the gstId when creating a vendor advance, and compute the expected gstAmount from rate and rateType — the create API validates your figure against its own calculation and rejects a mismatch
  • Filter by entityGstin when your organization has multiple GSTIN entities, and keep it consistent with the orgEntity you send on the transaction
  • Refresh this list at the start of each integration run rather than hardcoding ids; taxes are added and retired over time
  • Match on section and rate (not label) when mapping to your own tax master — labels are free text set by the organization