A sale is an event where an item is exchanged for currency.
A credit note is the reversal of a sale.
A debit note is an adjustment to an invoice already processed. This could be to either increase or reduce the price
📘
Sales and Credit notes share the same API endpoint
The attributes for sales and credit notes are mostly the same with the following difference:
- The Receipt Type code of a sale is "S" , a debit note is "D" and that of a credit note is "R"
- The original_invoice_number is required in a credit note to tie it to the original sale to which the credit note is being created against.
| Attribute ID | Required | Data Type | Description - Sample (JSON) |
|---|
| sale_id (id) | (For GET (single sale), PUT and DELETE) | string | sale_id represents the UUID (Sale ID) as generated by Digitax- "PFHol0bfkZ" |
| trader_invoice_number | Yes | string | Represents the Trader Invoice Number - "12345678901" |
| original_invoice_number | Only for credit note | string | Represents the Trader Invoice Number used during the sale that this credit note seeks to reverse - "12345678901" |
| invoice_number | Yes | number | Represents the Invoice Number - 1234567890 |
| receipt_type_code | Yes | string | Represents the Receipt Type Code. See Receipt Type Codes table for context - "S" |
| payment_type_code | No | string | Represents the Payment Type Code. See Payment Type Codes table - "01" |
| invoice_status_code | Yes | string | Represents the Invoice Status Code. See Invoice Status Codes table - "01" |
| items | Yes | array of objects | Represents an Array of Item Objects |
| Code | Code Name | Code Description |
|---|
| S | Sales | Sales |
| R | Credit Note | Credit Note (after making a sale) |
| D | Debit Note | Debit Note (after making a sale) |
| Code | Code Name | Code Description |
|---|
| 01 | CASH | CASH |
| 02 | CREDIT | CREDIT |
| 03 | CASH/CREDIT | CASH/CREDIT |
| 04 | BANK CHECK | BANK CHECK PAYMENT |
| 05 | DEBIT&CREDIT CARD | PAYMENT USING CARD |
| 06 | MOBILE MONEY | ANY TRANSACTION USING MOBILE MONEY SYSTEM |
| 07 | OTHER | OTHER MEANS OF PAYMENT |
| Code | Code Name | Code Description |
|---|
| 01 | Wait for Approval | Wait for Approval |
| 02 | Approved | Approved |
| 03 | Cancel Requested | Cancel Requested |
| 04 | Canceled | Canceled |
| 05 | "Credit Note Generated" | Credit Note Generated |
| 06 | Transferred | Transferred |
| Code | Code Name |
|---|
| ZMW | Zambian kwacha |
| USD | United States dollar |
| ZAR | South African rand |
| GBP | Pound sterling |
| CNY | Chinese yuan |
| EUR | Euro |
| Code | Code Name |
|---|
| AC | ASCENSION ISLAND |
| AD | ANDOZRA |
| AE | UNITED ARAB EMIRATES |
| AG | ANTIGUAAND BARBUDA |
| AI | ANGUILLA |
| AL | ALBANIA |
| AM | ARMENIA |
| AN | NETHERLANDS ANTILLES |
| AO | ANGOLA |
| AQ | ANTARCTICA |
| AR | ARGENTINA |
| AS | AMERICAN SAMOA |
| ZM | ZAMBIA |
| Code | Code Name |
|---|
| 01 | WRONG PRODUCT |
| 02 | WRONG PRICE |
| 03 | DAMAGED GOODS |
| 04 | WRONG CUSTOMER INVOICED |
| 05 | DUPLICATED INVOICE |
| 06 | EXCESS SUPPLIES |
| 07 | Other |
| Code | Code Name |
|---|
| 01 | Wrong quantity invoiced |
| 02 | Wrong invoice amount |
| 03 | Omitted item |
| 04 | Other [specify] |
