Financial API
GET/api/v1/financial/tax/rates
Product availabilityAlgaPSA

List tax rates

Returns tenant-scoped tax rates. cap_amount is a safe integer in currency_code minor units, or null for no cap; zero is intentional. A null currency applies to all invoice currencies, including unresolved legacy caps. Caps apply per rate contribution and per period segment, not to component-based composite calculations. Requires financial:read, billing:read and PSA product access. This route exposes GET only; no tax-rate mutation endpoints are added.

RBAC · financial

Query parameters

pagestringOptional
limitstringOptional
sortstringOptional
orderstringOptional
searchstringOptional
created_fromstring <date-time>Optional
created_tostring <date-time>Optional
updated_fromstring <date-time>Optional
updated_tostring <date-time>Optional
is_activestringOptional
region_codestringOptional
effective_dateanyOfOptional

Response body

Success response 200 · schema TaxRateListResponse

dataarray of objectRequired
itemsobject
tax_rate_idstring <uuid>Required
region_codestringRequired
tax_percentagenumberRequired
descriptionstringNullable
start_dateanyOf
anyOf (option 1)string
pattern /^\d{4}-\d{2}-\d{2}$/
anyOf (option 2)string <date-time>
end_dateanyOf
anyOf (option 1)string
pattern /^\d{4}-\d{2}-\d{2}$/
anyOf (option 2)string <date-time>
anyOf (option 3)null
cap_amountintegerRequiredNullable
Tax cap in currency_code minor units; null is uncapped, zero charges zero on supported calculation paths.
≥ 0 · ≤ 9007199254740991
currency_codestringRequiredNullable
created_atstring <date-time>
updated_atstring <date-time>
tenantstring <uuid>Required
is_activeboolean
is_compositeboolean
paginationobjectRequired
pagenumberRequired
limitnumberRequired
totalnumberRequired
totalPagesnumberRequired
hasNextbooleanRequired
hasPrevbooleanRequired
metaobject

Response codes

200
Paginated list returned.
400
Invalid query parameters.
401
API key missing/invalid.
403
financial:read, billing:read or PSA product access denied.
500
Unexpected list failure.