Create a tax rate
Finance module
POST/tax-ratestaxRates.create
A tax rate with its effective dates. Creates a tax rate. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability org.legal_entities.write.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: TaxRateCreate
| Field | Type | Required | Description |
|---|---|---|---|
| tax_jurisdiction_id | string (uuid) | Yes | Identifier of the tax jurisdiction. |
| rate_percent | number | Yes | Rate in percent. |
| effective_from | string (date) | Yes | First day the rate applies. |
| effective_to | string (date) | null | No | Last day the rate applies. |
| tax_type | TaxType | Yes | Tax type from the Universal Posting Line specification (Bible tab 36).Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
{
"tax_jurisdiction_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rate_percent": 7,
"effective_from": "2026-10-08",
"effective_to": "2026-10-08",
"tax_type": "Tax on Purchases"
}Response 201: TaxRate
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the tax rate. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| tax_jurisdiction_id | string (uuid) | Yes | Identifier of the tax jurisdiction. |
| rate_percent | number | Yes | Rate in percent. |
| effective_from | string (date) | Yes | First day the rate applies. |
| effective_to | string (date) | null | Yes | Last day the rate applies. |
| tax_type | TaxType | Yes | Tax type from the Universal Posting Line specification (Bible tab 36).Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"tax_jurisdiction_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rate_percent": 7,
"effective_from": "2026-10-08",
"effective_to": "2026-10-08",
"tax_type": "Tax on Purchases"
}Code samples
curl -X POST "$XOS_BASE_URL/tax-rates" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"tax_jurisdiction_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","rate_percent":7,"effective_from":"2026-10-08","effective_to":"2026-10-08","tax_type":"Tax on Purchases"}'const { data } = await xos.taxRates.create({
"tax_jurisdiction_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rate_percent": 7,
"effective_from": "2026-10-08",
"effective_to": "2026-10-08",
"tax_type": "Tax on Purchases"
});response = xos.tax_rates.create({"tax_jurisdiction_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "rate_percent": 7, "effective_from": "2026-10-08", "effective_to": "2026-10-08", "tax_type": "Tax on Purchases"})xos tax-rates create --data '{"tax_jurisdiction_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","rate_percent":7,"effective_from":"2026-10-08","effective_to":"2026-10-08","tax_type":"Tax on Purchases"}'