Skip to content

Accept an invoice mismatch

Procurement module

POST/invoice-matches/{id}/resolveinvoiceMatches.resolve

Records why a mismatch is accepted. Only someone other than the person who recorded the match may accept it, once; a refusal returns 422 and names the rule. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • 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, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

invoiceMatches.resolve: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the invoice match.

Request body: InvoiceMatchResolveRequest

invoiceMatches.resolve: InvoiceMatchResolveRequest
FieldTypeRequiredDescription
resolution_notestringYesWhy the difference is accepted.Constraints: length 1 to 1000
{
  "resolution_note": "Freight surcharge agreed by phone."
}

Response 200: InvoiceMatch

invoiceMatches.resolve: InvoiceMatch
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the invoice match.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
invoice_idstring (uuid)YesIdentifier of the invoice.
purchase_order_idstring (uuid)YesIdentifier of the purchase order.
goods_receipt_idstring (uuid)YesIdentifier of the goods receipt.
matchedbooleanYesWhether all three agree.
variance_minorinteger (int64) | nullYesInvoice total minus value received at order prices. Integer minor units of the resource currency; null means unpriced, never zero.
resolution_notestring | nullYesWhy a mismatch was accepted.Constraints: length 1 to 20000
resolved_bystring (uuid) | nullYesIdentifier of the person who accepted the mismatch.
resolved_atstring (date-time) | nullYesWhen 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/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/resolve" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"resolution_note":"Freight surcharge agreed by phone."}'
const { data } = await xos.invoiceMatches.resolve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "resolution_note": "Freight surcharge agreed by phone."
  });
response = xos.invoice_matches.resolve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"resolution_note": "Freight surcharge agreed by phone."})
xos invoice-matches resolve 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"resolution_note":"Freight surcharge agreed by phone."}'