Idoklad

Helpers that unwrap the SDK's envelope, returning the payload on success and translating failures into .

Builds instances from resolved per-request credentials, using the official iDoklad .NET SDK (IdokladSdk) and an -managed . This is the iDoklad analogue of microsoft-365-service's graph_client.

Scoped accessor that resolves the credentials for the current request and lazily builds a single shared by all services handling that request.

Raised when an upstream iDoklad API call does not succeed. Carries the upstream HTTP status code, message and iDoklad error code so the failure can be surfaced to the caller.

Generic helpers over the SDK's list/detail request builders so the read endpoints of the many agendas can be expressed in a single line. The concrete payload type is inferred by the SDK and returned boxed (full data is preserved at runtime; only the Swagger schema is generic).

Service configuration resolved from environment variables. Mirrors the structure used by the sibling microsoft-365-service (config.py): non-secret configuration and credential defaults live in environment variables. Per-request callers can override the credential values through request headers (see ).

Default iDoklad OAuth2 client id (client credentials flow).

Default iDoklad OAuth2 client secret (client credentials flow).

Default iDoklad application id from the developer portal (required by client credentials flow).

Optional custom iDoklad API base url (defaults to the SDK production url when empty).

Optional custom Identity Server token url (defaults to the SDK production url when empty).

Default response language for the iDoklad API (Cz, Sk, En). Defaults to Cz.

True when both custom urls are configured (e.g. for a sandbox environment).

True when the default credential triplet is fully configured via environment variables.

Account agenda: the current agenda (company) and current user. Requires iDoklad credentials (headers or environment defaults).

Get information about the current agenda (company).

Get information about the current user.

Price list items, stock movements and tags. Requires iDoklad credentials (headers or environment defaults).

List price list items (paged).

Get a pre-filled default model for creating a new price list item.

Get a price list item detail by id.

Create a new price list item.

Update an existing price list item (the model id identifies the item).

List stock movements (paged).

Get a pre-filled default stock movement model for the given price list item id.

Get a stock movement detail by id.

Create a new stock movement.

Update an existing stock movement (the model id identifies the movement).

Delete a stock movement by id.

List tags (paged).

Create a new tag.

Update an existing tag (the model id identifies the tag).

Delete a tag by id.

Read-only iDoklad code lists / registers. Requires iDoklad credentials (headers or environment defaults).

List banks (paged).

Get a bank detail by id.

List countries (paged).

Get a country detail by id.

List currencies (paged).

Get a currency detail by id.

List constant symbols (paged).

Get a constant symbol detail by id.

List exchange rates (paged).

Get an exchange rate detail by id.

List payment options (paged).

Get a payment option detail by id.

List VAT codes (paged).

Get a VAT code detail by id.

List VAT reverse-charge codes (paged).

Get a VAT reverse-charge code detail by id.

List sales offices (paged).

Get a sales office detail by id.

List sales POS equipment (paged).

Get a sales POS equipment detail by id.

Contacts (customers/suppliers) agenda. All endpoints require iDoklad credentials. Provide them as request headers (X-ClientId, X-ClientSecret, X-ApplicationId) or rely on the service environment defaults. See the Swagger description for details.

List contacts (paged).

Get a contact detail by id.

Get a pre-filled default contact model for creating a new contact.

Create a new contact.

Update an existing contact (the model id identifies the contact).

Delete a contact by id.

Integration / utility agendas: webhooks, notifications, change log, registered sales, unpaired documents, attachments and system code books. Requires iDoklad credentials.

List configured webhooks (paged).

Get a webhook detail by id.

Create (register) a new webhook subscription.

Delete a webhook by id.

List notifications (paged).

Delete (dismiss) a notification by id.

List the agenda change log (paged).

List registered sales / EET records (paged).

Get a pre-filled default model for creating a new registered sale.

List unpaired documents for a movement type and pairing document type.

Get a single attachment by its id.

Get all attachments of a document.

Upload an attachment for a document.

Delete a single attachment by its id.

Delete all attachments of a document.

Get the iDoklad system code books.

Get changes to the code books since the given timestamp.

Issued (outgoing) invoices agenda. Requires iDoklad credentials (headers or environment defaults).

List issued invoices (paged).

Get an issued invoice detail by id.

Get a pre-filled default model for creating a new issued invoice.

Create a new issued invoice.

Update an existing issued invoice (the model id identifies the invoice).

Create a copy (draft) of an existing issued invoice.

Delete an issued invoice by id.

Service metadata endpoints. These do not require iDoklad credentials.

Liveness probe.

Service name, version and language.

Reports whether the service has default iDoklad credentials configured through environment variables. Per-request callers can always override them with headers.

Bank statements and document payments. Requires iDoklad credentials (headers or environment defaults).

List bank statements (paged).

Get a bank statement detail by id.

Create a new bank statement.

Update an existing bank statement (the model id identifies the statement).

Delete a bank statement by id.

List issued document payments (paged).

Get a pre-filled default issued payment model for the given issued invoice id.

Get an issued document payment detail by id.

Create (register) a new payment for an issued document.

Delete an issued document payment by id.

Fully unpay an issued invoice (removes all its payments).

List received document payments (paged).

Get a pre-filled default received payment model for the given received invoice id.

Get a received document payment detail by id.

Create (register) a new payment for a received document.

Delete a received document payment by id.

Fully unpay a received invoice (removes all its payments).

Received receipts and cash agendas. Requires iDoklad credentials (headers or environment defaults).

List received receipts (paged).

Get a pre-filled default model for creating a new received receipt.

Get a received receipt detail by id.

