Schema

Quote

What the order would debit as a firm order, computed as createOrder debits it: the account's plan, its volume tiers, the visual, the NFC encoding and the shipping. Euros excluding VAT, like the balance (VAT is added on the invoice).

Fields

  • currencystring: eur
  • modestring: test, production
    test with a test key: a test order debits nothing
  • totalExclVatnumber
    The amount a firm order debits, shipping included
  • shippingExclVatnumber, nullable
  • linesarray of object
    One per item, in the order of the request
  • lines[].modelIdstring
    The item's catalogue product (its productId)
  • lines[].quantityinteger
  • lines[].unitPriceExclVatnumber
  • lines[].lineTotalExclVatnumber
  • lines[].unitChargesobject
    The unit price per charge: model, printing, encoding, packaging
  • balancenumber
    The account's balance
  • enoughFundsboolean
    Whether the balance covers totalExclVat; always true in test mode
Example
{
  "currency": "eur",
  "mode": "production",
  "totalExclVat": 42.5,
  "shippingExclVat": 2.5,
  "lines": [
    {
      "modelId": "ntag213_pvccard_white",
      "quantity": 50,
      "unitPriceExclVat": 0.8,
      "lineTotalExclVat": 40,
      "unitCharges": {
        "model": 0.5,
        "printing": 0.3
      }
    }
  ],
  "balance": 30,
  "enoughFunds": true
}