AlmondTill/G3N API

Return

The Return family — 8 operations.

A return is a customer bringing goods back against a sale — the goods-back document, distinct from a return to supplier and from a credit note, which corrects a bill rather than taking goods back. It names the order (and optionally its invoice), the store or warehouse receiving the goods, and the order lines and whole-unit quantities coming back; while it is still requested you can change the lines, and after approval the request is fixed. Approve it, then receive the goods line by line with a disposition for each — back to stock, held for inspection, damaged, or scrapped as a write-off — and the refund owed is worked out from what the customer actually paid; then record how the money goes back (the original card, cash from the open drawer, or store credit) and close it. Reject a request that does not qualify, or cancel one before the goods arrive; a rejected or cancelled return leaves the listings and a fresh request is a new return.

Operations

OperationKindWhat it does
approveReturnmutationApprove a customer return — your sign-off moves it forward.
cancelReturnmutationCancel a customer return.
closeReturnmutationClose a customer return — finish it.
createReturnmutationCreate a new customer return at your organization.
rejectReturnmutationReject a customer return — send it back or stop it.
returnqueryLook up one record — a customer return.
returnsqueryThe return list — each entry is a customer return.
updateReturnmutationEdit a customer return — change its details.