Create a vendor

Módulo Vendors

POST/vendorsvendors.create

An organization in the vendor relationship with this org, with its counterparty type. Creates a vendor. 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 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, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: VendorCreate

vendors.create: VendorCreate
Campo	Tipo	Obligatorio	Descripción
counterparty_id	string (uuid)	Sí	Identifier of the counterparty the vendor facet belongs to.
payment_terms_days	integer \| null	No	Days after invoice the vendor is paid.Restricciones: range 0 to any
default_currency_code	string \| null	No	ISO 4217 currency the vendor bills in by default.Restricciones: pattern ^[A-Z]{3}$
default_account_code	GlAccountCode \| null	No
default_cost_center_id	string (uuid) \| null	No	Identifier of the cost center (dimension 1) the vendor's costs post to unless a line says otherwise.

{
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "payment_terms_days": 30,
  "default_currency_code": "USD",
  "default_cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: Vendor

vendors.create: 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" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","payment_terms_days":30,"default_currency_code":"USD","default_cost_center_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.vendors.create({
    "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "payment_terms_days": 30,
    "default_currency_code": "USD",
    "default_cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.vendors.create({"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "payment_terms_days": 30, "default_currency_code": "USD", "default_cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos vendors create --data '{"counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","payment_terms_days":30,"default_currency_code":"USD","default_cost_center_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'