Create a ZIMRA Debit Note

Issues a DebitNote increasing an earlier fiscal invoice, exactly as POST /credit-notes issues a credit note, except that its amounts are positive both in the request and as ZIMRA holds them. List debit notes with GET /receipts?receipt_type=DebitNote.

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

A credit or debit note on an earlier fiscal invoice. It names the invoice by exactly one of original_receipt_id, original_invoice_number and credit_debit_note. Lines name items from your catalogue and the buyer a customer, both by id. Every amount is positive integer cents and every quantity thousandths; a credit note's lines, payments and total are sent to ZIMRA negative. The totals are checked against what DigiTax computes - a mismatch is rejected, never corrected.

string
required
length between 1 and 50

Your reference for the note itself (not the original's), sent to ZIMRA as its invoiceNo, and the request's idempotency key: a retry with the same number returns the note already issued, and the same number with a different note returns 409. It must be unique across the device (RCPT013) - a number already sent for another receipt returns 409.

string
length ≤ 128
^receipt_

The id of the fiscal invoice the note corrects; the preferred way to name it. 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.

string
length ≤ 50

The fiscal invoice the note corrects, by its invoice number: its trader_invoice_number, or its invoice_number if it had none. 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
required
length between 1 and 500

Why the note was issued, sent to ZIMRA (RCPT034)

string
enum
required

ZIMRA receipts are taken in USD or ZWG

Allowed:
boolean
required

Whether the line totals already include tax

lines
array of objects
required
length between 1 and 1000

The goods or services credited or debited; at least one

lines*
payments
array of objects
required
length between 1 and 100

How the amount was refunded (credit note) or paid (debit note); at least one

payments*
int64
required
≥ 0

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

string
length ≤ 128
^customer_

The buyer: an active customer from POST /customers. Omit it for an anonymous buyer. 404 if there is no such customer, 412 if it is inactive.

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 note, 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