Create a three-way match
Procurement module
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.
- Requires the capability procurement.invoice_match.write.
- OAuth scopes: procurement.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: InvoiceMatchCreate
| Field | Type | Required | Description |
|---|---|---|---|
| invoice_id | string (uuid) | Yes | Identifier of the invoice. |
| purchase_order_id | string (uuid) | Yes | Identifier of the purchase order. |
| goods_receipt_id | string (uuid) | Yes | 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"
}Response 201: InvoiceMatch
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the invoice match. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| invoice_id | string (uuid) | Yes | Identifier of the invoice. |
| purchase_order_id | string (uuid) | Yes | Identifier of the purchase order. |
| goods_receipt_id | string (uuid) | Yes | Identifier of the goods receipt. |
| matched | boolean | Yes | Whether all three agree. |
| variance_minor | integer (int64) | null | Yes | Invoice total minus value received at order prices. Integer minor units of the resource currency; null means unpriced, never zero. |
| resolution_note | string | null | Yes | Why a mismatch was accepted.Constraints: length 1 to 20000 |
| resolved_by | string (uuid) | null | Yes | Identifier of the person who accepted the mismatch. |
| resolved_at | string (date-time) | null | Yes | 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"
}Code samples
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"}'