Saltar al contenido

Update a tax rate

Módulo Finance

PATCH/tax-rates/{id}taxRates.update

A tax rate with its effective dates. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad org.legal_entities.write.
  • Alcances de OAuth: org.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

taxRates.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the tax rate.

Cuerpo de la solicitud: TaxRateUpdate

taxRates.update: TaxRateUpdate
CampoTipoObligatorioDescripción
rate_percentnumberNoRate in percent.
effective_fromstring (date)NoFirst day the rate applies.
effective_tostring (date) | nullNoLast day the rate applies.
tax_typeTaxTypeNoTax type from the Universal Posting Line specification (Bible tab 36).Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
{
  "rate_percent": 7,
  "effective_from": "2026-10-08",
  "effective_to": "2026-10-08"
}

Respuesta 200: TaxRate

taxRates.update: 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 PATCH "$XOS_BASE_URL/tax-rates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"rate_percent":7,"effective_from":"2026-10-08","effective_to":"2026-10-08"}'
const { data, etag } = await xos.taxRates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "rate_percent": 7,
    "effective_from": "2026-10-08",
    "effective_to": "2026-10-08"
  }, { ifMatch: etag });
response = xos.tax_rates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"rate_percent": 7, "effective_from": "2026-10-08", "effective_to": "2026-10-08"}, if_match=etag)
xos tax-rates update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"rate_percent":7,"effective_from":"2026-10-08","effective_to":"2026-10-08"}' --if-match auto