Saltar al contenido

Create a tax rate

Módulo Finance

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.

  • Requiere la capacidad org.legal_entities.write.
  • Alcances de OAuth: org.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: TaxRateCreate

taxRates.create: TaxRateCreate
CampoTipoObligatorioDescripción
tax_jurisdiction_idstring (uuid)SíIdentifier of the tax jurisdiction.
rate_percentnumberSíRate in percent.
effective_fromstring (date)SíFirst day the rate applies.
effective_tostring (date) | nullNoLast day the rate applies.
tax_typeTaxTypeSíTax type from the Universal Posting Line specification (Bible tab 36).Restricciones: 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"
}

Respuesta 201: TaxRate

taxRates.create: TaxRate
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the tax rate.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
tax_jurisdiction_idstring (uuid)SíIdentifier of the tax jurisdiction.
rate_percentnumberSíRate in percent.
effective_fromstring (date)SíFirst day the rate applies.
effective_tostring (date) | nullSíLast day the rate applies.
tax_typeTaxTypeSíTax type from the Universal Posting Line specification (Bible tab 36).Restricciones: 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"
}

Ejemplos de código

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"}'