Skip to content

Invoice

codestringrequired

variant code (product)

Example:"2015000001"
isValidbooleanrequired

is the invoice valid?

Example:true
proformaInvoiceCodesArray of strings(proformaInvoiceCodes)required

List of linked proforma invoices

orderCodestring or nullrequired

purchase order number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.

Example:"2017000017"
internalOrderNumberstring or nullrequired

Custom identifier for this order used for internal accounting or matching, distinct from externalCode, which identifies the order in an external system.

Example:"INT-2026-042"
creationTimestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date of issue, in ISO 8601 format

Example:"2018-05-29T09:02:27+0200"
changeTimestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date of change, in ISO 8601 format

Example:"2018-05-29T09:02:27+0200"
dueDatestring or null, (date)(typeDateNullable)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

due date in ISO 8601 format

Example:"2017-04-04"
taxDatestring or null, (date)(typeDateNullable)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

taxation date in ISO 8601 format

Example:"2017-04-04"
varSymbolinteger, [ 0 .. 9999999999 ](typeVarSymbol)required

variable symbol

Example:2021000021
constSymbolstring or null(typeConstSymbolNullable)^[0-9]{1,4}$required

constant symbol

Example:"0308"
specSymbolinteger or null, [ 0 .. 9999999999 ](typeSpecSymbolNullable)required

specific symbol

Example:201323134
weightstring or null(typeWeightUnlimited)^[0-9]+\.[0-9]{3}$required

weight in kg, unpacked. 3 decimal places.

Example:"1.234"
completePackageWeightstring or null(typeWeightUnlimited)^[0-9]+\.[0-9]{3}$required

total weight of package in kg. 3 decimal places.

Example:"1.234"
billingMethodbillingMethod (object) or nullrequired
One of:

information about the method of payment

billingAddressobject(billingAddress)required

invoicing address

deliveryAddressobject or null(address)required
addressesEqualbooleanrequired

are the billing and delivery addresses the same?

Example:true
priceobject(price)required
customerobject(documentCustomer)required
eshopobject(eshop)required
itemsArray of objects(invoiceItem)required

content of the invoice

documentRemarkstring or nullrequired

remark for the document

Example:"remark"
vatPayerbooleanrequired

is the e-shop a VAT payer?

vatModestring or null

VAT mode, can be null, possible values: Normal, One Stop Shop, Mini One Stop Shop, Reverse charge, Outside the EU

Example:"Normal"
proofPaymentsArray of objects(proofPaymentsForInvoice)

List of linked proof payments

paidboolean or nullrequired

flag, whether the invoice was paid. In addition to true a false, can also be null, if the payment status is unknown.

Example:true
{
  "code": "2015000001",
  "isValid": true,
  "proformaInvoiceCodes": [
    "2015000170"
  ],
  "orderCode": "2017000017",
  "internalOrderNumber": "INT-2026-042",
  "creationTime": "2018-05-29T09:02:27+0200",
  "changeTime": "2018-05-29T09:02:27+0200",
  "dueDate": "2017-04-04",
  "taxDate": "2017-04-04",
  "varSymbol": 2021000021,
  "constSymbol": "0308",
  "specSymbol": 201323134,
  "weight": "1.234",
  "completePackageWeight": "1.234",
  "billingMethod": {
    "id": 3,
    "name": "Cash"
  },
  "billingAddress": {
    "company": "Shoptet s.r.o.",
    "fullName": "John Doe",
    "street": "French",
    "houseNumber": "123",
    "city": "Praha 2",
    "district": "Praha 2",
    "additional": "4. floor",
    "zip": "120 00",
    "countryCode": "CZ",
    "regionName": "Capital city",
    "regionShortcut": "CC",
    "companyId": "12345678",
    "vatId": "CZ289324675",
    "vatIdValidationStatus": "verified",
    "taxId": "CZ289324675"
  },
  "deliveryAddress": {
    "company": "Shoptet s.r.o.",
    "fullName": "John Doe",
    "street": "French",
    "houseNumber": "123",
    "city": "Praha 2",
    "district": "Praha 2",
    "additional": "4. floor",
    "zip": "120 00",
    "countryCode": "CZ",
    "regionName": "Capital city",
    "regionShortcut": "CC"
  },
  "addressesEqual": true,
  "price": {
    "vat": "42.00",
    "toPay": "242.00",
    "currencyCode": "CZK",
    "withoutVat": "200.00",
    "withVat": "242.00",
    "exchangeRate": "1.04568087",
    "invoicingExchangeRate": "1.04568087",
    "partialPaymentAmount": "100.00",
    "partialPaymentType": "percents"
  },
  "customer": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "phone": "603481066",
    "email": "example@example.com",
    "remark": "This is a remark"
  },
  "eshop": {
    "bankAccount": "123456789/1234",
    "iban": "CZ6508000000192000145399",
    "bic": "CNBACZPPXXX",
    "vatPayer": true
  },
  "items": [
    { … }
  ],
  "documentRemark": "remark",
  "vatPayer": true,
  "vatMode": "Normal",
  "proofPayments": [
    { … }
  ],
  "paid": true
}