Create an item

Returns 409 if another of the business's items has the same barcode.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 200

The goods or service, as printed on receipt lines

string
length ≤ 8

Harmonized System code, 4 or 8 digits. Whether it is required depends on whether the business is VAT-registered, which GET /fdms-info shows as a non-empty vat_number. For a VAT-registered business it is required (rule RCPT047), and must be 8 digits when tax_rate is 0 (RCPT048), as FDMS requires on the receipt lines the item is sold on. For a business that isn't VAT-registered, including one whose device isn't registered yet, it is optional. A code that breaks the rules returns 400 with metadata.argument hs_code and the rule in metadata.rule. See GET /resources/hs-codes for the 4-digit headings; the code is checked for its format only, not against that list.

int32
required
≥ 1

One of the device's tax_id values from GET /resources/tax-categories, valid today. Any other returns 400 with metadata.argument tax_id. Not checked before the device is registered and has its taxes; on an update, only when the tax changes. Tax IDs are specific to each device - ZIMRA assigns them in the device's configuration - so read them from that endpoint instead of hard-coding them (the 517 of this example is the test device's standard 15.5% rate).

string
length ≤ 3

The taxCode of that tax, if it has one

double
required
0 to 1

The tax's rate as a decimal, at most 6 decimal places (0.15 for 15%). It must be that tax's tax_percent (0 for an exempt tax); a different rate returns 400 with metadata.argument tax_rate and the expected rate in metadata.tax_rate.

double
required
0 to 1000000000000

Unit price in major units, at most 2 decimal places

string
enum
required

ZIMRA receipts are taken in USD or ZWG

Allowed:
string
length ≤ 50

UN/ECE Recommendation 20 unit code, e.g. H87 (piece), KGM (kilogram) or LTR (litre). Display only - ZIMRA does not receive it.

string
length ≤ 100

The item's barcode; unique among your items when set

metadata
object

Your own key-value pairs. Only applied on create; ignored by PUT

Responses

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