Record Sales Credit Payment
POST/api/sales-credits/paid
Records a payment against a sales credit, marking it as paid.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Fields:
- sales_credit_id (required): Sales credit ID to record payment for
- payment_type_id (required): Payment type ID
- payment_date (optional, date): Date of payment
- amount (required, numeric, > 0): Payment amount — must not exceed remaining balance
- external_reference (optional, max 255): External reference number
- currency_id (optional): Currency ID
Returns 422 (sales_credit_id error) when the credit records a refund made through PayPal (is_paypal_refund: true): PayPal already paid that refund, so another payment can't be added.
Refund cap: the amount may not exceed what is still available on the credit — its total less every amount applied to invoices or orders (including the invoice the credit was raised against) and every earlier refund. Exceeding it returns 422 on amount; when the credit's application is recorded in Xero or QuickBooks Online, the message names that system. A credit created for an overpayment is fully available to refund. After the change, the balances of the invoices the credit belongs to are recalculated.
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.