Get Creditable Lines for Sales Invoice
GET/api/sales-invoices/:salesInvoice/credit-notes/preview
What can still be credited on each line of an issued sales invoice — use it to choose quantities before calling Create Credit Note for Sales Invoice.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Each line returns its invoiced quantity, the quantity still creditable (product lines), the net amount per unit, and the net amount still creditable (the cap for fee lines). Amounts are before tax.
Returns 422 for an order invoice (credit the sales order instead), a draft or void invoice, or a consolidated invoice.
Requires orders:read and both the returns.create and sales_invoices.update permissions.
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 Content
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.