Update Payment
PUT/api/purchase-invoices/:purchaseInvoiceId/payments/:payment
Update a payment on a purchase invoice. All fields are optional on update.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Note: payment_type_id cannot be changed for credit payment types (system-created).
Approval policy:
While the bill-payment approval policy is enabled, raising a payment's amount draws the increase from the bill's approved remainder — 422 approval_required / approval_pending when it does not fit.
Under a bill-payment approval policy the payment's currency_id must match the bill's currency; otherwise the request is refused with 422 approval_currency_mismatch.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
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.