vporiadku API 1.3.0

GET /ping

Check a key or an access token: its workspace, plan and scopes #

Needs no scope, so any valid key can be tested with it.

Required scope: none (any valid key).

Responses

GET /invoices

List documents (invoices and every other document type) #

Every document type (invoices, proformas, credit notes, quotes, …), each with its lines, client and bank account. Filters combine: type, status, payment state (overdue tests the due date, not just the status), client, a date range on the issue, supply or due date (dateType), a named period, number range, tags, currency, free text over the number and the client name, and updatedSince for an incremental sync. Newest first by the filtered date unless sortBy says otherwise; ties are broken by creation time and id, so paging never repeats or skips a row.

Required scope: invoices:read.

Parameters

Responses

POST /invoices

Create a document #

Totals sent by the client are accepted but ignored: the server always recomputes them. A document posted with a live status (e.g. issued) is issued in the same request. Leave invoiceNumber out to take the next number of the series. A foreign currency needs a plan that includes it; quotes, delivery notes and orders need the commercial-documents feature.

Required scope: invoices:write.

Parameters

Request body

CreateInvoice

Responses

GET /invoices/{id}

Get one document with its lines and client #

Required scope: invoices:read.

Parameters

Responses

PATCH /invoices/{id}

Update a document that is still editable #

An issued document is locked: only its lifecycle flags can still change, and a correction is a credit note. Send only the fields to change.

Required scope: invoices:write.

Parameters

Request body

UpdateInvoice

Responses

DELETE /invoices/{id}

Delete a draft that has no payments (it goes to the recycle bin) #

Only a draft with no payment recorded can be deleted; it goes to the recycle bin for 30 days. An issued document is voided with cancel.

Required scope: invoices:write.

Parameters

Responses

GET /invoices/{id}/pdf

Download a document as the PDF its customer receives #

The same renderer the dashboard and the customer portal use: what you archive is what the customer received.

Required scope: invoices:read.

Parameters

Responses

GET /invoices/{id}/isdoc

Download a document as ISDOC 6.0.1 XML for accounting software #

ISDOC 6.0.1, the XML Czech and Slovak accounting software imports. Quotes, orders and delivery notes are not accounting documents and have no ISDOC form (409 DOCUMENT_NOT_EXPORTABLE). Needs the accounting-export feature of the plan, as the export in the dashboard does.

Required scope: invoices:read.

Parameters

Responses

GET /invoices/{id}/ubl

Download an issued invoice as Peppol BIS Billing 3.0 UBL XML #

The Peppol BIS Billing 3.0 (EN 16931) UBL 2.1 XML an e-invoice carries, after the same validation a send runs: a document that would be refused answers 422 with what is missing. Needs the e-Faktúra module.

Required scope: invoices:read.

Parameters

Responses

POST /invoices/{id}/issue

Issue a draft: fix its number and lock its content #

Keeps the number the draft was given from its series when it was created (or sets number when given), freezes the content and marks the document issued. Issuing an issued document changes nothing.

Required scope: invoices:write.

Parameters

Request body (optional)

IssueInvoice

Responses

POST /invoices/{id}/duplicate

Copy a document into a new draft with today's dates and the next number #

The copy is a new draft dated today (its due date and validity keep their distance from the issue date, a supply date becomes today), numbered from its series, with the client, lines, currency and texts of the original and a link back to it (sourceDocumentId). Payments do not carry over. A storno or a tax document of a payment cannot be copied (422). Counted against the plan like any new document.

Required scope: invoices:write.

Parameters

Responses

POST /invoices/{id}/send

E-mail an issued document to its client with the PDF attached #

E-mails the document to the client's address with the PDF attached, from the workspace's own SMTP when it has one. The client must have an e-mail address; a draft is refused.

Required scope: invoices:write.

Parameters

Responses

POST /invoices/{id}/reminder

E-mail a payment reminder for an unpaid document #

Only for a document that asks for payment and still has something outstanding.

Required scope: invoices:write.

Parameters

Responses

POST /invoices/{id}/credit-note

Issue a credit note (dobropis) against an invoice #

Without items the whole invoice is credited; with items only those lines, given with positive amounts (the server negates them). The credit note is linked back to the invoice and may not exceed what is left of it.

Required scope: invoices:write.

Parameters

Request body (optional)

CreateCreditNote

Responses

POST /invoices/{id}/cancel

Void an issued document with a cancellation (storno) document #

Raises a cancellation (storno) document against the issued document and marks it cancelled. Nothing is deleted.

Required scope: invoices:write.

Parameters

Request body (optional)

CancelInvoice

Responses

GET /invoices/{id}/payments

List the payments recorded on a document #

Required scope: payments:read.

Parameters

Responses

POST /invoices/{id}/payments

Record a payment; once the document is covered it becomes paid #

Moves the document to partially paid or paid, raises the tax document of a payment on an advance invoice, fires payment.recorded and sends the thank-you e-mail when the workspace has it on. An amount over what is outstanding is refused unless allowOverpayment is true.

Required scope: payments:write.

Parameters

Request body

CreatePayment

Responses

POST /invoices/{id}/mark-paid

Settle a document in full: record what is still outstanding as one payment #

Records what is still outstanding as one payment, like the dashboard's "mark as paid". With nothing outstanding only the status moves. A draft cannot be settled; an already paid document answers 409.

Required scope: payments:write.

Parameters

Request body (optional)

MarkInvoicePaid

Responses

DELETE /payments/{id}

Delete a recorded payment; the document status follows #

The document's status is recomputed from the payments that remain.

