Sales Credits
List Sales Credits
Returns a paginated list of sales credits.
Sales Credits Filter Options
Returns available filter options (distinct values) for sales credits filtering.
Sales Credit Activity Log
Returns the activity log for a sales credit.
List Sales Credits
Returns a paginated list of sales credits using the DataTable system. 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 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 Payment (Paid)
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.