Saltar al contenido

Create a spend authority limit

Módulo Settings

POST/spend-authorityspendAuthorityLimits.create

A spend limit by role or person and document type, enforced in the approval RPCs. Creates a spend authority limit. 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.spend_authority.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: SpendAuthorityCreate

spendAuthorityLimits.create: SpendAuthorityCreate
CampoTipoObligatorioDescripción
role_idstring (uuid) | nullNoIdentifier of the role.
document_type"Purchase Order" | "Change Order" | "Expense" | "Invoice Approval" | "Contract" | "Payroll Run" | "Requisition"SíDocument type the limit applies to.
limit_minorinteger (int64) | nullSíSingle-approver limit in the org currency. Integer minor units of the resource currency; null means unpriced, never zero.
dual_approval_above_minorinteger (int64) | nullNoAmount above which two approvers are required. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringSíISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
membership_idstring (uuid) | nullNoIdentifier of the membership of the one person the limit applies to; null when it applies to a role.
account_codestring | nullNoGL account the limit is scoped to; null for every account.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
cost_center_idstring (uuid) | nullNoIdentifier of the cost center the limit is scoped to; null for every cost center.
valid_fromstring (date-time)NoWhen the limit starts.
valid_tostring (date-time) | nullNoWhen the limit ends; null while open-ended.
{
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "document_type": "Purchase Order",
  "limit_minor": 2500000,
  "dual_approval_above_minor": 10000000,
  "currency_code": "USD",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "account_code": "5100",
  "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "valid_from": "2026-10-08T14:30:00Z",
  "valid_to": "2026-10-08T14:30:00Z"
}

Respuesta 201: SpendAuthority

spendAuthorityLimits.create: SpendAuthority
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the spend authority.
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.
role_idstring (uuid) | nullSíIdentifier of the role.
document_type"Purchase Order" | "Change Order" | "Expense" | "Invoice Approval" | "Contract" | "Payroll Run" | "Requisition"SíDocument type the limit applies to.
limit_minorinteger (int64) | nullSíSingle-approver limit in the org currency. Integer minor units of the resource currency; null means unpriced, never zero.
dual_approval_above_minorinteger (int64) | nullSíAmount above which two approvers are required. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringSíISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
membership_idstring (uuid) | nullSíIdentifier of the membership of the one person the limit applies to; null when it applies to a role.
account_codestring | nullSíGL account the limit is scoped to; null for every account.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
cost_center_idstring (uuid) | nullSíIdentifier of the cost center the limit is scoped to; null for every cost center.
valid_fromstring (date-time)SíWhen the limit starts.
valid_tostring (date-time) | nullSíWhen the limit ends; null while open-ended.
{
  "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",
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "document_type": "Purchase Order",
  "limit_minor": 2500000,
  "dual_approval_above_minor": 10000000,
  "currency_code": "USD",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "account_code": "5100",
  "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "valid_from": "2026-10-08T14:30:00Z",
  "valid_to": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/spend-authority" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","document_type":"Purchase Order","limit_minor":2500000,"dual_approval_above_minor":10000000,"currency_code":"USD","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","account_code":"5100","cost_center_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","valid_from":"2026-10-08T14:30:00Z","valid_to":"2026-10-08T14:30:00Z"}'
const { data } = await xos.spendAuthorityLimits.create({
    "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "document_type": "Purchase Order",
    "limit_minor": 2500000,
    "dual_approval_above_minor": 10000000,
    "currency_code": "USD",
    "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "account_code": "5100",
    "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "valid_from": "2026-10-08T14:30:00Z",
    "valid_to": "2026-10-08T14:30:00Z"
  });
response = xos.spend_authority_limits.create({"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "document_type": "Purchase Order", "limit_minor": 2500000, "dual_approval_above_minor": 10000000, "currency_code": "USD", "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "account_code": "5100", "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "valid_from": "2026-10-08T14:30:00Z", "valid_to": "2026-10-08T14:30:00Z"})
xos spend-authority-limits create --data '{"role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","document_type":"Purchase Order","limit_minor":2500000,"dual_approval_above_minor":10000000,"currency_code":"USD","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","account_code":"5100","cost_center_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","valid_from":"2026-10-08T14:30:00Z","valid_to":"2026-10-08T14:30:00Z"}'