Issue a receipt with its items and customer inline

POST /receipts for a caller that hasn't set up its catalogue: each line names an existing item (item_id) or defines one (item), and the buyer names an existing customer (customer_id) or defines one (customer). The items and customer are found or created together with the receipt, so a refused receipt creates none of them, and a retry with the same trader_invoice_number returns the receipt already issued. An inline item with a barcode, or customer with a buyer_tin, that already exists with a different definition returns 409 with metadata.item_id or metadata.customer_id and metadata.fields - it is never updated. Receipt validation fails exactly as POST /receipts does; a catalogue error carries metadata.line_no (1-based) or metadata.source "buyer".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

IssueReceiptInput with catalogue references or definitions in place of the free-text lines and buyer

string
enum
required

FiscalInvoice for a sale, CreditNote to reduce and DebitNote to increase an earlier fiscal invoice (both name it by one of original_receipt_id, original_invoice_number or credit_debit_note)

Allowed:
string
enum
required

ZIMRA receipts are taken in USD or ZWG

Allowed:
string
required
length between 1 and 50

Required. The invoice number from your own system (ERP or POS), sent to ZIMRA as the receipt's invoiceNo. It is the request's idempotency key - a retry with the same number returns the receipt already issued, and the same number with a different sale returns 409 - and it must be unique across the device: a number already sent for another receipt returns 409, and one in the form of a generated invoice_number (

boolean
required

Whether the line totals already include tax

lines
array of objects
required
length ≥ 1

The goods or services sold; at least one

lines*
payments
array of objects
required
length ≥ 1

How the sale was paid; at least one

payments*
int64
required

What you expect the receipt to total, in cents; a mismatch is rejected (RCPT019)

buyer
object

Set exactly one of customer_id and customer.

string
length ≤ 500

Free-text notes sent to ZIMRA with the receipt; required on a credit or debit note, to say why it was issued

string
length ≤ 128

On a credit or debit note, the id of the fiscal invoice it corrects. It must be one of yours, issued through DigiTax on the same device; 404 if there is none, 412 if it isn't a FiscalInvoice or was issued on another device. A note names its original by exactly one of original_receipt_id, original_invoice_number and credit_debit_note; an invoice names none.

string
length ≤ 50

On a credit or debit note, the fiscal invoice it corrects by its invoice number: its trader_invoice_number if it had one, otherwise its invoice_number. Checked as original_receipt_id is.

credit_debit_note
object

ZIMRA's own reference to the receipt a credit or debit note corrects, for an original that wasn't issued through DigiTax (before onboarding, or from another system): either ZIMRA's receipt_id of the original, or its receipt_global_no and fiscal_day_no. Name an original issued through DigiTax by original_receipt_id or original_invoice_number instead.

string
enum

The format the receipt is printed in - a 48-character-wide till slip or an A4 invoice. ZIMRA's default applies when omitted

Allowed:
string
length ≤ 100

Username of the cashier issuing the receipt, sent to ZIMRA

string
length ≤ 250

Full name of that cashier; defaults to user_name when only that is given

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json