Get a three-way match
Procurement module
GET/invoice-matches/{id}invoiceMatches.get
A three-way match of PO, receipt and invoice. A mismatch is never auto-approved. Returns one three-way match with its `ETag`. A three-way match the caller may not see returns 404.
- Requires the capability procurement.po.read.
- OAuth scopes: procurement.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the invoice match. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: 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 GET "$XOS_BASE_URL/invoice-matches/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.invoiceMatches.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.invoice_matches.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos invoice-matches get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f