Saltar al contenido

Create a tax jurisdiction

Módulo Finance

POST/tax-jurisdictionstaxJurisdictions.create

A tax jurisdiction the org collects or pays tax in. Creates a tax jurisdiction. 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: TaxJurisdictionCreate

taxJurisdictions.create: TaxJurisdictionCreate
CampoTipoObligatorioDescripción
jurisdiction_idJurisdictionIdSíJurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
namestringSíTax jurisdiction name.Restricciones: length 1 to 300
{
  "jurisdiction_id": "US-FL",
  "name": "Florida Sales Tax"
}

Respuesta 201: TaxJurisdiction

taxJurisdictions.create: TaxJurisdiction
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the tax jurisdiction.
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.
jurisdiction_idJurisdictionIdSíJurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
namestringSíTax jurisdiction name.Restricciones: length 1 to 300
{
  "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",
  "jurisdiction_id": "US-FL",
  "name": "Florida Sales Tax"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/tax-jurisdictions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"jurisdiction_id":"US-FL","name":"Florida Sales Tax"}'
const { data } = await xos.taxJurisdictions.create({
    "jurisdiction_id": "US-FL",
    "name": "Florida Sales Tax"
  });
response = xos.tax_jurisdictions.create({"jurisdiction_id": "US-FL", "name": "Florida Sales Tax"})
xos tax-jurisdictions create --data '{"jurisdiction_id":"US-FL","name":"Florida Sales Tax"}'