Raw schema
{
"type": "object",
"properties": {
"client_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^[1-9]\\d{0,15}$"
}
],
"description": "The client id (from billomat_list_clients)."
},
"contact_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^[1-9]\\d{0,15}$"
}
],
"description": "A contact of that client."
},
"date": {
"description": "Document date (yyyy-mm-dd; today when omitted).",
"type": "string"
},
"title": {
"description": "Document title.",
"type": "string",
"maxLength": 255
},
"label": {
"description": "Label / subject.",
"type": "string",
"maxLength": 255
},
"intro": {
"description": "Introduction text.",
"type": "string",
"maxLength": 5000
},
"note": {
"description": "Closing note.",
"type": "string",
"maxLength": 5000
},
"currency_code": {
"type": "string",
"pattern": "^[A-Za-z]{3}$",
"description": "ISO currency code, e.g. EUR (account default when omitted)."
},
"net_gross": {
"description": "Whether prices are net or gross.",
"type": "string",
"enum": [
"NET",
"GROSS"
]
},
"items": {
"description": "Line items (up to 200). More can be added to the draft later.",
"maxItems": 200,
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"description": "Item title (required unless article_id is given).",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"description": "Item description.",
"type": "string",
"maxLength": 5000
},
"quantity": {
"description": "Quantity (required unless article_id is given).",
"type": "number",
"minimum": -1000000000,
"maximum": 1000000000
},
"unit": {
"description": "Unit, e.g. Stunde, Stueck, hour.",
"type": "string",
"maxLength": 100
},
"unit_price": {
"description": "Unit price, net or gross as net_gross of the document (required unless article_id is given).",
"type": "number",
"minimum": -1000000000000,
"maximum": 1000000000000
},
"tax_name": {
"description": "Tax name; with tax_rate overrides the standard tax of the account.",
"type": "string",
"maxLength": 100
},
"tax_rate": {
"description": "Tax rate in percent; the account's standard rate when omitted.",
"type": "number",
"minimum": 0,
"maximum": 100
},
"article_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^[1-9]\\d{0,15}$"
}
],
"description": "An article id (from billomat_list_articles): title, unit, price and tax missing here are taken from the article."
},
"type": {
"description": "PRODUCT or SERVICE.",
"type": "string",
"enum": [
"PRODUCT",
"SERVICE"
]
},
"optional": {
"description": "Offers only: mark the item as optional (its price is left out of the total).",
"type": "boolean"
},
"reduction": {
"description": "Discount: absolute (10) or percent (10%).",
"type": "string",
"pattern": "^\\d+(\\.\\d+)?%?$"
}
}
}
},
"due_days": {
"description": "Days until payment is due.",
"type": "integer",
"minimum": 0,
"maximum": 3650
}
},
"required": [
"client_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}