Preview Sales Invoice Totals
POST/api/sales-invoices/preview-totals
Compute what a create request would produce — lines, fee allocation, subtotal, tax, total, due date and number preview — without saving anything. Takes the same body as Create Sales Invoice, including source: deposit with deposit_amount or deposit_percent (issue is ignored); line problems are returned in errors instead of failing the request.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
fees[] lists every line that is not a product line: order fees (financial_line_id set), the deposit line of a deposit invoice and the negative Less deposit line that deducts an issued deposit (financial_line_id null). Each has the line fields plus name (the line's description), amount (its total, 2-decimal string) and note — a plain-language explanation for deposit lines ("Billed up front — later invoices deduct it." / "Deducts the deposit already invoiced on this order."), null for ordinary fees.
Requires orders:write and sales_invoices.create.
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.