Required scope: payments:write.

Parameters

Responses

GET /clients

List clients #

Newest first unless sortBy says otherwise; ties are broken by id, so paging never repeats or skips a client. updatedSince returns only clients changed since then, for an incremental sync.

Required scope: clients:read.

Parameters

Responses

POST /clients

Create a client #

Refused with 409 CLIENT_DUPLICATE_SUSPECTED when the directory already holds a client that looks the same, unless allowDuplicate=true. The Start plan is limited to 5 clients (403 PLAN_LIMIT_REACHED).

Required scope: clients:write.

Parameters

Request body

CreateClient

Responses

GET /clients/{id}

Get one client #

Required scope: clients:read.

Parameters

Responses

PATCH /clients/{id}

Update a client #

Required scope: clients:write.

Parameters

Request body

UpdateClient

Responses

DELETE /clients/{id}

Delete a client no document names (it goes to the recycle bin) #

A client named by any document cannot be deleted (409).

Required scope: clients:write.

Parameters

Responses

GET /items

List catalogue items #

Needs the item catalogue feature of the Profi plan.

Required scope: items:read.

Parameters

Responses

POST /items

Create a catalogue item #

Required scope: items:write.

Parameters

Request body

CreateItem

Responses

GET /items/{id}

Get one catalogue item #

Required scope: items:read.

Parameters

Responses

PATCH /items/{id}

Update a catalogue item #

Required scope: items:write.

Parameters

Request body

UpdateItem

Responses

DELETE /items/{id}

Delete a catalogue item (it goes to the recycle bin) #

The item goes to the recycle bin for 30 days.

Required scope: items:write.

Parameters

Responses

GET /expenses

List expenses (received documents) #

Needs the expenses feature of the Profi plan.

Required scope: expenses:read.

Parameters

Responses

POST /expenses

Book an expense #

A second document with the same supplier and number is refused (409) unless allowDuplicate=true.

Required scope: expenses:write.

Parameters

Request body

CreateExpense

Responses

GET /expenses/{id}

Get one expense #

Required scope: expenses:read.

Parameters

Responses

PATCH /expenses/{id}

Update an expense #

Required scope: expenses:write.

Parameters

Request body

UpdateExpense

Responses

DELETE /expenses/{id}

Delete an expense (it goes to the recycle bin) #

The expense goes to the recycle bin for 30 days.

Required scope: expenses:write.

Parameters

Responses

GET /received-invoices

List received e-invoices (the e-Faktúra inbox) #

Reading does not mark a document read; only a person opening it in the dashboard does.

Required scope: received_invoices:read.

Parameters

Responses

GET /received-invoices/{id}

Get one received e-invoice with its lines #

Required scope: received_invoices:read.

Parameters

Responses

GET /received-invoices/{id}/xml

Get the archived original UBL XML of a received e-invoice #

The legal document: the archived original, byte for byte, with its SHA-256.

Required scope: received_invoices:read.

Parameters

Responses

GET /recurring-invoices

List recurring invoice schedules #

Required scope: recurring_invoices:read.

Parameters

Responses

GET /recurring-invoices/{id}

Get one schedule with its recent runs #

Required scope: recurring_invoices:read.

Parameters

Responses

GET /companies

List the issuer company profiles of the workspace #

Required scope: company:read.

Parameters

Responses

GET /bank-accounts

List the bank accounts the workspace is paid into #

Name one in bankAccountId when creating a document to have it paid into an account other than the primary one.

Required scope: bank_accounts:read.

Parameters

Responses

GET /bank-accounts/{id}

Get one bank account #

Required scope: bank_accounts:read.

Parameters

Responses

GET /webhooks

List the webhook endpoints this credential manages #

A partner app sees the endpoints it registered in this workspace; an API key sees the workspace's own, including those registered in the app.

Required scope: webhooks:read.

Parameters

Responses

POST /webhooks

Register a webhook endpoint; the answer carries its signing secret once #

Name the events explicitly. Each must be one whose data the credential may read (invoice.* needs invoices:read, expense.* expenses:read, and so on; account events such as bank feeds, VAT reports, the subscription and the team are kept off the API), or the answer is 403 WEBHOOK_EVENT_NOT_ALLOWED. The URL must be publicly reachable over https (422 WEBHOOK_URL_NOT_ALLOWED). A partner app may register 5 endpoints per workspace; they are deleted when the workspace disconnects the app. The answer carries the signing secret, once.

Required scope: webhooks:write.

Parameters

Request body

CreateWebhook

Responses

GET /webhooks/{id}

Get one webhook endpoint #

Required scope: webhooks:read.

Parameters

Responses

PATCH /webhooks/{id}

Change the URL, events, label or state of a webhook endpoint #

What the endpoint receives after the change must lie within the credential's scopes, including events it was already subscribed to. isActive: true resumes an endpoint that was switched off after repeated failures.

Required scope: webhooks:write.

Parameters

Request body

UpdateWebhook

Responses

DELETE /webhooks/{id}

Delete a webhook endpoint #

Deliveries still waiting for a retry are closed off; the delivery log is kept.

Required scope: webhooks:write.

Parameters

Responses

POST /webhooks/{id}/rotate-secret

Replace the signing secret of a webhook endpoint #

The old secret stops signing at once; deliveries from now on use the new one.

Required scope: webhooks:write.

Parameters

Responses

POST /webhooks/{id}/test

Send a signed ping event to a webhook endpoint and report the result #

Sends a signed ping event to this endpoint now and reports how it answered.

Required scope: webhooks:write.

Parameters

Responses