Create a return
Create a RETURN transaction linked to an existing invoice to receive credit against a future tax liability. The resulting RETURN transaction will have negative line amounts and will be properly linked to the original sale.
Examples
Full Return
Partial Return
Partial Return with Custom Price
How It Works
This endpoint creates a RETURN transaction linked to the original sale transaction specified by parent-transaction-id
. The system ensures that all returned line items have negative amounts and are properly linked to the original transaction for tax accounting purposes.
The return can be either FULL (returning the entire original transaction) or PARTIAL (returning specific line items). For partial returns, you must specify which line items to return using their line IDs from the original transaction.
The system will:
- Validate that the original transaction exists and is accessible
- Create a new RETURN transaction with appropriate negative amounts
- Link the return to the original sale via parent_invoice_id
- Apply the tax credit in the appropriate jurisdiction
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique identifier of the transaction to generate a return for.
Body
Response
Transaction creation response
The response is of type object
.