Create a new received receipt.

Update an existing received receipt (the model id identifies the document).

Delete a received receipt by id.

List cash vouchers (paged).

Get a cash voucher detail by id.

Create a new cash voucher.

Update an existing cash voucher (the model id identifies the document).

Delete a cash voucher by id.

List cash registers (paged).

Get a cash register detail by id.

Create a new cash register.

Update an existing cash register (the model id identifies the register).

Delete a cash register by id.

Received (incoming) invoices agenda. Requires iDoklad credentials (headers or environment defaults).

List received invoices (paged).

Get a received invoice detail by id.

Get a pre-filled default model for creating a new received invoice.

Create a new received invoice.

Update an existing received invoice (the model id identifies the invoice).

Delete a received invoice by id.

Supporting registers: bank accounts, VAT rates and numeric sequences. Requires iDoklad credentials (headers or environment defaults).

List bank accounts (paged).

Get a bank account detail by id.

Create a new bank account.

Update an existing bank account (the model id identifies the account).

Delete a bank account by id.

List VAT rates (paged).

Get a VAT rate detail by id.

List numeric (document) sequences (paged).

Sales-side documents. Requires iDoklad credentials (headers or environment defaults).

List proforma invoices (paged).

Get a pre-filled default model for creating a new proforma invoice.

Get a proforma invoice detail by id.

Create a new proforma invoice.

Update an existing proforma invoice (the model id identifies the document).

Create a copy (draft) of an existing proforma invoice.

Delete a proforma invoice by id.

List credit notes (paged).

Get a pre-filled default credit note model for the given (issued) invoice id.

Get a credit note detail by id.

Create a new credit note.

Update an existing credit note (the model id identifies the document).

Delete a credit note by id.

List sales receipts (paged).

Get a pre-filled default model for creating a new sales receipt.

Get a sales receipt detail by id.

Create a new sales receipt.

Update an existing sales receipt (the model id identifies the document).

Create a copy (draft) of an existing sales receipt.

Delete a sales receipt by id.

List sales orders (paged).

Get a pre-filled default model for creating a new sales order.

Get a sales order detail by id.

Create a new sales order.

Update an existing sales order (the model id identifies the document).

Create a copy (draft) of an existing sales order.

Delete a sales order by id.

List recurring invoices (paged).

Get a pre-filled default model for creating a new recurring invoice.

Get a recurring invoice detail by id.

Create a new recurring invoice template.

Update an existing recurring invoice (the model id identifies the template).

Create a copy (draft) of an existing recurring invoice.

Delete a recurring invoice by id.

List issued tax documents (paged).

Get a pre-filled default tax document model for the given advance (proforma) invoice id.

Get an issued tax document detail by id.

Create a new issued tax document.

Update an existing issued tax document (the model id identifies the document).

Delete an issued tax document by id.

List issued document templates (paged).

Get a pre-filled default model for creating a new issued document template.

Get an issued document template detail by id.

Create a new issued document template.

Update an existing issued document template (the model id identifies the template).

Delete an issued document template by id.

Agenda statistics and summaries. Requires iDoklad credentials.

Invoicing totals for a relative period (e.g. LastSevenDays, ThisMonth).

Invoicing totals for a relative year (e.g. ThisYear, LastYear).

Invoicing summary broken down by quarter.

Top partners by turnover (optionally limited by count).

Overall agenda summary (totals and key figures).

Statistics for a single contact by id.

Receivables broken down by debt age intervals.

Top debtors by outstanding amount (optionally limited by count).

Progress of the agenda towards the VAT-payer registration threshold.

Names of the HTTP headers that carry per-request iDoklad credentials. Secrets are never accepted in the query string or request body: they are required in request headers (and documented as such in Swagger). Each header carries the credential value directly and must therefore only be sent over TLS.

Header carrying the response language override (Cz, Sk, En).

Fully resolved set of credentials and request options used to build a DokladApi instance for a single request.

Raised when the request does not provide a complete set of iDoklad credentials, neither through request headers nor through the service environment defaults.

Resolves the iDoklad credentials for the current request. Mirrors get_request_settings from the sibling microsoft-365-service: each credential value is taken from its request header when present and otherwise falls back to the environment-configured default. Secrets are only ever read from headers (never query/body). If, after applying the fallbacks, any required value is still missing, the request is rejected.

Documents the per-request credential headers in Swagger for every operation that talks to iDoklad. The headers are marked optional because the service can fall back to environment defaults, but the description makes the requirement and secret handling explicit.

Translates domain exceptions into JSON responses: missing credentials become 401, and upstream iDoklad failures surface the upstream status.

Account agenda: information about the current agenda and the current user.

Catalog and stock agendas: price list items, stock movements and tags.

Read-only iDoklad code lists (registers): banks, countries, currencies, constant symbols, exchange rates, payment options, VAT codes, VAT reverse-charge codes, sales offices and sales POS equipment. Every agenda supports list + detail.

Contacts (customers/suppliers) agenda.

Integration / utility agendas: webhooks, notifications, change log, registered sales (EET), unpaired documents, attachments and the system code books.

Issued (outgoing) invoices agenda.

Payments and bank statements: bank statements, issued document payments and received document payments.

Purchase-side receipts and cash agendas: received receipts, received documents (read-only), cash vouchers and cash registers.

Received (incoming) invoices agenda.

Supporting registers: bank accounts, VAT rates and numeric (document) sequences.

Sales-side documents: proforma invoices, credit notes, sales receipts, sales orders, recurring invoices, issued tax documents and issued document templates.

Agenda statistics and summaries.