Skip to content

Update a spend authority limit

Settings module

PATCH/spend-authority/{id}spendAuthorityLimits.update

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

  • Requires the capability org.spend_authority.write.
  • OAuth scopes: org.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

spendAuthorityLimits.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the spend authority.

Request body: SpendAuthorityUpdate

spendAuthorityLimits.update: SpendAuthorityUpdate
FieldTypeRequiredDescription
role_idstring (uuid) | nullNoIdentifier of the role.
document_type"Purchase Order" | "Change Order" | "Expense" | "Invoice Approval" | "Contract" | "Payroll Run" | "Requisition"NoDocument type the limit applies to.
limit_minorinteger (int64) | nullNoSingle-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_codestringNoISO 4217 currency code of every money field.Constraints: 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.Constraints: 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"
}

Response 200: SpendAuthority

spendAuthorityLimits.update: SpendAuthority
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the spend authority.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
role_idstring (uuid) | nullYesIdentifier of the role.
document_type"Purchase Order" | "Change Order" | "Expense" | "Invoice Approval" | "Contract" | "Payroll Run" | "Requisition"YesDocument type the limit applies to.
limit_minorinteger (int64) | nullYesSingle-approver limit in the org currency. Integer minor units of the resource currency; null means unpriced, never zero.
dual_approval_above_minorinteger (int64) | nullYesAmount above which two approvers are required. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
membership_idstring (uuid) | nullYesIdentifier of the membership of the one person the limit applies to; null when it applies to a role.
account_codestring | nullYesGL account the limit is scoped to; null for every account.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
cost_center_idstring (uuid) | nullYesIdentifier of the cost center the limit is scoped to; null for every cost center.
valid_fromstring (date-time)YesWhen the limit starts.
valid_tostring (date-time) | nullYesWhen 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"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/spend-authority/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 '{"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, etag } = await xos.spendAuthorityLimits.update("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"
  }, { ifMatch: etag });
response = xos.spend_authority_limits.update("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"}, if_match=etag)
xos spend-authority-limits update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --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"}' --if-match auto