Raw schema
{
"type": "object",
"properties": {
"type": {
"description": "Document type: draft (default), estimate, order or proforma.",
"type": "string",
"enum": [
"draft",
"estimate",
"order",
"proforma"
]
},
"name": {
"description": "Document title (default generated from the number).",
"type": "string",
"minLength": 1,
"maxLength": 250
},
"client_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Existing client id (superfaktura_list_clients). Give this OR client_name."
},
"client_name": {
"description": "Name of a new/matching client (used when client_id is not given).",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"client_ico": {
"description": "Client company id (IČO), with client_name.",
"type": "string",
"maxLength": 40
},
"client_dic": {
"description": "Client tax id (DIČ), with client_name.",
"type": "string",
"maxLength": 40
},
"client_ic_dph": {
"description": "Client VAT id, with client_name.",
"type": "string",
"maxLength": 40
},
"client_address": {
"description": "Client street and number, with client_name.",
"type": "string",
"maxLength": 255
},
"client_city": {
"description": "Client city, with client_name.",
"type": "string",
"maxLength": 255
},
"client_zip": {
"description": "Client ZIP, with client_name.",
"type": "string",
"maxLength": 20
},
"client_country_id": {
"description": "Client country id (superfaktura_list_countries), with client_name.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 1000
},
"client_email": {
"description": "Client e-mail, with client_name (stored only; nothing is sent).",
"type": "string",
"maxLength": 254,
"pattern": "^[^\\s@]+@[^\\s@]+$"
},
"items": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 250,
"description": "Item name."
},
"description": {
"description": "Item description shown on the document.",
"type": "string",
"maxLength": 5000
},
"quantity": {
"description": "Quantity (default 1).",
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000000
},
"unit": {
"description": "Unit, e.g. ks, h, m.",
"type": "string",
"maxLength": 20
},
"unit_price": {
"type": "number",
"minimum": -1000000000,
"maximum": 1000000000,
"description": "Unit price WITHOUT VAT (the full price when the company is not a VAT payer)."
},
"tax": {
"description": "VAT rate in percent, e.g. 20 (use 0 when the company is not a VAT payer).",
"type": "number",
"minimum": 0,
"maximum": 100
}
},
"required": [
"name",
"unit_price"
]
},
"description": "1-100 items."
},
"created": {
"description": "Issue date (default today).",
"type": "string"
},
"delivery": {
"description": "Delivery date.",
"type": "string"
},
"due": {
"description": "Due date.",
"type": "string"
},
"invoice_currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "3-letter currency code, e.g. EUR, CZK."
},
"variable": {
"description": "Variable symbol (the document number when empty).",
"type": "string",
"maxLength": 40
},
"constant": {
"description": "Constant symbol.",
"type": "string",
"maxLength": 10
},
"specific": {
"description": "Specific symbol.",
"type": "string",
"maxLength": 20
},
"order_no": {
"description": "Order number.",
"type": "string",
"maxLength": 40
},
"sequence_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Numbering sequence id (superfaktura_list_sequences)."
},
"header_comment": {
"description": "Comment above the items (shown on the document).",
"type": "string",
"maxLength": 5000
},
"comment": {
"description": "Comment on the document.",
"type": "string",
"maxLength": 5000
},
"internal_comment": {
"description": "Internal comment (not shown on the document).",
"type": "string",
"maxLength": 5000
},
"checksum": {
"description": "Your own unique token (max 32 chars) to recover the reply if the call times out.",
"type": "string",
"pattern": "^[A-Za-z0-9._-]{1,32}$"
}
},
"required": [
"items"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}