Transition the vendor state

Módulo Vendors

POST/vendors/{id}/transitionsvendors.transition

Moves the vendor lifecycle to another state through its transition RPC, which writes the transition ledger. Uses compare-and-set on `expected_state`; a disallowed transition returns a 422 refusal. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

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

Parámetros de ruta y de consulta

vendors.transition: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the vendor.

Cuerpo de la solicitud: VendorTransitionRequest

vendors.transition: VendorTransitionRequest
Campo	Tipo	Obligatorio	Descripción
expected_state	string	Sí	The state the caller believes the row is in (compare-and-set).Restricciones: pattern ^[A-Z][A-Za-z]( [A-Z][A-Za-z])*$
to_state	string	Sí	Target state.Restricciones: pattern ^[A-Z][A-Za-z]( [A-Z][A-Za-z])*$
reason	string	No	Reason, required by some transitions.Restricciones: length 1 to any

{
  "expected_state": "Prospect",
  "to_state": "Onboarded",
  "reason": "Client approved the revised scope."
}

Respuesta 200: Vendor

vendors.transition: Vendor
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the vendor.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
counterparty_type	CounterpartyType \| null	Sí
vendor_state	"Prospect" \| "Onboarded" \| "Active" \| "Blocked" \| "Canceled"	Sí	Vendor state.
counterparty_id	string (uuid)	Sí	Identifier of the counterparty the vendor facet belongs to.
payment_terms_days	integer \| null	Sí	Days after invoice the vendor is paid.Restricciones: range 0 to any
default_currency_code	string \| null	Sí	ISO 4217 currency the vendor bills in by default.Restricciones: pattern ^[A-Z]{3}$
default_account_code	GlAccountCode \| null	Sí
default_cost_center_id	string (uuid) \| null	Sí	Identifier of the cost center (dimension 1) the vendor's costs post to unless a line says otherwise.
bank_account_last4	string \| null	Sí	Last four digits of the vendor's most recent bank account; null when none is on file.Restricciones: pattern ^[0-9]{4}$; length 1 to 4

{
  "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",
  "counterparty_type": "AV Integrator",
  "vendor_state": "Prospect",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "payment_terms_days": 30,
  "default_currency_code": "USD",
  "default_account_code": "5400",
  "default_cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "bank_account_last4": "4321"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/vendors/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expected_state":"Prospect","to_state":"Onboarded","reason":"Client approved the revised scope."}'

const { data } = await xos.vendors.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "expected_state": "Prospect",
    "to_state": "Onboarded",
    "reason": "Client approved the revised scope."
  });

response = xos.vendors.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Prospect", "to_state": "Onboarded", "reason": "Client approved the revised scope."})

xos vendors transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Prospect","to_state":"Onboarded","reason":"Client approved the revised scope."}'