Sales attributes

A sale is an event where an item is exchanged for currency.

A credit note is the reversal of a sale.

Attributes table

The attributes for sales and credit notes are mostly the same. Notice that the Receipt Type code differentiates the two. Also, original_invoice_number only appears in a credit note.

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 KRA - `"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

Receipt Type Codes

Code	Code Name	Code Description
S	Sales	Sales
R	Credit Note	Credit Note (after sale)

Payment Type Codes

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

Invoice Status Codes

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