Record Vendor Credit Refund Payment
POST/api/vendor-credits/paid
Record a refund payment against a vendor credit — money the supplier paid back instead of the credit being applied to bills.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Fields: vendor_credit_id, payment_type_id, and amount are required; payment_date, external_reference (max 255 characters), and currency_id are optional. The amount must be positive and cannot exceed the credit's remaining balance; when currency_id is sent it must match the credit's currency. Negative amounts are stored as their absolute value.
Returns the updated vendor credit including its payments.
Request
Responses
- 200
- 401
- 403
- 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.
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.