Override Purchase Invoice 3-Way Match for Payment
POST/api/purchase-invoices/:purchaseInvoice/match-override
Let a purchase invoice be paid even though it does not pass its 3-way match (a price or quantity variance against its purchase order, or goods not yet received), recording who decided and why.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Only matters when the account requires a clean 3-way match before payment (accounting setting bills_require_match_before_payment). While that setting is on, every payment of an unmatched invoice is refused with 422 and code: match_review_required until the invoice is approved or overridden: recording a payment, approve-and-pay, supplier payment runs, Mercury payments and sending the invoice to BILL. Refunds are never held back.
The override is cleared whenever the invoice's match is evaluated again (for example after its lines change), so a changed bill needs a new decision.
The invoice's payment_match_gate field reports whether payment is blocked, why, and the override on record.
Body:
reason(string, required, 3–1000 characters): why the bill may be paid anyway.
Errors:
422when the reason is missing, the invoice passes its match, or its match exceptions were already approved.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.