Hire is a short explanation of fields that are used for creating receipts.
This is all from POS to SDC Protocol.
Invoice Type enumeration value:
0 – Normal,
1 – Proforma,
2 – Copy,
3 – Training,
4 – Advance
Transaction Type enumeration value:
0 – Sale,
1 – Refund
Payment Type enumeration value:
0 – Other
1 – Cash
2 – Card
3 – Check
4 – Wire Transfer
5 – Voucher
6 – Mobile Money
Invoice
Field | Optional or Mandatory | Description |
---|---|---|
dateAndTimeOfIssue | Optional | Current Local Date and Time in ISO 8601 format. This is an optional element on the API level. However, tax legislation in certain jurisdictions might mandate including it on invoices – so make sure you become familiarized with the requirements in each jurisdiction. |
invoiceType | Mandatory | Invoice Type enumeration value: 0 – Normal, 1 – Proforma, 2 – Copy, 3 – Training, 4 – Advance |
transactionType | Mandatory | Transaction Type enumeration value: 0 – Sale, 1 – Refund |
payment | Mandatory | List of Payments for the invoice, where each Payment defines it’s method and amount. In cases when the cashier needs to give change to the customer, the amount submitted in the payment field must be the actual amount that stays in the cash register (not the total amount that was given by the customer to the cashier). |
cashier | Optional | Cashier’s identification. |
buyerId | Mandatory sometimes |
Mandatory in case of refund or if personalisation of receipt is needed. |
buyerCostCenterId | Mandatory sometimes |
Mandatory in case if personalisation of receipt is needed. |
invoiceNumber | Mandatory | Mandatory on all receipts. This is accreditation number given by the tax office. It is always the same on all receipts. |
referentDocumentNumber | Mandatory sometimes |
Mandatory only in case Invoice Type is Refund, Copy,Invoice from proforma or Invoice Sale connected to an Advance Sale. In all cases, this field must contain SDC Invoice Number of the previously issued invoice. In any other case this field is optional. Unicode MaxLength: 50 |
referentDocumentDT | Optional | SDC date and time (local date and time in ISO 8601 format) of the document referenced in the referentDocumentNumber field. It is used to calculate taxes on the date of issue of the original document that is refunded or copied. If it is not provided in the request, SDC uses the currently active tax rates. Always following referentDocumentNumber. |
items (n) | Mandatory | Each invoice contains at least one Item in Items collection (E-SDC should support minimum 250, recommended up to 500) |
options | Optional | Key/value collection defines the output of E-SDC invoice fiscalization, to optimize resources.
Key: omitQRCodeGen Key: omitTextualRepresentation |
Item
Each Item represents one line item on the invoice.
Field | Optional/Mandatory | Description |
---|---|---|
gtin | Optional | Global Trade Item Number (GTIN) is an identifier for trade items, incorporated the ISBN, ISSN, ISMN, IAN (which includes the European Article Number and Japanese Article Number) and some Universal Product Codes, into a universal number space.
Mandatory for accreditation |
name | Mandatory | Human-readable name of the product or service. |
quantity | Mandatory | The quantity of an item, with a maximum of 3 decimals. Example: 2 (pieces), 0.100 (grams). |
unitPrice | Mandatory | Unit price of the line item. It does not take part in tax calculation. |
labels | Mandatory | The array of labels. Each Label represents one of the Tax Rates applied on the invoice item. Tax Items are calculated based on totalAmount and applied labels as described in the Calculate Taxes section. This field is mandatory (i.e. the caller must submit a non-empty collection) for each item, even when the price is 0.00. |
totalAmount | Mandatory | Gross price for the line item. |
Payment
Field | Optional/Mandatory | Description |
---|---|---|
amount | Mandatory | Decimal amount of the payment |
paymentType | Mandatory | Payment Type enumeration value: 0 – Other, 1 – Cash, 2 – Card, 3 – Check, 4 – Wire Transfer, 5 – Voucher, 6 – Mobile Money |