Sales Credits
List Sales Credits
Returns a paginated list of sales credits using the standard list interface. Supports search, archiving filter, and column selection.
Sales Credit Activity Log
Returns the activity log for a sales credit.
Sales Credits Filter Options
Returns available filter options (distinct values) for sales credits filtering.
List Sales Credits
Returns a paginated list of sales credits with standard list query parameters. Supports search, archiving filter, and column selection.
Create Sales Credit
Creates a new sales credit. Must be linked to either a sales_order_id or a customer_id.
Bulk Delete Sales Credits
Bulk deletes sales credits by IDs or by applying current filters.
Get Sales Credit
Returns a single sales credit with all relations: lines, store with address, sales order, RMA with receipts, payments, allocations, and accounting transaction.
Update Sales Credit
Updates a sales credit including its lines. Lines array replaces all existing lines when provided; omit lines to leave them unchanged.
Delete Sales Credit
Deletes a single sales credit.
Bulk Archive Sales Credits
Bulk archives sales credits by IDs or by applying current filters.
Bulk Unarchive Sales Credits
Bulk unarchives sales credits by IDs or by applying current filters.
Check Sales Credits Deletable
Checks whether each specified sales credit can be deleted (i.e., is not used/linked to payments or other records). Returns deletability status and reason for each.
Archive Sales Credit
Archives a single sales credit. Returns a warning if already archived.
Unarchive Sales Credit
Unarchives a single sales credit. Returns a warning if not archived.
Record Sales Credit Payment
Records a payment against a sales credit, marking it as paid.
Update Payment
Updates an existing payment on a sales credit. All fields are optional (uses sometimes validation).
Delete Payment
Deletes a payment from a sales credit and recalculates the payment status.
List Notes
Returns a paginated list of notes for a sales credit, ordered by created_at descending. Includes the note author.
Add Note
Adds a note to a sales credit.
Delete Note
Deletes a note from a sales credit.
Generate Accounting Transaction
Generates an accounting transaction for the sales credit (e.g., for syncing to accounting software like QuickBooks Online).
Preview Invoice
Generates a PDF invoice preview for the sales credit and returns the URL to the generated file.
Reconcile Sales Credit Invoice Application
Re-checks, in the connected accounting system, whether this credit note is still applied to the invoice it was raised against. While that application is recorded in Xero or QuickBooks Online, the credit's amounts can't be edited and it can't be deleted. Remove the allocation in the accounting system first (Xero: delete the credit note allocation; QuickBooks Online: delete or void the payment that links the credit memo to the invoice), then call this endpoint.
Export Sales Credits
Download an Excel/CSV export of sales credits.
Download Import Template
Download a multi-sheet XLSX import template pre-filled with sample rows, a field guide, and reference data (stores, currencies, warehouses, tax rates, nominal codes) from your account.
Validate Import
Validate and preview mapped import rows BEFORE importing. No database writes occur — safe to call repeatedly.
Import Sales Credits
Execute the import — upsert sales credits from validated data (typically the output of the Validate Import endpoint).
List Sales Credit Documents
Lists every supporting document attached to the sales credit, oldest first.
Upload Sales Credit Document
Uploads a supporting document to the sales credit.
Delete Sales Credit Document
Permanently deletes a document from the sales credit, removing both the record and the stored file.
Download Sales Credit Document
Streams the document back as a file download (Content-Disposition: attachment).
View Sales Credit Document Inline
Streams the document for inline display (Content-Disposition: inline) — used to preview a PDF or image without downloading it.