Guide
Metadata
Metadata endpoints describe the API to itself. They describe available fields without processing a document. Read the live values from /api/v1/metadata/document-types and /api/v1/metadata/fields instead of hardcoding the tables below.
List document types
curl --request GET \
--url 'https://digitizer.ee/api/v1/metadata/document-types' \
--header 'X-API-Key: dig_live_xxxxxxxxxxxx'Use the OpenAPI specification for nested party, payment, and line-item definitions. Handle nullable fields and ignore additional fields you do not consume.
document
type=document · 20 fields
| Field | Type | Notes |
|---|---|---|
| document_number | string | Invoice, bill or receipt identifier. |
| issue_date | date | Document date, ISO 8601. |
| due_date | date | Payment due date. |
| currency | string | ISO 4217 currency code. |
| subtotal | number | Net of VAT. |
| vat_amount | number | Total VAT. |
| rounding | number | Rounding adjustment applied to reach the total. |
| total | number | Gross amount printed. |
| amount_due | number | Unpaid balance. |
| vat_rates | array | VAT per rate: rate, net, vat, gross. |
| vendor | object | Issuing party. |
| customer | object | Billed party. |
| line_items | array | Line item rows: description, code, ean, quantity, unit, gross unit_price, net_unit_price, discount_percent, discount_amount, subtotal, vat_rate, vat_amount, total. amount is a deprecated alias of total. |
| banks | array | Every bank printed for payment: name, iban, swift_bic. |
| account_number | string | Customer account number. |
| previous_balance | number | Balance carried forward. |
| payments_credits | number | Payments and credits applied. |
| service_address | string | Address the service applies to. |
| consumption | object | unit and value for metered documents. |
| payment | object | Payment: method, card_number, card_last4, auth_code, reference, receipt_number, amount, tendered, change. |