Saltar al contenido

Create a three-way match

Módulo Procurement

POST/invoice-matchesinvoiceMatches.create

A three-way match of PO, receipt and invoice. A mismatch is never auto-approved. Creates a three-way match. 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 procurement.invoice_match.write.
  • Alcances de OAuth: procurement.
  • 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: InvoiceMatchCreate

invoiceMatches.create: InvoiceMatchCreate
CampoTipoObligatorioDescripción
invoice_idstring (uuid)SíIdentifier of the invoice.
purchase_order_idstring (uuid)SíIdentifier of the purchase order.
goods_receipt_idstring (uuid)SíIdentifier of the goods receipt.
{
  "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "goods_receipt_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: InvoiceMatch

invoiceMatches.create: InvoiceMatch
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the invoice match.
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.
invoice_idstring (uuid)SíIdentifier of the invoice.
purchase_order_idstring (uuid)SíIdentifier of the purchase order.
goods_receipt_idstring (uuid)SíIdentifier of the goods receipt.
matchedbooleanSíWhether all three agree.
variance_minorinteger (int64) | nullSíInvoice total minus value received at order prices. Integer minor units of the resource currency; null means unpriced, never zero.
resolution_notestring | nullSíWhy a mismatch was accepted.Restricciones: length 1 to 20000
resolved_bystring (uuid) | nullSíIdentifier of the person who accepted the mismatch.
resolved_atstring (date-time) | nullSíWhen the mismatch was accepted.
{
  "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",
  "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "goods_receipt_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "matched": true,
  "variance_minor": 2000,
  "resolution_note": "Freight surcharge agreed.",
  "resolved_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "resolved_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/invoice-matches" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"invoice_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","purchase_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","goods_receipt_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.invoiceMatches.create({
    "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "goods_receipt_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.invoice_matches.create({"invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "goods_receipt_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos invoice-matches create --data '{"invoice_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","purchase_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","goods_receipt_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'