Full Refund

This is a short action to cancel the document or receipt quickly with the same amount and details like the original production.

Methods -

Document.Cancel

Receipt.Cancel

Send the document/receipt type and number accordingly in order to cancel them automatically -

This action will produce a new document/receipt as a refund.

📘
The system will automatically add a comment to refund document/receipt with the cancelled document/receipt type and number.

Cancel a Document 'Invoice Receipt'

In this document type the cancel will be with both methods separately.

Document.Cancel - To refund the invoice part

Send in request parameters:

'document_type = 2'

'document_number'

Send the 'Receipt Invoice' number to refund.

The automatic document produced as a refund will be type 3 - Credit Tax Invoice (by system default)

Document.Cancel of Invoice Receipt example

Request
{
  "api_token": "A73530CF-19A4-4085-8C0D-75506DD6EDFE",
  "document_type": 2,
  "document_number": 6923
}

Invoice will be shown as follows:

Receipt.Cancel - To refund the receipt part

Send in request parameters:

'receipt_type = 2'

'receipt_number'

Send the 'Receipt Invoice' number to refund (will be same as in Document.Cancel).

Receipt.Cancel of Invoice Receipt example

Request
{
  "api_token": "A73530CF-19A4-4085-8C0D-75506DD6EDFE",
  "receipt_type": 2,
  "receipt_number": 6923
}

Receipt will be shown as follows:

Partial or Custom Refund

In order to make a partial refund or change the original document/receipt in the refund there is a need to produce a new document/receipt.

Methods -

Document.New

Receipt.New

This are the ground rules:

To create the document/receipt as a refund send a negative amount (with -) on the items/payments array.
To create an invoice refund use document type 3 - Invoice Refund (by system default).
To create a refund of receipt use receipt type 1 (same type as a regular receipt).
In case of cancelling a document type "Invoice Receipt", send both methods Document.New and Receipt.New in order to create a refund for both parts.
It is recommended to send a comment with the details of the document/receipt that is refunded in order to make a link between the two.