API reference · Schema

V1OrderReceipt

V1OrderReceiptcontract v1.order.receipt

order_idUuid7required
kindenum (2)required
tax_invoicerecord
titlestringrequired
operatorstring | nullrequired
sellerobjectrequired
- namestringrequired
- addressstringrequired
tax_idsarray of objectrequired
- codestringrequired
- labelstringrequired
- valuestringrequired
numberstringrequired
min length 1
datestringrequired
min length 1
currencystringrequired
pattern ^[A-Z]{3}$
linesarray of objectrequired
- line_nointegerrequired
  ≥ 1≤ 9007199254740991
- item_idUuid7required
- name_keystringrequired
  pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- qty_milliintegerrequired
  > 0≤ 9007199254740991
- unit_price_minorintegerrequired
  ≥ -9007199254740991≤ 9007199254740991
- amount_minorintegerrequired
  ≥ -9007199254740991≤ 9007199254740991
- discount_minorintegerrequired
  ≥ -9007199254740991≤ 9007199254740991
- net_minorintegerrequired
  ≥ -9007199254740991≤ 9007199254740991
- tax_minorintegerrequired
  ≥ -9007199254740991≤ 9007199254740991
- total_minorintegerrequired
  ≥ -9007199254740991≤ 9007199254740991
- tax_classstringrequired
  pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- componentsarray of objectrequired
  - codestringrequired
    min length 1max length 20
  - rate_bpintegerrequired
    ≥ 0≤ 9007199254740991
  - amount_minorintegerrequired
    ≥ -9007199254740991≤ 9007199254740991
net_minorintegerrequired
≥ -9007199254740991≤ 9007199254740991
tax_minorintegerrequired
≥ -9007199254740991≤ 9007199254740991
total_minorintegerrequired
≥ -9007199254740991≤ 9007199254740991
componentsarray of objectrequired
- codestringrequired
  min length 1max length 20
- rate_bpintegerrequired
  ≥ 0≤ 9007199254740991
- amount_minorintegerrequired
  ≥ -9007199254740991≤ 9007199254740991

Used by

get/v1/orders/{id}/receiptThe bill per the country pack (tax invoice, or a Sec 9(5) record-only receipt)