Agendas
Operations in the Agendas group.
- GET/v1/agendas/enp/batches
- POST/v1/agendas/enp/batches
- DEL/v1/agendas/enp/batches/{id}
- GET/v1/agendas/enp/batches/{id}/csv
- GET/v1/agendas/enp/documents
- GET/v1/agendas/enp/recognition
- PUT/v1/agendas/enp/recognition
- POST/v1/bulk/contact-processing-reason
- POST/v1/bulk/edit-contacts
- POST/v1/bulk/edit-documents
- POST/v1/bulk/email
- POST/v1/bulk/export
- POST/v1/bulk/invoice-contacts
- POST/v1/bulk/issue
- GET/v1/bulk/jobs
- POST/v1/bulk/jobs
- GET/v1/bulk/jobs/{id}
- GET/v1/bulk/jobs/{id}/file
- POST/v1/bulk/match-payments
- POST/v1/bulk/match-payments/confirm
- POST/v1/bulk/match-payments/preview
- POST/v1/bulk/pdf-zip
- GET/v1/carriers
- POST/v1/carriers
- PATCH/v1/carriers/{id}
- DEL/v1/carriers/{id}
- GET/v1/complaints
- POST/v1/complaints
- GET/v1/complaints/{id}
- PATCH/v1/complaints/{id}
- POST/v1/complaints/{id}/cancel
- GET/v1/complaints/{id}/pdf
- POST/v1/complaints/{id}/resolve
- POST/v1/complaints/{id}/start
- GET/v1/complaints/settings
- PUT/v1/complaints/settings
- PATCH/v1/contact-activities/{id}
- DEL/v1/contact-activities/{id}
- POST/v1/contact-activities/{id}/check
- PATCH/v1/contact-processing-reasons/{id}
- DEL/v1/contact-processing-reasons/{id}
- GET/v1/contacts/{id}/activities
- POST/v1/contacts/{id}/activities
- GET/v1/contacts/{id}/gdpr
- POST/v1/contacts/{id}/gdpr/reasons
- POST/v1/contacts/{id}/gdpr/restriction
- POST/v1/contacts/mail-merge
- GET/v1/contacts/mailings
- POST/v1/contacts/mailings
- GET/v1/contacts/mailings/{id}
- POST/v1/contacts/mailings/preview
- GET/v1/contacts/sms
- POST/v1/contacts/sms
- POST/v1/contacts/sms/preview
- GET/v1/contacts/sms/status
- PATCH/v1/contract-amendments/{id}
- DEL/v1/contract-amendments/{id}
- GET/v1/contracts
- POST/v1/contracts
- GET/v1/contracts/{id}
- PATCH/v1/contracts/{id}
- DEL/v1/contracts/{id}
- POST/v1/contracts/{id}/amendments
- GET/v1/custom-fields
- POST/v1/custom-fields
- PATCH/v1/custom-fields/{id}
- DEL/v1/custom-fields/{id}
- PUT/v1/custom-fields/values/{entity}/{id}
- GET/v1/documents
- POST/v1/documents
- GET/v1/documents/{id}
- PATCH/v1/documents/{id}
- DEL/v1/documents/{id}
- GET/v1/documents/{id}/download
- GET/v1/documents/retention-holds
- POST/v1/documents/retention-holds
- POST/v1/documents/retention-holds/{id}/release
- GET/v1/documents/retention-rules
- GET/v1/gdpr/contacts
- GET/v1/gdpr/reasons
- POST/v1/gdpr/reasons
- PATCH/v1/gdpr/reasons/{id}
- DEL/v1/gdpr/reasons/{id}
- POST/v1/inbox/documents/{id}/approval
- GET/v1/intrastat/credits
- GET/v1/intrastat/declarations
- POST/v1/intrastat/declarations
- GET/v1/intrastat/declarations/{id}
- DEL/v1/intrastat/declarations/{id}
- GET/v1/intrastat/declarations/{id}/csv
- POST/v1/intrastat/declarations/{id}/file
- POST/v1/intrastat/declarations/{id}/lines
- PATCH/v1/intrastat/declarations/{id}/lines/{lineId}
- DEL/v1/intrastat/declarations/{id}/lines/{lineId}
- POST/v1/intrastat/declarations/{id}/regenerate
- POST/v1/intrastat/declarations/{id}/reopen
- PUT/v1/intrastat/defaults
- GET/v1/intrastat/documents/{kind}/{id}
- PUT/v1/intrastat/documents/{kind}/{id}
- GET/v1/intrastat/items/{itemId}
- PUT/v1/intrastat/items/{itemId}
- GET/v1/intrastat/status
- GET/v1/invoice-approvals
- GET/v1/invoice-approvals/{id}
- POST/v1/invoice-approvals/{id}/approve
- POST/v1/invoice-approvals/{id}/reject
- GET/v1/invoice-approvals/approvers
- GET/v1/invoice-approvals/delegations
- POST/v1/invoice-approvals/delegations
- DEL/v1/invoice-approvals/delegations/{id}
- GET/v1/invoice-approvals/scenarios
- POST/v1/invoice-approvals/scenarios
- PATCH/v1/invoice-approvals/scenarios/{id}
- DEL/v1/invoice-approvals/scenarios/{id}
- GET/v1/invoice-approvals/settings
- PUT/v1/invoice-approvals/settings
- GET/v1/job-orders
- POST/v1/job-orders
- GET/v1/job-orders/{id}
- PATCH/v1/job-orders/{id}
- DEL/v1/job-orders/{id}
- POST/v1/job-orders/{id}/documents
- GET/v1/job-orders/report
- GET/v1/print-template
- PUT/v1/print-template
- GET/v1/print-template/catalog
- POST/v1/print-template/check
- GET/v1/print-template/images
- GET/v1/print-template/images/{id}
- POST/v1/print-template/labels
- GET/v1/print-template/layouts/{documentType}
- PUT/v1/print-template/layouts/{documentType}
- DEL/v1/print-template/layouts/{documentType}
- POST/v1/print-template/postal-order
- POST/v1/print-template/preview
- POST/v1/print-template/print
- GET/v1/print-template/variants
- POST/v1/print-template/variants
- GET/v1/print-template/variants/{id}
- PUT/v1/print-template/variants/{id}
- DEL/v1/print-template/variants/{id}
- POST/v1/received-invoices/{id}/approval
- POST/v1/sales/documents/{id}/approval
- GET/v1/saved-reports
- POST/v1/saved-reports
- GET/v1/saved-reports/{id}
- PATCH/v1/saved-reports/{id}
- DEL/v1/saved-reports/{id}
- GET/v1/saved-reports/{id}/export
- GET/v1/saved-reports/{id}/run
- GET/v1/saved-reports/catalog
- POST/v1/saved-reports/export
- POST/v1/saved-reports/run
- GET/v1/service-jobs
- POST/v1/service-jobs
- GET/v1/service-jobs/{id}
- PATCH/v1/service-jobs/{id}
- DEL/v1/service-jobs/{id}
- POST/v1/service-jobs/{id}/close
- POST/v1/service-jobs/{id}/invoice
- POST/v1/service-jobs/{id}/parts
- DEL/v1/service-jobs/{id}/parts/{childId}
- GET/v1/service-jobs/{id}/pdf
- POST/v1/service-jobs/{id}/status
- POST/v1/service-jobs/{id}/work
- DEL/v1/service-jobs/{id}/work/{childId}
- GET/v1/shipments
- POST/v1/shipments
- GET/v1/shipments/{id}
- PATCH/v1/shipments/{id}
- DEL/v1/shipments/{id}
- POST/v1/shipments/carrier/labels
- POST/v1/shipments/carrier/status
- POST/v1/shipments/carrier/submit
- POST/v1/shipments/envelopes
- POST/v1/shipments/export
- POST/v1/shipments/generate
- POST/v1/shipments/labels
- POST/v1/shipments/postal-report
- POST/v1/shipments/status-import
- POST/v1/supplier-advances/{id}/approval
- GET/v1/tasks
List batches of evidence náhradního plnění
/v1/agendas/enp/batchesList batches of evidence náhradního plnění
MCP tool: list-enp-batches
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"enp_batch"requiredidstringrequirednamenull | stringrequiredexportedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timelineCountintegerrequiredtotalHalerinteger | nullrequiredlinesobject[]requireddocumentTypenull | stringrequireddocumentIdnull | stringrequireddocumentNumbernull | stringrequiredamountHalerinteger | nullrequireddeliveredOnnull | stringrequireddatepaidOnnull | stringrequireddatecustomerIconull | stringrequiredcustomerBirthNumberstring | nullrequiredcustomerEmailnull | stringrequireddeadlinestringrequireddateproblemsstring[]requiredtotalintegerhasMorebooleanrequiredSave paid documents as a batch. Each keeps the data as it is now: a later change to the document does not reach the batch. A delivery outside the recorded basis (§ 78) stops it
/v1/agendas/enp/batchesSave paid documents as a batch. Each keeps the data as it is now: a later change to the document does not reach the batch. A delivery outside the recorded basis (§ 78) stops it
MCP tool: create-enp-batch
Request body
namestringrequiredmax 120 charsdocumentsobject[]requireddocumentType"invoice" | "pos_receipt" | "other_receivable" | "cash_receipt" | "proforma"requireddocumentIdstringrequiredamountHalerintegermax 9007199254740991deliveredOnstringYYYY-MM-DDoverrideRecognitionbooleanResponse · 201
idstringrequirednamenull | stringrequiredexportedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timelineCountintegerrequiredtotalHalerinteger | nullrequiredlinesobject[]requireddocumentTypenull | stringrequireddocumentIdnull | stringrequireddocumentNumbernull | stringrequiredamountHalerinteger | nullrequireddeliveredOnnull | stringrequireddatepaidOnnull | stringrequireddatecustomerIconull | stringrequiredcustomerBirthNumberstring | nullrequiredcustomerEmailnull | stringrequireddeadlinestringrequireddateproblemsstring[]requiredDelete a batch not yet exported, so its invoices are offered again
/v1/agendas/enp/batches/{id}Delete a batch not yet exported, so its invoices are offered again
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-enp-batch
Path parameters
idstringrequiredResponse · 200
idstringrequirednamenull | stringrequiredexportedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timelineCountintegerrequiredtotalHalerinteger | nullrequiredlinesobject[]requireddocumentTypenull | stringrequireddocumentIdnull | stringrequireddocumentNumbernull | stringrequiredamountHalerinteger | nullrequireddeliveredOnnull | stringrequireddatepaidOnnull | stringrequireddatecustomerIconull | stringrequiredcustomerBirthNumberstring | nullrequiredcustomerEmailnull | stringrequireddeadlinestringrequireddateproblemsstring[]requiredDownload the CSV for the Ministry’s bulk import: CP 1250, semicolons, its own header. Refused while a line would be rejected
/v1/agendas/enp/batches/{id}/csvDownload the CSV for the Ministry’s bulk import: CP 1250, semicolons, its own header. Refused while a line would be rejected
MCP tool: export-enp-batch
Path parameters
idstringrequiredResponse · 200
Returns a text/csv; charset=windows-1250 file.
Paid invoices, till receipts, cash receipts and advances not yet in a náhradní plnění batch, with the amount without VAT and the 30-day deadline
/v1/agendas/enp/documentsPaid invoices, till receipts, cash receipts and advances not yet in a náhradní plnění batch, with the amount without VAT and the 30-day deadline
MCP tool: list-enp-documents
Query parameters
fromstringYYYY-MM-DDtostringYYYY-MM-DDlimitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requireddocumentTypenull | stringrequireddocumentIdnull | stringrequireddocumentNumbernull | stringrequiredamountHalerinteger | nullrequireddeliveredOnnull | stringrequireddatepaidOnnull | stringrequireddatecustomerIconull | stringrequiredcustomerBirthNumberstring | nullrequiredcustomerEmailnull | stringrequireddeadlinestringrequireddateproblemsstring[]requiredcontactNamenull | stringrequiredoverduebooleanrequiredtotalintegerhasMorebooleanrequiredOn what basis the company supplies náhradní plnění (§ 81 odst. 2 písm. b), § 78 zákona o zaměstnanosti), and until when
/v1/agendas/enp/recognitionOn what basis the company supplies náhradní plnění (§ 81 odst. 2 písm. b), § 78 zákona o zaměstnanosti), and until when
MCP tool: get-enp-recognition
Response · 200
recordedbooleanrequiredvalidTodaybooleanrequiredbasisnull | stringrequiredreferencenull | stringrequiredofficeanyrequiredvalidFromnull | stringrequireddatevalidTonull | stringrequireddateRecord the agreement with the Labour Office, or that the company is a self-employed person with a disability or an integrating social enterprise. A batch then checks each delivery against it
/v1/agendas/enp/recognitionRecord the agreement with the Labour Office, or that the company is a self-employed person with a disability or an integrating social enterprise. A batch then checks each delivery against it. The Ministry offers no interface to ask whether a company is recognised, so this is what the company states: nothing here reaches or confirms anything at the Labour Office.
MCP tool: set-enp-recognition
Request body
basis"agreement_78" | "self_employed_disabled" | "integration_enterprise"requiredreferencestring | nullofficestring | nullvalidFromstringrequiredYYYY-MM-DDvalidTostring | nullResponse · 200
recordedbooleanrequiredvalidTodaybooleanrequiredbasisnull | stringrequiredreferencenull | stringrequiredofficeanyrequiredvalidFromnull | stringrequireddatevalidTonull | stringrequireddateGive many contacts the same reason for processing at once
/v1/bulk/contact-processing-reasonGive many contacts the same reason for processing at once
MCP tool: bulk-add-contact-processing-reason
Request body
idsstring[]requiredlegalBasis"consent" | "contract" | "legal_obligation" | "vital_interest" | "public_task" | "legitimate_interest"purposestringmax 200 charsvalidFromstringYYYY-MM-DDvalidTostring | nullnotestring | nullreasonIdstringResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredChange a field on many contacts at once, or add them to a group or take them out. Documents already issued keep the details they were issued with
/v1/bulk/edit-contactsChange a field on many contacts at once, or add them to a group or take them out. Documents already issued keep the details they were issued with
MCP tool: bulk-edit-contacts
Request body
idsstring[]requiredchangesobjectrequiredroles"customer" | "supplier" | "both"usualDueDaysinteger | nullpreferredPaymentMethod"transfer" | "cash" | "card" | "cod" | "proforma" | nullinvoiceLanguage"cs" | "en" | "sk" | "de" | "fr" | "pl" | nulldefaultCurrencystring3 charscreditWarnHalerinteger | nullcreditBlockHalerinteger | nullreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleanaddGroupIdstringremoveGroupIdstringResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredChange a field on many documents at once (POHODA Upravit vše). A draft takes all of them; past draft only the due date and notes, and anything else fails for that document
/v1/bulk/edit-documentsChange a field on many documents at once (POHODA Upravit vše). A draft takes all of them; past draft only the due date and notes, and anything else fails for that document. Each document goes through its own update, with its own rules. Amounts, dates, and the partner are not offered: a document already issued keeps what it said.
MCP tool: bulk-edit-documents
Request body
kind"invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable" | "pos_receipt" | "advance_tax_document"requiredidsstring[]requiredchangesobjectrequireddueDatestring | nullnotePublicstring | nullnoteInternalstring | nulllanguage"cs" | "en" | "sk" | "de" | "fr" | "pl"paymentMethod"transfer" | "cash" | "card" | "cod" | "proforma"centerIdstring | nullactivityIdstring | nullprojectIdstring | nulltemplateIdstring | nullResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredE-mail many issued documents to their customers, each with its PDF. Uses each contact e-mail and the document type template
/v1/bulk/emailE-mail many issued documents to their customers, each with its PDF. Uses each contact e-mail and the document type template
MCP tool: bulk-email-documents
Request body
kind"invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable" | "pos_receipt" | "advance_tax_document"requiredidsstring[]requiredsubjectstringmax 300 charsbodystringmax 10000 charsResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredExport the selected documents as a table: format=xlsx or csv
/v1/bulk/exportExport the selected documents as a table: format=xlsx or csv
MCP tool: bulk-export-documents
Request body
kind"invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable" | "pos_receipt" | "advance_tax_document"requiredidsstring[]requiredformat"csv" | "xlsx"Response · 200
Returns a application/octet-stream file.
Hromadná fakturace: create one invoice, proforma, quote, or order per contact from the same lines or a sample document. Drafts unless issue=true; each answers on its own
/v1/bulk/invoice-contactsHromadná fakturace: create one invoice, proforma, quote, or order per contact from the same lines or a sample document. Drafts unless issue=true; each answers on its own. At most 200 at once here: createBulkJob runs more through the queue. Each document takes its address, due days, and language from its contact, and goes through the same rules as one made by hand, including the credit limit when issued.
MCP tool: bulk-invoice-contacts
Request body
contactIdsstring[]groupIdstringkind"invoice" | "proforma" | "quote" | "order_received" | "order_issued"sampleIdstringlinesobject[]descriptionstringrequiredmax 200 charsquantitynumberrequiredunitstringmax 16 charsunitPriceHalerintegerrequiredmin -9007199254740991max 9007199254740991vatRatenumbermin 0max 30issueDatestringYYYY-MM-DDtaxPointDatestringYYYY-MM-DDdueDaysintegermin 0max 2000seriesIdstringnotePublicstring | nullissuebooleanResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredIssue many draft documents at once. Each one is numbered and posted on its own; the answer lists successes and failures
/v1/bulk/issueIssue many draft documents at once. Each one is numbered and posted on its own; the answer lists successes and failures. A document over Kredit max fails with credit_limit_exceeded while the rest go on. An owner or accountant may then send those ids again with overrideCreditLimit.
MCP tool: bulk-issue-documents
Request body
kind"invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable" | "pos_receipt" | "advance_tax_document"requiredidsstring[]requiredoverrideCreditLimitbooleanResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredList bulk jobs running in the background and how they ended, newest first
/v1/bulk/jobsList bulk jobs running in the background and how they ended, newest first
MCP tool: list-bulk-jobs
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"queued" | "running" | "done" | "failed"Response · 200
dataobject[]requiredobject"bulk_job"requiredidstringrequiredoperationstringrequiredstatusstringrequiredtotalintegerrequiredprocessedintegerrequiredsucceededintegerrequiredfailedintegerrequiredresultsobject[]requiredidstringrequiredokbooleanrequirednumbernull | stringstatusstringcodenull | stringerrornull | stringfileIdnull | stringrequiredfilenamenull | stringrequirederrorstring | nullrequiredstartedAtnull | stringrequireddate-timefinishedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredRun a bulk operation on any number of documents in the background, up to 20 000. Answers at once with a job to watch; each document still stands on its own
/v1/bulk/jobsRun a bulk operation on any number of documents in the background, up to 20 000. Answers at once with a job to watch; each document still stands on its own. Takes the same body as the operation it names. getBulkJob tells how far it got and what happened to each. PDFs in a ZIP and exports end as a file: downloadBulkJobFile.
MCP tool: create-bulk-job
Request body
operation"issue" | "email" | "match-payments" | "edit-documents" | "invoice-contacts" | "pdf-zip" | "export"requiredbodyobjectrequiredResponse · 202
idstringrequiredoperationstringrequiredstatusstringrequiredtotalintegerrequiredprocessedintegerrequiredsucceededintegerrequiredfailedintegerrequiredresultsobject[]requiredidstringrequiredokbooleanrequirednumbernull | stringstatusstringcodenull | stringerrornull | stringfileIdnull | stringrequiredfilenamenull | stringrequirederrorstring | nullrequiredstartedAtnull | stringrequireddate-timefinishedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeHow far a bulk job got, and what happened to each document so far
/v1/bulk/jobs/{id}How far a bulk job got, and what happened to each document so far
MCP tool: get-bulk-job
Path parameters
idstringrequiredResponse · 200
idstringrequiredoperationstringrequiredstatusstringrequiredtotalintegerrequiredprocessedintegerrequiredsucceededintegerrequiredfailedintegerrequiredresultsobject[]requiredidstringrequiredokbooleanrequirednumbernull | stringstatusstringcodenull | stringerrornull | stringfileIdnull | stringrequiredfilenamenull | stringrequirederrorstring | nullrequiredstartedAtnull | stringrequireddate-timefinishedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeDownload the ZIP or the table a finished bulk job made
/v1/bulk/jobs/{id}/fileDownload the ZIP or the table a finished bulk job made
MCP tool: download-bulk-job-file
Path parameters
idstringrequiredResponse · 200
Returns a application/octet-stream file.
Settle many documents at once: pair each with its one exact bank movement, or with mode=manual record it as paid on a date
/v1/bulk/match-paymentsSettle many documents at once: pair each with its one exact bank movement, or with mode=manual record it as paid on a date. Bank mode pairs only when exactly one open movement has the same direction, currency, amount, and variable symbol. Anything else is reported, never guessed.
MCP tool: bulk-match-payments
Request body
kind"invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable" | "pos_receipt" | "advance_tax_document"requiredidsstring[]requiredmode"bank" | "manual"paidOnstringYYYY-MM-DDmethod"transfer" | "cash" | "card"registerIdstringbankAccountIdstringResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredPair the documents and bank movements a person accepted in the review. Each pair posts on its own and answers on its own
/v1/bulk/match-payments/confirmPair the documents and bank movements a person accepted in the review. Each pair posts on its own and answers on its own
MCP tool: confirm-bulk-match
Request body
kind"invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable" | "pos_receipt" | "advance_tax_document"requiredpairsobject[]requiredidstringrequiredmovementIdstringrequiredamountHalerintegermax 9007199254740991Response · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredPropose bank movements for many documents, for a person to review: best match first, with why it fits. Pairs nothing
/v1/bulk/match-payments/previewPropose bank movements for many documents, for a person to review: best match first, with why it fits. Pairs nothing. Goes beyond one exact match: part payments, a number in the message, a known account, and more than one candidate. confirmBulkMatch pairs what the person accepts.
MCP tool: preview-bulk-match
Request body
kind"invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable" | "pos_receipt" | "advance_tax_document"requiredidsstring[]requiredResponse · 200
kindstringrequireddataobject[]requiredidstringrequiredopenbooleanrequirednumbernull | stringrequiredcontactNamenull | stringrequiredcurrencynull | stringrequiredremainingHalerinteger | nullrequiredproposedMovementIdanyrequiredcandidatesobject[]requiredmovementIdnull | stringrequiredbankAccountIdstringrequiredbookedOnstringrequireddateamountHalerinteger | nullrequiredopenHalerintegerrequiredvariableSymbolnull | stringrequiredcounterpartyNamestring | nullrequiredmessagestring | nullrequiredconfidencenull | numberrequiredreasonnull | stringrequiredsuggestedAmountHalerintegerrequiredDownload the PDFs of many documents as one ZIP. A document without a PDF is listed in chyby.txt inside
/v1/bulk/pdf-zipDownload the PDFs of many documents as one ZIP. A document without a PDF is listed in chyby.txt inside
MCP tool: bulk-download-pdf
Request body
kind"invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable" | "pos_receipt" | "advance_tax_document"requiredidsstring[]requiredResponse · 200
Returns a application/zip file.
List carriers (dopravci): each is a preset way of sending, with the file format its shipments export in
/v1/carriersList carriers (dopravci): each is a preset way of sending, with the file format its shipments export in
MCP tool: list-carriers
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"carrier"requiredidstringrequirednamestringrequiredexportFormatstringrequiredexportFormatPublishedbooleanrequiredserviceCodenull | stringrequiredsenderCodenull | stringrequireddefaultWeightGramsinteger | nullrequiredisActivebooleanrequirednotestring | nullrequiredadapternull | stringhasApiPasswordbooleanapiUsernamenull | stringsenderAddressRefnull | stringtotalintegerhasMorebooleanrequiredAdd a carrier. Česká pošta exports in its published posting sheet (ePA), Packeta in its packet import; any other carrier in generic CSV, or through its own API (Packeta, PPL, DPD, GLS) where the operator allows
/v1/carriersAdd a carrier. Česká pošta exports in its published posting sheet (ePA), Packeta in its packet import; any other carrier in generic CSV, or through its own API (Packeta, PPL, DPD, GLS) where the operator allows
MCP tool: create-carrier
Request body
namestringrequiredmax 200 charsexportFormat"generic" | "ceska_posta_epa" | "packeta_csv"adapter"packeta" | "ppl" | "dpd" | "gls" | nullapiUsernamestring | nullapiPasswordstring | nullsenderAddressRefstring | nullserviceCodestring | nullsenderCodestring | nulldefaultWeightGramsinteger | nullisActivebooleannotestring | nullResponse · 201
idstringrequirednamestringrequiredexportFormatstringrequiredexportFormatPublishedbooleanrequiredserviceCodenull | stringrequiredsenderCodenull | stringrequireddefaultWeightGramsinteger | nullrequiredisActivebooleanrequirednotestring | nullrequiredadapternull | stringhasApiPasswordbooleanapiUsernamenull | stringsenderAddressRefnull | stringChange a carrier, or set it inactive
/v1/carriers/{id}Change a carrier, or set it inactive
MCP tool: update-carrier
Path parameters
idstringrequiredRequest body
namestringmax 200 charsexportFormat"generic" | "ceska_posta_epa" | "packeta_csv"adapter"packeta" | "ppl" | "dpd" | "gls" | nullapiUsernamestring | nullapiPasswordstring | nullsenderAddressRefstring | nullserviceCodestring | nullsenderCodestring | nulldefaultWeightGramsinteger | nullisActivebooleannotestring | nullResponse · 200
idstringrequirednamestringrequiredexportFormatstringrequiredexportFormatPublishedbooleanrequiredserviceCodenull | stringrequiredsenderCodenull | stringrequireddefaultWeightGramsinteger | nullrequiredisActivebooleanrequirednotestring | nullrequiredadapternull | stringhasApiPasswordbooleanapiUsernamenull | stringsenderAddressRefnull | stringDelete a carrier no shipment uses. One that has shipments is set inactive instead
/v1/carriers/{id}Delete a carrier no shipment uses. One that has shipments is set inactive instead
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-carrier
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList complaints (reklamace) with their deadline state
/v1/complaintsList complaints (reklamace) with their deadline state
MCP tool: list-complaints
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"open" | "in_progress" | "resolved" | "rejected" | "cancelled"contactIdstringopen"true" | "false"customFieldKeystringcustomFieldValuestringmax 2000 charsResponse · 200
dataobject[]requiredobject"complaint"requiredidstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequiredconsumerbooleanrequiredinvoiceIdnull | stringrequiredinvoiceLineIdnull | stringrequireditemIdnull | stringrequiredsubjectstringrequireddescriptionstringrequiredrequestedResolutionstring | nullrequiredquantityinteger | nullrequireddeliveredOnnull | stringrequireddateclaimedOnstringrequireddateagreedDeadlinenull | stringrequireddatedeadlineOnnull | stringrequireddatedeadlineobjectrequiredstatestringrequireddaysLeftinteger | nullrequiredwithinTwoYearsboolean | nullrequiredstatusstringrequiredoutcomenull | stringrequiredresolvedOnnull | stringrequireddateresolutionNotenull | stringrequiredcreditNoteIdnull | stringrequiredserviceJobIdstring | nullrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timediscoveredOnnull | stringdatewarrantyUntilnull | stringdatebusinessPeriodsnull | objecthiddenDefectLimitnull | stringrequireddatewithinHiddenDefectLimitboolean | nullrequireddaysFromDiscoveryinteger | nullrequiredwarrantyUntilnull | stringrequireddatewithinWarrantyboolean | nullrequiredcustomFieldsobjectinvoiceNumberanycreditNoteNumberanycreditNoteStatusanytotalintegerhasMorebooleanrequiredRecord a complaint against a sale. For a consumer the 30-day deadline of § 19 zákona 634/1992 Sb. is set automatically
/v1/complaintsRecord a complaint against a sale. For a consumer the 30-day deadline of § 19 zákona 634/1992 Sb. is set automatically
MCP tool: create-complaint
Request body
contactIdstringconsumerbooleaninvoiceIdstring | nullinvoiceLineIdstring | nullitemIdstring | nullsubjectstringrequiredmax 200 charsdescriptionstringrequiredmax 4000 charsrequestedResolutionstring | nullquantitynumber | nulldeliveredOnstring | nullclaimedOnstringYYYY-MM-DDagreedDeadlinestring | nulldiscoveredOnstring | nullwarrantyUntilstring | nullResponse · 201
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequiredconsumerbooleanrequiredinvoiceIdnull | stringrequiredinvoiceLineIdnull | stringrequireditemIdnull | stringrequiredsubjectstringrequireddescriptionstringrequiredrequestedResolutionstring | nullrequiredquantityinteger | nullrequireddeliveredOnnull | stringrequireddateclaimedOnstringrequireddateagreedDeadlinenull | stringrequireddatedeadlineOnnull | stringrequireddatedeadlineobjectrequiredstatestringrequireddaysLeftinteger | nullrequiredwithinTwoYearsboolean | nullrequiredstatusstringrequiredoutcomenull | stringrequiredresolvedOnnull | stringrequireddateresolutionNotenull | stringrequiredcreditNoteIdnull | stringrequiredserviceJobIdstring | nullrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timediscoveredOnnull | stringdatewarrantyUntilnull | stringdatebusinessPeriodsnull | objecthiddenDefectLimitnull | stringrequireddatewithinHiddenDefectLimitboolean | nullrequireddaysFromDiscoveryinteger | nullrequiredwarrantyUntilnull | stringrequireddatewithinWarrantyboolean | nullrequiredcustomFieldsobjectinvoiceNumberanycreditNoteNumberanycreditNoteStatusanyGet a complaint
/v1/complaints/{id}Get a complaint
MCP tool: get-complaint
Path parameters
idstringrequiredResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequiredconsumerbooleanrequiredinvoiceIdnull | stringrequiredinvoiceLineIdnull | stringrequireditemIdnull | stringrequiredsubjectstringrequireddescriptionstringrequiredrequestedResolutionstring | nullrequiredquantityinteger | nullrequireddeliveredOnnull | stringrequireddateclaimedOnstringrequireddateagreedDeadlinenull | stringrequireddatedeadlineOnnull | stringrequireddatedeadlineobjectrequiredstatestringrequireddaysLeftinteger | nullrequiredwithinTwoYearsboolean | nullrequiredstatusstringrequiredoutcomenull | stringrequiredresolvedOnnull | stringrequireddateresolutionNotenull | stringrequiredcreditNoteIdnull | stringrequiredserviceJobIdstring | nullrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timediscoveredOnnull | stringdatewarrantyUntilnull | stringdatebusinessPeriodsnull | objecthiddenDefectLimitnull | stringrequireddatewithinHiddenDefectLimitboolean | nullrequireddaysFromDiscoveryinteger | nullrequiredwarrantyUntilnull | stringrequireddatewithinWarrantyboolean | nullrequiredcustomFieldsobjectinvoiceNumberanycreditNoteNumberanycreditNoteStatusanyEdit an open complaint. Changing the claim date or the agreed deadline recomputes the deadline
/v1/complaints/{id}Edit an open complaint. Changing the claim date or the agreed deadline recomputes the deadline
MCP tool: update-complaint
Path parameters
idstringrequiredRequest body
contactIdstringconsumerbooleaninvoiceIdstring | nullinvoiceLineIdstring | nullitemIdstring | nullsubjectstringmax 200 charsdescriptionstringmax 4000 charsrequestedResolutionstring | nullquantitynumber | nulldeliveredOnstring | nullclaimedOnstringYYYY-MM-DDagreedDeadlinestring | nulldiscoveredOnstring | nullwarrantyUntilstring | nullResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequiredconsumerbooleanrequiredinvoiceIdnull | stringrequiredinvoiceLineIdnull | stringrequireditemIdnull | stringrequiredsubjectstringrequireddescriptionstringrequiredrequestedResolutionstring | nullrequiredquantityinteger | nullrequireddeliveredOnnull | stringrequireddateclaimedOnstringrequireddateagreedDeadlinenull | stringrequireddatedeadlineOnnull | stringrequireddatedeadlineobjectrequiredstatestringrequireddaysLeftinteger | nullrequiredwithinTwoYearsboolean | nullrequiredstatusstringrequiredoutcomenull | stringrequiredresolvedOnnull | stringrequireddateresolutionNotenull | stringrequiredcreditNoteIdnull | stringrequiredserviceJobIdstring | nullrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timediscoveredOnnull | stringdatewarrantyUntilnull | stringdatebusinessPeriodsnull | objecthiddenDefectLimitnull | stringrequireddatewithinHiddenDefectLimitboolean | nullrequireddaysFromDiscoveryinteger | nullrequiredwarrantyUntilnull | stringrequireddatewithinWarrantyboolean | nullrequiredcustomFieldsobjectinvoiceNumberanycreditNoteNumberanycreditNoteStatusanyCancel a complaint recorded by mistake
/v1/complaints/{id}/cancelCancel a complaint recorded by mistake
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: cancel-complaint
Path parameters
idstringrequiredResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequiredconsumerbooleanrequiredinvoiceIdnull | stringrequiredinvoiceLineIdnull | stringrequireditemIdnull | stringrequiredsubjectstringrequireddescriptionstringrequiredrequestedResolutionstring | nullrequiredquantityinteger | nullrequireddeliveredOnnull | stringrequireddateclaimedOnstringrequireddateagreedDeadlinenull | stringrequireddatedeadlineOnnull | stringrequireddatedeadlineobjectrequiredstatestringrequireddaysLeftinteger | nullrequiredwithinTwoYearsboolean | nullrequiredstatusstringrequiredoutcomenull | stringrequiredresolvedOnnull | stringrequireddateresolutionNotenull | stringrequiredcreditNoteIdnull | stringrequiredserviceJobIdstring | nullrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timediscoveredOnnull | stringdatewarrantyUntilnull | stringdatebusinessPeriodsnull | objecthiddenDefectLimitnull | stringrequireddatewithinHiddenDefectLimitboolean | nullrequireddaysFromDiscoveryinteger | nullrequiredwarrantyUntilnull | stringrequireddatewithinWarrantyboolean | nullrequiredcustomFieldsobjectinvoiceNumberanycreditNoteNumberanycreditNoteStatusanyComplaint protocol PDF: the intake confirmation of § 19 odst. 2, or the resolution confirmation of § 19 odst. 5
/v1/complaints/{id}/pdfComplaint protocol PDF: the intake confirmation of § 19 odst. 2, or the resolution confirmation of § 19 odst. 5
MCP tool: download-complaint-protocol
Path parameters
idstringrequiredQuery parameters
document"intake" | "resolution"language"cs" | "en" | "de" | "fr"Response · 200
Returns a application/pdf file.
Close a complaint: repair, replacement, refund, discount, or rejection. Refund and discount create a credit note on the sale
/v1/complaints/{id}/resolveClose a complaint: repair, replacement, refund, discount, or rejection. Refund and discount create a credit note on the sale. The credit note stays a draft to check unless issueCreditNote is set. Replacement with a warehouse issues the goods from stock.
MCP tool: resolve-complaint
Path parameters
idstringrequiredRequest body
outcome"repair" | "replacement" | "refund" | "discount" | "rejected"requiredresolvedOnstringYYYY-MM-DDnotestringmax 4000 charsquantitynumbermax 1000000000discountNetHalerintegermax 9007199254740991issueCreditNotebooleanreplacementWarehouseIdstringreplacementItemIdstringResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequiredconsumerbooleanrequiredinvoiceIdnull | stringrequiredinvoiceLineIdnull | stringrequireditemIdnull | stringrequiredsubjectstringrequireddescriptionstringrequiredrequestedResolutionstring | nullrequiredquantityinteger | nullrequireddeliveredOnnull | stringrequireddateclaimedOnstringrequireddateagreedDeadlinenull | stringrequireddatedeadlineOnnull | stringrequireddatedeadlineobjectrequiredstatestringrequireddaysLeftinteger | nullrequiredwithinTwoYearsboolean | nullrequiredstatusstringrequiredoutcomenull | stringrequiredresolvedOnnull | stringrequireddateresolutionNotenull | stringrequiredcreditNoteIdnull | stringrequiredserviceJobIdstring | nullrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timediscoveredOnnull | stringdatewarrantyUntilnull | stringdatebusinessPeriodsnull | objecthiddenDefectLimitnull | stringrequireddatewithinHiddenDefectLimitboolean | nullrequireddaysFromDiscoveryinteger | nullrequiredwarrantyUntilnull | stringrequireddatewithinWarrantyboolean | nullrequiredcustomFieldsobjectinvoiceNumberanycreditNoteNumberanycreditNoteStatusanyMark a complaint as being worked on
/v1/complaints/{id}/startMark a complaint as being worked on
MCP tool: start-complaint
Path parameters
idstringrequiredResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequiredconsumerbooleanrequiredinvoiceIdnull | stringrequiredinvoiceLineIdnull | stringrequireditemIdnull | stringrequiredsubjectstringrequireddescriptionstringrequiredrequestedResolutionstring | nullrequiredquantityinteger | nullrequireddeliveredOnnull | stringrequireddateclaimedOnstringrequireddateagreedDeadlinenull | stringrequireddatedeadlineOnnull | stringrequireddatedeadlineobjectrequiredstatestringrequireddaysLeftinteger | nullrequiredwithinTwoYearsboolean | nullrequiredstatusstringrequiredoutcomenull | stringrequiredresolvedOnnull | stringrequireddateresolutionNotenull | stringrequiredcreditNoteIdnull | stringrequiredserviceJobIdstring | nullrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timediscoveredOnnull | stringdatewarrantyUntilnull | stringdatebusinessPeriodsnull | objecthiddenDefectLimitnull | stringrequireddatewithinHiddenDefectLimitboolean | nullrequireddaysFromDiscoveryinteger | nullrequiredwarrantyUntilnull | stringrequireddatewithinWarrantyboolean | nullrequiredcustomFieldsobjectinvoiceNumberanycreditNoteNumberanycreditNoteStatusanyHow many days the company works to on a complaint between businesses. The law sets no number for them
/v1/complaints/settingsHow many days the company works to on a complaint between businesses. The law sets no number for them
MCP tool: get-complaint-settings
Response · 200
businessDeadlineDaysinteger | nullrequiredSet how many days the company works to on a complaint between businesses. An agreed date always wins, and consumers keep their 30 days
/v1/complaints/settingsSet how many days the company works to on a complaint between businesses. An agreed date always wins, and consumers keep their 30 days
MCP tool: update-complaint-settings
Request body
businessDeadlineDaysinteger | nullrequiredResponse · 200
businessDeadlineDaysinteger | nullrequiredEdit an activity, or mark a task done
/v1/contact-activities/{id}Edit an activity, or mark a task done
MCP tool: update-contact-activity
Path parameters
idstringrequiredRequest body
kind"note" | "call" | "meeting" | "task"subjectstringmax 200 charsbodystring | nulloccurredOnstringYYYY-MM-DDdueOnstring | nullassignedToIdstring | nullparentIdstring | nullcheckerIdstring | nullrecurrence"daily" | "weekly" | "monthly" | "quarterly" | "yearly" | nullrecurrenceUntilstring | nullremindDaysBeforeinteger | nulldonebooleanResponse · 200
idstringrequiredcontactIdstringrequiredkindstringrequiredsubjectstringrequiredbodynull | stringrequiredoccurredOnstringrequireddatedueOnnull | stringrequireddatedonebooleanrequireddoneAtnull | stringrequireddate-timeassignedToIdnull | stringrequiredcreatedAtstringrequireddate-timeparentIdnull | stringcheckerIdnull | stringcheckedbooleancheckedAtnull | stringdate-timewaitingForCheckbooleanrecurrencenull | stringrecurrenceUntilnull | stringdatenextTaskIdnull | stringremindDaysBeforeinteger | nullcontactNamenull | stringassignedToNamestringDelete an activity
/v1/contact-activities/{id}Delete an activity
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-contact-activity
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredAs the checking person, approve a finished task, which completes it and starts its next repeat, or send it back to the assignee
/v1/contact-activities/{id}/checkAs the checking person, approve a finished task, which completes it and starts its next repeat, or send it back to the assignee. Only the person named as checker, an owner, or an accountant may do this. Sending it back reopens the task and adds the note to its text.
MCP tool: check-contact-task
Path parameters
idstringrequiredRequest body
approvedbooleanrequirednotestring | nullResponse · 200
idstringrequiredcontactIdstringrequiredkindstringrequiredsubjectstringrequiredbodynull | stringrequiredoccurredOnstringrequireddatedueOnnull | stringrequireddatedonebooleanrequireddoneAtnull | stringrequireddate-timeassignedToIdnull | stringrequiredcreatedAtstringrequireddate-timeparentIdnull | stringcheckerIdnull | stringcheckedbooleancheckedAtnull | stringdate-timewaitingForCheckbooleanrecurrencenull | stringrecurrenceUntilnull | stringdatenextTaskIdnull | stringremindDaysBeforeinteger | nullcontactNamenull | stringassignedToNamestringChange a reason for processing, for example end it when consent is withdrawn
/v1/contact-processing-reasons/{id}Change a reason for processing, for example end it when consent is withdrawn
MCP tool: update-contact-processing-reason
Path parameters
idstringrequiredRequest body
legalBasis"consent" | "contract" | "legal_obligation" | "vital_interest" | "public_task" | "legitimate_interest"purposestringmax 200 charsvalidFromstringYYYY-MM-DDvalidTostring | nullnotestring | nullResponse · 200
idstringrequiredcontactIdstringrequiredlegalBasisstringrequiredpurposestringrequiredvalidFromstringrequireddatevalidTonull | stringrequireddatenotestring | nullrequiredstatestringrequiredreasonIdnull | stringRemove a reason for processing entered by mistake. To end one, set its end date instead, so the history stays
/v1/contact-processing-reasons/{id}Remove a reason for processing entered by mistake. To end one, set its end date instead, so the history stays
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-contact-processing-reason
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList the notes, calls, meetings, and tasks of a contact, newest first
/v1/contacts/{id}/activitiesList the notes, calls, meetings, and tasks of a contact, newest first
MCP tool: list-contact-activities
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDkind"note" | "call" | "meeting" | "task"openTasks"true" | "false"Response · 200
dataobject[]requiredobject"contact_activity"requiredidstringrequiredcontactIdstringrequiredkindstringrequiredsubjectstringrequiredbodynull | stringrequiredoccurredOnstringrequireddatedueOnnull | stringrequireddatedonebooleanrequireddoneAtnull | stringrequireddate-timeassignedToIdnull | stringrequiredcreatedAtstringrequireddate-timeparentIdnull | stringcheckerIdnull | stringcheckedbooleancheckedAtnull | stringdate-timewaitingForCheckbooleanrecurrencenull | stringrecurrenceUntilnull | stringdatenextTaskIdnull | stringremindDaysBeforeinteger | nullcontactNamenull | stringassignedToNamestringtotalintegerhasMorebooleanrequiredAdd a note, call, meeting, or task to a contact. A task with a due date shows in K vyřízení, and can have subtasks, a checker, a repeat, and a reminder
/v1/contacts/{id}/activitiesAdd a note, call, meeting, or task to a contact. A task with a due date shows in K vyřízení, and can have subtasks, a checker, a repeat, and a reminder
MCP tool: create-contact-activity
Path parameters
idstringrequiredRequest body
kind"note" | "call" | "meeting" | "task"subjectstringrequiredmax 200 charsbodystring | nulloccurredOnstringYYYY-MM-DDdueOnstring | nullassignedToIdstring | nullparentIdstring | nullcheckerIdstring | nullrecurrence"daily" | "weekly" | "monthly" | "quarterly" | "yearly" | nullrecurrenceUntilstring | nullremindDaysBeforeinteger | nullResponse · 201
idstringrequiredcontactIdstringrequiredkindstringrequiredsubjectstringrequiredbodynull | stringrequiredoccurredOnstringrequireddatedueOnnull | stringrequireddatedonebooleanrequireddoneAtnull | stringrequireddate-timeassignedToIdnull | stringrequiredcreatedAtstringrequireddate-timeparentIdnull | stringcheckerIdnull | stringcheckedbooleancheckedAtnull | stringdate-timewaitingForCheckbooleanrecurrencenull | stringrecurrenceUntilnull | stringdatenextTaskIdnull | stringremindDaysBeforeinteger | nullcontactNamenull | stringassignedToNamestringGet the GDPR overview of a contact: reasons for processing and their validity, last use on documents, restriction, unsubscribe
/v1/contacts/{id}/gdprGet the GDPR overview of a contact: reasons for processing and their validity, last use on documents, restriction, unsubscribe
MCP tool: get-contact-gdpr
Path parameters
idstringrequiredResponse · 200
contactIdnull | stringrequiredstatestringrequiredrestrictedbooleanrequiredrestrictedAtnull | stringrequireddate-timemarketingOptOutbooleanrequiredmarketingOptOutAtnull | stringrequireddate-timereasonsobject[]requiredobject"contact_processing_reason"requiredidstringrequiredcontactIdstringrequiredlegalBasisstringrequiredpurposestringrequiredvalidFromstringrequireddatevalidTonull | stringrequireddatenotestring | nullrequiredstatestringrequiredreasonIdnull | stringusageobjectrequiredlastPreSaleOnnull | stringrequireddatelastSaleOnnull | stringrequireddatelastPostSaleOnnull | stringrequireddateAdd a legal reason for processing the personal data of a contact, picked from the company list or written out, with how long it lasts
/v1/contacts/{id}/gdpr/reasonsAdd a legal reason for processing the personal data of a contact, picked from the company list or written out, with how long it lasts
MCP tool: add-contact-processing-reason
Path parameters
idstringrequiredRequest body
legalBasis"consent" | "contract" | "legal_obligation" | "vital_interest" | "public_task" | "legitimate_interest"purposestringmax 200 charsvalidFromstringYYYY-MM-DDvalidTostring | nullnotestring | nullreasonIdstringResponse · 201
idstringrequiredcontactIdstringrequiredlegalBasisstringrequiredpurposestringrequiredvalidFromstringrequireddatevalidTonull | stringrequireddatenotestring | nullrequiredstatestringrequiredreasonIdnull | stringRestrict processing of a contact (GDPR Art. 18): it leaves the ordinary contact list and cannot go on a new document. Or lift the restriction
/v1/contacts/{id}/gdpr/restrictionRestrict processing of a contact (GDPR Art. 18): it leaves the ordinary contact list and cannot go on a new document. Or lift the restriction
MCP tool: restrict-contact-processing
Path parameters
idstringrequiredRequest body
restrictedbooleanrequiredResponse · 200
contactIdnull | stringrequiredstatestringrequiredrestrictedbooleanrequiredrestrictedAtnull | stringrequireddate-timemarketingOptOutbooleanrequiredmarketingOptOutAtnull | stringrequireddate-timereasonsobject[]requiredobject"contact_processing_reason"requiredidstringrequiredcontactIdstringrequiredlegalBasisstringrequiredpurposestringrequiredvalidFromstringrequireddatevalidTonull | stringrequireddatenotestring | nullrequiredstatestringrequiredreasonIdnull | stringusageobjectrequiredlastPreSaleOnnull | stringrequireddatelastSaleOnnull | stringrequireddatelastPostSaleOnnull | stringrequireddateMail merge (hromadná korespondence): a letter per contact as PDF files in a ZIP, format=docx to fill a Word template per contact in a ZIP, or format=csv for the merge data
/v1/contacts/mail-mergeMail merge (hromadná korespondence): a letter per contact as PDF files in a ZIP, format=docx to fill a Word template per contact in a ZIP, or format=csv for the merge data. A Word template marks its places with {{name}} or a Word MERGEFIELD of the same name: name, person, ico, dic, email, phone, street, city, postalCode, companyName. An unknown one is refused, so a typo does not leave a gap in a letter.
MCP tool: contact-mail-merge
Request body
contactIdsstring[]groupIdstringformat"pdf" | "csv" | "docx"titlestringmax 200 charsbodystringmax 20000 charstemplateBase64stringmax 14000000 charsResponse · 200
Returns a application/octet-stream file.
List bulk e-mails sent, newest first, with how many went out
/v1/contacts/mailingsList bulk e-mails sent, newest first, with how many went out
MCP tool: list-contact-mailings
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"contact_mailing"requiredidstringrequiredpurposestringrequiredsubjectstringrequiredrecipientCountintegerrequiredsentCountintegerrequiredfailedCountintegerrequiredskippedCountintegerrequiredresultsobject[]contactIdnull | stringrequirednamenull | stringrequiredemailnull | stringrequiredstatusstringrequiredreasonnull | stringrequiredstatusstringfinishedAtnull | stringdate-timecreatedAtstringdate-timetotalintegerhasMorebooleanrequiredQueue a bulk e-mail to contacts of this company, and answer at once. A marketing message is labelled, names the sender, and carries an unsubscribe link and List-Unsubscribe headers
/v1/contacts/mailingsQueue a bulk e-mail to contacts of this company, and answer at once. A marketing message is labelled, names the sender, and carries an unsubscribe link and List-Unsubscribe headers. Fields {{name}}, {{person}}, {{ico}}, {{dic}}, {{email}}, {{phone}}, {{street}}, {{city}}, {{postalCode}}, {{companyName}} fill per contact. Marketing goes only to contacts with consent or to customers, and never to one who unsubscribed (§ 7 zákona č. 480/2004 Sb.). At most 200 recipients per message and 1000 per day. It goes out in the background: follow it on GET /contacts/mailings/{id}.
MCP tool: send-contact-mailing
Request body
contactIdsstring[]groupIdstringpurpose"service" | "marketing"requiredsubjectstringrequiredmax 200 charsbodystringrequiredmax 20000 charsResponse · 201
idstringrequiredpurposestringrequiredsubjectstringrequiredrecipientCountintegerrequiredsentCountintegerrequiredfailedCountintegerrequiredskippedCountintegerrequiredresultsobject[]contactIdnull | stringrequirednamenull | stringrequiredemailnull | stringrequiredstatusstringrequiredreasonnull | stringrequiredstatusstringfinishedAtnull | stringdate-timecreatedAtstringdate-timeSee how a bulk e-mail is going: its status, and what happened to each recipient
/v1/contacts/mailings/{id}See how a bulk e-mail is going: its status, and what happened to each recipient
MCP tool: get-contact-mailing
Path parameters
idstringrequiredResponse · 200
idstringrequiredpurposestringrequiredsubjectstringrequiredrecipientCountintegerrequiredsentCountintegerrequiredfailedCountintegerrequiredskippedCountintegerrequiredresultsobject[]contactIdnull | stringrequirednamenull | stringrequiredemailnull | stringrequiredstatusstringrequiredreasonnull | stringrequiredstatusstringfinishedAtnull | stringdate-timecreatedAtstringdate-timeSee who a bulk e-mail would reach and why anyone is left out, with the first message filled in. Sends nothing
/v1/contacts/mailings/previewSee who a bulk e-mail would reach and why anyone is left out, with the first message filled in. Sends nothing
MCP tool: preview-contact-mailing
Request body
contactIdsstring[]groupIdstringpurpose"service" | "marketing"requiredsubjectstringrequiredmax 200 charsbodystringrequiredmax 20000 charsResponse · 200
willSendintegerrequiredskippedintegerrequiredlimitPerMailingintegerrequiredlimitPerDayintegerrequiredsentTodayintegerrequiredrecipientsobject[]requiredcontactIdnull | stringrequirednamenull | stringrequiredemailnull | stringrequiredwillSendbooleanrequiredskipReasonnull | stringrequiredsampleobjectrequiredsubjectnull | stringrequiredtextstringrequiredList SMS messages, newest first, with what happened to each. contactId narrows it to one contact
/v1/contacts/smsList SMS messages, newest first, with what happened to each. contactId narrows it to one contact
MCP tool: list-contact-sms
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDcontactIdstringstatus"pending" | "sent" | "failed" | "skipped"Response · 200
dataobject[]requiredobject"contact_sms"requiredidstringrequiredbatchIdstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredphonenull | stringrequiredpurposenull | stringrequiredtextstringrequiredstatusstringrequiredreasonnull | stringrequiredprovidernull | stringrequiredproviderIdnull | stringrequiredsentAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredQueue a business SMS to contacts, and answer at once. Answers sms_not_configured until an SMS gateway is set up by the operator
/v1/contacts/smsQueue a business SMS to contacts, and answer at once. Answers sms_not_configured until an SMS gateway is set up by the operator. Goes out in the background: follow it on GET /contacts/sms. A marketing text is labelled, names the sender, and carries a way out, and goes only to contacts with consent or to customers (§ 7 zákona č. 480/2004 Sb.). At most 200 per sending and 1000 per day. The status says the gateway accepted a text; delivery reports are not read.
MCP tool: send-contact-sms
Request body
contactIdsstring[]groupIdstringpurpose"service" | "marketing"textstringrequiredmax 612 charsResponse · 201
resultsobject[]requiredidstringrequiredokbooleanproviderIdnull | stringcontactIdnull | stringstatusstringreasonnull | stringtotalintegerrequiredsucceededintegerfailedintegeridstringqueuedintegerskippedintegerSee who a text would reach and why anyone is left out, with the first message filled in. Sends nothing
/v1/contacts/sms/previewSee who a text would reach and why anyone is left out, with the first message filled in. Sends nothing
MCP tool: preview-contact-sms
Request body
contactIdsstring[]groupIdstringpurpose"service" | "marketing"textstringrequiredmax 612 charsResponse · 200
configuredbooleanrequiredwillSendintegerrequiredskippedintegerrequiredlimitPerSendingintegerrequiredlimitPerDayintegerrequiredsentTodayintegerrequiredrecipientsobject[]requiredcontactIdnull | stringrequirednamenull | stringrequiredphonenull | stringrequiredwillSendbooleanrequiredskipReasonnull | stringrequiredtooLongbooleanrequiredsampleobjectrequiredtextstringrequiredlengthintegerrequiredlimitintegerrequiredSay whether an SMS gateway is connected, and how many texts may still go out today
/v1/contacts/sms/statusSay whether an SMS gateway is connected, and how many texts may still go out today
MCP tool: get-contact-sms-status
Response · 200
configuredbooleanrequiredprovidernull | stringrequiredsentTodayintegerrequiredlimitPerDayintegerrequiredlimitPerSendingintegerrequiredChange an amendment
/v1/contract-amendments/{id}Change an amendment
MCP tool: update-contract-amendment
Path parameters
idstringrequiredRequest body
titlestringmax 200 charssignedOnstring | nulleffectiveFromstring | nullnewValidTostring | nullvalueChangeHalerinteger | nullnotestring | nullResponse · 200
idstringrequiredcontractIdstringrequiredpositionintegerrequiredtitlestringrequiredsignedOnstring | nullrequiredeffectiveFromstring | nullrequirednewValidTonull | stringrequireddatevalueChangeHalerinteger | nullrequirednotestring | nullrequiredcreatedAtstringrequireddate-timeDelete an amendment recorded by mistake
/v1/contract-amendments/{id}Delete an amendment recorded by mistake
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-contract-amendment
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList contracts (smlouvy) with their partner, status, and end date as amended
/v1/contractsList contracts (smlouvy) with their partner, status, and end date as amended
MCP tool: list-contracts
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDcontactIdstringstatus"draft" | "active" | "ended" | "terminated"Response · 200
dataobject[]requiredobject"business_contract"requiredidstringrequirednumbernull | stringrequiredtitlenull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredcontractTypestringrequiredcategorystring | nullrequiredstatusstringrequiredsignedOnnull | stringrequireddatevalidFromnull | stringrequireddatevalidTonull | stringrequireddateeffectiveValidTonull | stringrequireddatenoticeDaysinteger | nullrequiredremindDaysinteger | nullrequiredvalueHalerinteger | nullrequiredeffectiveValueHalerinteger | nullrequiredcurrencynull | stringrequiredexternalNumberstring | nullrequirednotestring | nullrequiredamendmentCountintegerrequiredamendmentsobject[]requiredobject"contract_amendment"requiredidstringrequiredcontractIdstringrequiredpositionintegerrequiredtitlestringrequiredsignedOnstring | nullrequiredeffectiveFromstring | nullrequirednewValidTonull | stringrequireddatevalueChangeHalerinteger | nullrequirednotestring | nullrequiredcreatedAtstringrequireddate-timecreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredRecord a contract with a partner. It gets its own number; attach the signed file to it through the document archive
/v1/contractsRecord a contract with a partner. It gets its own number; attach the signed file to it through the document archive
MCP tool: create-contract
Request body
titlestringrequiredmax 200 charscontactIdstring | nullcontractType"sale" | "purchase" | "work" | "service" | "lease" | "loan" | "framework" | "nda" | "other"categorystring | nullstatus"draft" | "active" | "ended" | "terminated"signedOnstring | nullvalidFromstring | nullvalidTostring | nullnoticeDaysinteger | nullremindDaysinteger | nullvalueHalerinteger | nullcurrencystring3 charsexternalNumberstring | nullnotestring | nullResponse · 201
idstringrequirednumbernull | stringrequiredtitlenull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredcontractTypestringrequiredcategorystring | nullrequiredstatusstringrequiredsignedOnnull | stringrequireddatevalidFromnull | stringrequireddatevalidTonull | stringrequireddateeffectiveValidTonull | stringrequireddatenoticeDaysinteger | nullrequiredremindDaysinteger | nullrequiredvalueHalerinteger | nullrequiredeffectiveValueHalerinteger | nullrequiredcurrencynull | stringrequiredexternalNumberstring | nullrequirednotestring | nullrequiredamendmentCountintegerrequiredamendmentsobject[]requiredobject"contract_amendment"requiredidstringrequiredcontractIdstringrequiredpositionintegerrequiredtitlestringrequiredsignedOnstring | nullrequiredeffectiveFromstring | nullrequirednewValidTonull | stringrequireddatevalueChangeHalerinteger | nullrequirednotestring | nullrequiredcreatedAtstringrequireddate-timecreatedAtstringrequireddate-timeGet a contract with its amendments
/v1/contracts/{id}Get a contract with its amendments
MCP tool: get-contract
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredtitlenull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredcontractTypestringrequiredcategorystring | nullrequiredstatusstringrequiredsignedOnnull | stringrequireddatevalidFromnull | stringrequireddatevalidTonull | stringrequireddateeffectiveValidTonull | stringrequireddatenoticeDaysinteger | nullrequiredremindDaysinteger | nullrequiredvalueHalerinteger | nullrequiredeffectiveValueHalerinteger | nullrequiredcurrencynull | stringrequiredexternalNumberstring | nullrequirednotestring | nullrequiredamendmentCountintegerrequiredamendmentsobject[]requiredobject"contract_amendment"requiredidstringrequiredcontractIdstringrequiredpositionintegerrequiredtitlestringrequiredsignedOnstring | nullrequiredeffectiveFromstring | nullrequirednewValidTonull | stringrequireddatevalueChangeHalerinteger | nullrequirednotestring | nullrequiredcreatedAtstringrequireddate-timecreatedAtstringrequireddate-timeChange a contract, including ending or terminating it
/v1/contracts/{id}Change a contract, including ending or terminating it
MCP tool: update-contract
Path parameters
idstringrequiredRequest body
titlestringmax 200 charscontactIdstring | nullcontractType"sale" | "purchase" | "work" | "service" | "lease" | "loan" | "framework" | "nda" | "other"categorystring | nullstatus"draft" | "active" | "ended" | "terminated"signedOnstring | nullvalidFromstring | nullvalidTostring | nullnoticeDaysinteger | nullremindDaysinteger | nullvalueHalerinteger | nullcurrencystring3 charsexternalNumberstring | nullnotestring | nullResponse · 200
idstringrequirednumbernull | stringrequiredtitlenull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredcontractTypestringrequiredcategorystring | nullrequiredstatusstringrequiredsignedOnnull | stringrequireddatevalidFromnull | stringrequireddatevalidTonull | stringrequireddateeffectiveValidTonull | stringrequireddatenoticeDaysinteger | nullrequiredremindDaysinteger | nullrequiredvalueHalerinteger | nullrequiredeffectiveValueHalerinteger | nullrequiredcurrencynull | stringrequiredexternalNumberstring | nullrequirednotestring | nullrequiredamendmentCountintegerrequiredamendmentsobject[]requiredobject"contract_amendment"requiredidstringrequiredcontractIdstringrequiredpositionintegerrequiredtitlestringrequiredsignedOnstring | nullrequiredeffectiveFromstring | nullrequirednewValidTonull | stringrequireddatevalueChangeHalerinteger | nullrequirednotestring | nullrequiredcreatedAtstringrequireddate-timecreatedAtstringrequireddate-timeDelete a contract recorded by mistake, with its amendments. An ended contract is kept by setting its status
/v1/contracts/{id}Delete a contract recorded by mistake, with its amendments. An ended contract is kept by setting its status
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-contract
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredAdd an amendment (dodatek) to a contract. It can move the end date and change the value
/v1/contracts/{id}/amendmentsAdd an amendment (dodatek) to a contract. It can move the end date and change the value
MCP tool: create-contract-amendment
Path parameters
idstringrequiredRequest body
titlestringrequiredmax 200 charssignedOnstring | nulleffectiveFromstring | nullnewValidTostring | nullvalueChangeHalerinteger | nullnotestring | nullResponse · 201
idstringrequiredcontractIdstringrequiredpositionintegerrequiredtitlestringrequiredsignedOnstring | nullrequiredeffectiveFromstring | nullrequirednewValidTonull | stringrequireddatevalueChangeHalerinteger | nullrequirednotestring | nullrequiredcreatedAtstringrequireddate-timeList the custom fields a company defined, optionally for one kind of record. Most companies have none
/v1/custom-fieldsList the custom fields a company defined, optionally for one kind of record. Most companies have none
MCP tool: list-custom-fields
Query parameters
entity"contact" | "item" | "invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "sales_document" | "supplier_advance" | "stock_document" | "complaint" | "service_job"limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"custom_field"requiredidstringrequiredentitystringrequiredkeystringrequiredlabelnull | stringrequiredkindstringrequiredoptionsstring[]requiredpositioninteger | nullrequiredisActivebooleanrequiredsearchablebooleanrequiredprintedbooleanrequiredtotalintegerhasMorebooleanrequiredDefine a custom field: text, number, date, or a choice from options, on contacts, items, or one kind of document
/v1/custom-fieldsDefine a custom field: text, number, date, or a choice from options, on contacts, items, or one kind of document
MCP tool: create-custom-field
Request body
entity"contact" | "item" | "invoice" | "received_invoice" | "proforma" | "credit_note" | "delivery_note" | "sales_document" | "supplier_advance" | "stock_document" | "complaint" | "service_job"requiredkeystringlabelstringrequiredmax 80 charskind"text" | "number" | "date" | "choice"requiredoptionsstring[]positionintegermin 0max 1000searchablebooleanprintedbooleanResponse · 201
idstringrequiredentitystringrequiredkeystringrequiredlabelnull | stringrequiredkindstringrequiredoptionsstring[]requiredpositioninteger | nullrequiredisActivebooleanrequiredsearchablebooleanrequiredprintedbooleanrequiredRename a custom field, change its options, or switch it off. Stored values stay
/v1/custom-fields/{id}Rename a custom field, change its options, or switch it off. Stored values stay
MCP tool: update-custom-field
Path parameters
idstringrequiredRequest body
searchablebooleanprintedbooleanlabelstringmax 80 charsoptionsstring[]positionintegermin 0max 1000isActivebooleanResponse · 200
idstringrequiredentitystringrequiredkeystringrequiredlabelnull | stringrequiredkindstringrequiredoptionsstring[]requiredpositioninteger | nullrequiredisActivebooleanrequiredsearchablebooleanrequiredprintedbooleanrequiredDelete a custom field definition. Values already stored stay on the records and in exports, and are no longer shown
/v1/custom-fields/{id}Delete a custom field definition. Values already stored stay on the records and in exports, and are no longer shown
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-custom-field
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredSet custom field values on one record. Pass only the fields to change, null clears one. Works on issued documents too: it changes nothing they say
/v1/custom-fields/values/{entity}/{id}Set custom field values on one record. Pass only the fields to change, null clears one. Works on issued documents too: it changes nothing they say
MCP tool: set-custom-field-values
Path parameters
entitystringrequiredidstringrequiredRequest body
valuesobjectrequiredResponse · 200
entitystringrequiredidstringrequiredvaluesobjectrequiredregionnull | stringslevaintegersmlouva_odstringdatepoznamka_obchodustringvyrobcestringzakazka_zakaznikastringcislo_zakaznikastringtajnestringakcestringregalstringstavbastringcislo_stavbystringinternistringterminstringdateoblaststringstavba_zalohystringtistene_polestringSearch the document archive by title, file name, note, or the words inside PDF, Office, text and XML files; filter by what it is attached to, date, or retention
/v1/documentsSearch the document archive by title, file name, note, or the words inside PDF, Office, text and XML files; filter by what it is attached to, date, or retention
MCP tool: list-document-attachments
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDentityKind"archive" | "employee" | "payroll_run" | "asset" | "cash_document" | "contact" | "contract" | "invoice" | "received_invoice" | "proforma" | "supplier_advance" | "credit_note" | "delivery_note" | "sales_document" | "stock_document" | "job_order" | "complaint" | "service_job"entityIdstringretention"expired" | "kept" | "held"Response · 200
dataobject[]requiredobject"document_attachment"requiredidstringrequiredentityKindstringrequiredentityIdnull | stringrequiredtitlestringrequiredfilenamestringrequirednotestring | nullrequireddocumentDatestringrequireddatecontentTypestringrequiredbyteSizeinteger | nullrequiredretentionRulestringrequiredretentionCitationnull | stringrequiredretentionYearsinteger | nullrequiredretentionUntilnull | stringrequireddateretentionExpiredbooleanrequiredcreatedAtstringrequireddate-timescanStatusnull | stringcontentStatenull | stringretentionHoldnull | objectidstringrequiredreasonnull | stringrequiredcitationstringrequiredtotalintegerhasMorebooleanrequiredUpload a file to the archive, optionally attached to a document or contact. Its retention date follows from the type and date
/v1/documentsUpload a file to the archive, optionally attached to a document or contact. Its retention date follows from the type and date. fileBase64 up to 25 MB. Without retentionRule the type follows from what it is attached to. The custom rule takes retentionUntil.
MCP tool: upload-document-attachment
Request body
entityKind"archive" | "employee" | "payroll_run" | "asset" | "cash_document" | "contact" | "contract" | "invoice" | "received_invoice" | "proforma" | "supplier_advance" | "credit_note" | "delivery_note" | "sales_document" | "stock_document" | "job_order" | "complaint" | "service_job"entityIdstring | nullfilenamestringrequiredmax 255 charscontentTypestringrequiredmax 120 charsfileBase64stringrequiredtitlestring | nullnotestring | nullretentionRule"accounting_statement" | "accounting_document" | "accounting_method" | "vat_document" | "insurance_record" | "payroll_record" | "custom"documentDatestringYYYY-MM-DDretentionUntilstring | nullResponse · 201
idstringrequiredentityKindstringrequiredentityIdnull | stringrequiredtitlestringrequiredfilenamestringrequirednotestring | nullrequireddocumentDatestringrequireddatecontentTypestringrequiredbyteSizeinteger | nullrequiredretentionRulestringrequiredretentionCitationnull | stringrequiredretentionYearsinteger | nullrequiredretentionUntilnull | stringrequireddateretentionExpiredbooleanrequiredcreatedAtstringrequireddate-timescanStatusnull | stringcontentStatenull | stringretentionHoldnull | objectidstringrequiredreasonnull | stringrequiredcitationstringrequiredGet a document
/v1/documents/{id}Get a document
MCP tool: get-document-attachment
Path parameters
idstringrequiredResponse · 200
idstringrequiredentityKindstringrequiredentityIdnull | stringrequiredtitlestringrequiredfilenamestringrequirednotestring | nullrequireddocumentDatestringrequireddatecontentTypestringrequiredbyteSizeinteger | nullrequiredretentionRulestringrequiredretentionCitationnull | stringrequiredretentionYearsinteger | nullrequiredretentionUntilnull | stringrequireddateretentionExpiredbooleanrequiredcreatedAtstringrequireddate-timescanStatusnull | stringcontentStatenull | stringretentionHoldnull | objectidstringrequiredreasonnull | stringrequiredcitationstringrequiredChange the title, note, date, or retention type of a document
/v1/documents/{id}Change the title, note, date, or retention type of a document
MCP tool: update-document-attachment
Path parameters
idstringrequiredRequest body
titlestring | nullnotestring | nullretentionRule"accounting_statement" | "accounting_document" | "accounting_method" | "vat_document" | "insurance_record" | "payroll_record" | "custom"documentDatestringYYYY-MM-DDretentionUntilstring | nullResponse · 200
idstringrequiredentityKindstringrequiredentityIdnull | stringrequiredtitlestringrequiredfilenamestringrequirednotestring | nullrequireddocumentDatestringrequireddatecontentTypestringrequiredbyteSizeinteger | nullrequiredretentionRulestringrequiredretentionCitationnull | stringrequiredretentionYearsinteger | nullrequiredretentionUntilnull | stringrequireddateretentionExpiredbooleanrequiredcreatedAtstringrequireddate-timescanStatusnull | stringcontentStatenull | stringretentionHoldnull | objectidstringrequiredreasonnull | stringrequiredcitationstringrequiredShred a document, removing the file. Refused while the statutory retention period runs, or while an inspection or dispute holds it
/v1/documents/{id}Shred a document, removing the file. Refused while the statutory retention period runs, or while an inspection or dispute holds it
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-document-attachment
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredDownload a document
/v1/documents/{id}/downloadDownload a document
MCP tool: download-document-attachment
Path parameters
idstringrequiredResponse · 200
Returns a application/octet-stream file.
List what keeps documents past their period: an inspection, a dispute, a complaint, an unpaid debt
/v1/documents/retention-holdsList what keeps documents past their period: an inspection, a dispute, a complaint, an unpaid debt
MCP tool: list-retention-holds
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"retention_hold"requiredidstringrequiredreasonstringrequiredcoversFromnull | stringrequireddatecoversTonull | stringrequireddateuntilnull | stringrequireddatenotenull | stringrequiredcitationnull | stringrequiredactivebooleanrequiredreleasedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredKeep documents of a period past their retention, for an inspection or a dispute. Until it ends, none of them can be shredded, whatever its type
/v1/documents/retention-holdsKeep documents of a period past their retention, for an inspection or a dispute. Until it ends, none of them can be shredded, whatever its type. No dates means every document. It covers documents by their date, so what is uploaded later falls under it too. The law names no end date for these, so it holds until `until` or until it is released. Citation: § 32 of zákon 563/1991 Sb., § 148 of zákon 280/2009 Sb.
MCP tool: create-retention-hold
Request body
reason"inspection" | "dispute" | "complaint" | "unpaid" | "other"requiredcoversFromstring | nullcoversTostring | nulluntilstring | nullnotestring | nullResponse · 201
idstringrequiredreasonstringrequiredcoversFromnull | stringrequireddatecoversTonull | stringrequireddateuntilnull | stringrequireddatenotenull | stringrequiredcitationnull | stringrequiredactivebooleanrequiredreleasedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeEnd an extended retention once the inspection or dispute is over. Ordinary periods apply again
/v1/documents/retention-holds/{id}/releaseEnd an extended retention once the inspection or dispute is over. Ordinary periods apply again
MCP tool: release-retention-hold
Path parameters
idstringrequiredResponse · 200
idstringrequiredreasonstringrequiredcoversFromnull | stringrequireddatecoversTonull | stringrequireddateuntilnull | stringrequireddatenotenull | stringrequiredcitationnull | stringrequiredactivebooleanrequiredreleasedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeStatutory retention periods (skartační lhůty) with their legal citation
/v1/documents/retention-rulesStatutory retention periods (skartační lhůty) with their legal citation
MCP tool: list-retention-rules
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"retention_rule"requiredkeystringrequiredyearsinteger | nullrequiredcitationnull | stringrequiredcsstringrequiredenstringrequiredtotalintegerhasMorebooleanrequiredList contacts by the state of their GDPR reasons (none, valid, expiring, expired, future, or restricted), on a given day, or by POHODA's searches over chosen reasons
/v1/gdpr/contactsList contacts by the state of their GDPR reasons (none, valid, expiring, expired, future, or restricted), on a given day, or by POHODA's searches over chosen reasons
MCP tool: list-contacts-gdpr
Query parameters
state"none" | "valid" | "expiring" | "expired" | "future" | "restricted"asOfstringYYYY-MM-DDreasonIdstringmatch"all_valid" | "any_valid" | "any_of" | "all_of" | "expired" | "no_reason"reasonIdsstringmax 2000 charsincludeNoReason"true" | "false"includeDocuments"true" | "false"limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"contact_gdpr_row"requiredidstringrequirednamenull | stringrequiredstatestringrequiredreasonCountintegerrequiredmarketingOptOutbooleanrequiredtotalintegerhasMorebooleanrequiredList the company list of reasons for processing that a reason on a contact is picked from. A company without any gets four to start from
/v1/gdpr/reasonsList the company list of reasons for processing that a reason on a contact is picked from. A company without any gets four to start from
MCP tool: list-gdpr-reason-codes
Query parameters
active"true" | "false"limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"gdpr_reason_code"requiredidstringrequirednamestringrequiredlegalBasisstringrequireddescriptionnull | stringrequiredvalidityMonthsinteger | nullrequiredisActivebooleanrequiredtotalintegerhasMorebooleanrequiredAdd a reason for processing to the company list: its name, legal basis, description, and how long it lasts
/v1/gdpr/reasonsAdd a reason for processing to the company list: its name, legal basis, description, and how long it lasts
MCP tool: create-gdpr-reason-code
Request body
namestringrequiredmax 200 charslegalBasis"consent" | "contract" | "legal_obligation" | "vital_interest" | "public_task" | "legitimate_interest"requireddescriptionstring | nullvalidityMonthsinteger | nullisActivebooleanResponse · 201
idstringrequirednamestringrequiredlegalBasisstringrequireddescriptionnull | stringrequiredvalidityMonthsinteger | nullrequiredisActivebooleanrequiredChange a reason on the company list or stop offering it. Reasons already on contacts keep what they said
/v1/gdpr/reasons/{id}Change a reason on the company list or stop offering it. Reasons already on contacts keep what they said
MCP tool: update-gdpr-reason-code
Path parameters
idstringrequiredRequest body
namestringmax 200 charslegalBasis"consent" | "contract" | "legal_obligation" | "vital_interest" | "public_task" | "legitimate_interest"descriptionstring | nullvalidityMonthsinteger | nullisActivebooleanResponse · 200
idstringrequirednamestringrequiredlegalBasisstringrequireddescriptionnull | stringrequiredvalidityMonthsinteger | nullrequiredisActivebooleanrequiredRemove a reason from the company list. One already used on a contact stays and can only be stopped being offered
/v1/gdpr/reasons/{id}Remove a reason from the company list. One already used on a contact stays and can only be stopped being offered
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-gdpr-reason-code
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredSend a document still in the inbox for approval, before any invoice is made from it. Until it is approved it cannot become a document; once approved, the document made from it is approved too
/v1/inbox/documents/{id}/approvalSend a document still in the inbox for approval, before any invoice is made from it. Until it is approved it cannot become a document; once approved, the document made from it is approved too
MCP tool: request-inbox-document-approval
Path parameters
idstringrequiredRequest body
approverIdstring | nullscenarioIdstring | nullcommentstring | nullResponse · 201
idstringrequireddocumentKindnull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredstatusstringrequiredapproverIdnull | stringrequiredapproverNamenull | stringrequiredcommentnull | stringrequireddecidedByIdnull | stringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeinvoicenull | objectrequiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredstatusstringrequiredscenarioIdnull | stringcurrentStepinteger | nullstepCountinteger | nullsalesDocumentIdnull | stringinboxDocumentIdnull | stringwaitingOnobject[]idstringrequirednamenull | stringrequiredkindstringrequiredhistoryobject[]actionstringrequiredactorNamenull | stringrequiredcommentnull | stringrequiredatstringrequireddate-timestepsobject[]positioninteger | nullrequiredapproverIdnull | stringrequiredapproverNamestringrequiredstatusstringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecommentnull | stringrequiredstageintegermodestringkindstringdecidedForNamenull | stringThe credit notes of a month: which brought goods back (reported with code 21), and which only changed a price, with whether the original declaration must be corrected (over 5 %, or the whole price)
/v1/intrastat/creditsThe credit notes of a month: which brought goods back (reported with code 21), and which only changed a price, with whether the original declaration must be corrected (over 5 %, or the whole price)
MCP tool: list-intrastat-credits
Query parameters
yearintegerrequiredmin 2020max 2100monthintegerrequiredmin 1max 12limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredkindstringrequireddocumentIdnull | stringrequirednumbernull | stringrequiredcontactNamenull | stringrequiredtaxPointDatenull | stringrequireddatecreditKindnull | stringrequireddirectionstringrequiredvalueHalerinteger | nullrequiredcorrectsDirectionstringcorrectsYearintegercorrectsMonthintegeroriginalNumbernull | stringpercentinteger | nullfullbooleanmustCorrectbooleantotalintegerhasMorebooleanrequiredList Intrastat declarations
/v1/intrastat/declarationsList Intrastat declarations
MCP tool: list-intrastat-declarations
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDyearintegermin -9007199254740991max 9007199254740991direction"dispatch" | "arrival"Response · 200
dataobject[]requiredobject"intrastat_declaration"requiredidstringrequiredyearintegerrequiredmonthintegerrequireddirectionstringrequiredkindstringrequiredstatusstringrequireddeadlinestringrequireddatefiledAtnull | stringrequireddate-timelinesobject[]requiredobject"intrastat_line"requiredidstringrequiredsourcestringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredcountryCodenull | stringrequiredoriginCountrynull | stringrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredrecordTypestringrequiredpartnerVatnull | stringrequireddescriptionnull | stringrequiredmassGramsintegerrequiredsupplementaryMilliintegerrequiredvalueHalerintegerrequireddocumentNumbersstring[]requiredproblemsstring[]requiredtotalValueHalerintegerrequiredproblemCountintegerrequiredtotalintegerhasMorebooleanrequiredPrepare the declaration for a month and direction from EU goods invoices. Kind negative or simplified carries no goods lines
/v1/intrastat/declarationsPrepare the declaration for a month and direction from EU goods invoices. Kind negative or simplified carries no goods lines
MCP tool: create-intrastat-declaration
Request body
yearintegerrequiredmin 2020max 2100monthintegerrequiredmin 1max 12direction"dispatch" | "arrival"requiredkind"standard" | "negative" | "simplified"Response · 201
idstringrequiredyearintegerrequiredmonthintegerrequireddirectionstringrequiredkindstringrequiredstatusstringrequireddeadlinestringrequireddatefiledAtnull | stringrequireddate-timelinesobject[]requiredobject"intrastat_line"requiredidstringrequiredsourcestringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredcountryCodenull | stringrequiredoriginCountrynull | stringrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredrecordTypestringrequiredpartnerVatnull | stringrequireddescriptionnull | stringrequiredmassGramsintegerrequiredsupplementaryMilliintegerrequiredvalueHalerintegerrequireddocumentNumbersstring[]requiredproblemsstring[]requiredtotalValueHalerintegerrequiredproblemCountintegerrequiredGet a declaration with its lines and what stops each line from being filed
/v1/intrastat/declarations/{id}Get a declaration with its lines and what stops each line from being filed
MCP tool: get-intrastat-declaration
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequireddirectionstringrequiredkindstringrequiredstatusstringrequireddeadlinestringrequireddatefiledAtnull | stringrequireddate-timelinesobject[]requiredobject"intrastat_line"requiredidstringrequiredsourcestringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredcountryCodenull | stringrequiredoriginCountrynull | stringrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredrecordTypestringrequiredpartnerVatnull | stringrequireddescriptionnull | stringrequiredmassGramsintegerrequiredsupplementaryMilliintegerrequiredvalueHalerintegerrequireddocumentNumbersstring[]requiredproblemsstring[]requiredtotalValueHalerintegerrequiredproblemCountintegerrequiredDelete a declaration that has not been filed
/v1/intrastat/declarations/{id}Delete a declaration that has not been filed
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-intrastat-declaration
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredDownload the declaration as the CSV file that InstatEvo imports (structure valid from 1 January 2026)
/v1/intrastat/declarations/{id}/csvDownload the declaration as the CSV file that InstatEvo imports (structure valid from 1 January 2026)
MCP tool: download-intrastat-csv
Path parameters
idstringrequiredResponse · 200
Returns a text/csv file.
Mark a declaration as filed in InstatEvo and lock it. Filing itself happens in the customs application; this API cannot submit
/v1/intrastat/declarations/{id}/fileMark a declaration as filed in InstatEvo and lock it. Filing itself happens in the customs application; this API cannot submit
MCP tool: mark-intrastat-filed
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequireddirectionstringrequiredkindstringrequiredstatusstringrequireddeadlinestringrequireddatefiledAtnull | stringrequireddate-timelinesobject[]requiredobject"intrastat_line"requiredidstringrequiredsourcestringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredcountryCodenull | stringrequiredoriginCountrynull | stringrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredrecordTypestringrequiredpartnerVatnull | stringrequireddescriptionnull | stringrequiredmassGramsintegerrequiredsupplementaryMilliintegerrequiredvalueHalerintegerrequireddocumentNumbersstring[]requiredproblemsstring[]requiredtotalValueHalerintegerrequiredproblemCountintegerrequiredAdd a line by hand: a return (21), a free replacement (22, 23), or goods without an invoice
/v1/intrastat/declarations/{id}/linesAdd a line by hand: a return (21), a free replacement (22, 23), or goods without an invoice
MCP tool: add-intrastat-line
Path parameters
idstringrequiredRequest body
commodityCodestring | nullstatisticalSignstring | nullcountryCodestring | nulloriginCountrystring | nulltransaction"11" | "12" | "21" | "22" | "23" | "31" | "32" | "33" | "34" | "41" | "42" | "51" | "52" | "71" | "72" | "80" | "91" | "99" | nulltransport"2" | "3" | "4" | "5" | "7" | "8" | "9" | nulldeliveryTerms"K" | "L" | "M" | "N" | nullrecordType"ST" | "MZ" | "ZI" | "ZR" | "ZL" | "ZP" | "ZZ" | "ZT" | "ZM" | "ZK" | "ZO"partnerVatstring | nulldescriptionstring | nullmassGramsintegermin 0max 9007199254740991supplementaryMilliintegermin 0max 9007199254740991valueHalerintegermin 0max 9007199254740991Response · 201
idstringrequiredyearintegerrequiredmonthintegerrequireddirectionstringrequiredkindstringrequiredstatusstringrequireddeadlinestringrequireddatefiledAtnull | stringrequireddate-timelinesobject[]requiredobject"intrastat_line"requiredidstringrequiredsourcestringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredcountryCodenull | stringrequiredoriginCountrynull | stringrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredrecordTypestringrequiredpartnerVatnull | stringrequireddescriptionnull | stringrequiredmassGramsintegerrequiredsupplementaryMilliintegerrequiredvalueHalerintegerrequireddocumentNumbersstring[]requiredproblemsstring[]requiredtotalValueHalerintegerrequiredproblemCountintegerrequiredCorrect a line of a draft declaration. Reading the documents again replaces corrections to generated lines: fix the item or document data to keep them
/v1/intrastat/declarations/{id}/lines/{lineId}Correct a line of a draft declaration. Reading the documents again replaces corrections to generated lines: fix the item or document data to keep them
MCP tool: update-intrastat-line
Path parameters
idstringrequiredlineIdstringrequiredRequest body
commodityCodestring | nullstatisticalSignstring | nullcountryCodestring | nulloriginCountrystring | nulltransaction"11" | "12" | "21" | "22" | "23" | "31" | "32" | "33" | "34" | "41" | "42" | "51" | "52" | "71" | "72" | "80" | "91" | "99" | nulltransport"2" | "3" | "4" | "5" | "7" | "8" | "9" | nulldeliveryTerms"K" | "L" | "M" | "N" | nullrecordType"ST" | "MZ" | "ZI" | "ZR" | "ZL" | "ZP" | "ZZ" | "ZT" | "ZM" | "ZK" | "ZO"partnerVatstring | nulldescriptionstring | nullmassGramsintegermin 0max 9007199254740991supplementaryMilliintegermin 0max 9007199254740991valueHalerintegermin 0max 9007199254740991Response · 200
idstringrequiredyearintegerrequiredmonthintegerrequireddirectionstringrequiredkindstringrequiredstatusstringrequireddeadlinestringrequireddatefiledAtnull | stringrequireddate-timelinesobject[]requiredobject"intrastat_line"requiredidstringrequiredsourcestringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredcountryCodenull | stringrequiredoriginCountrynull | stringrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredrecordTypestringrequiredpartnerVatnull | stringrequireddescriptionnull | stringrequiredmassGramsintegerrequiredsupplementaryMilliintegerrequiredvalueHalerintegerrequireddocumentNumbersstring[]requiredproblemsstring[]requiredtotalValueHalerintegerrequiredproblemCountintegerrequiredRemove a line of a draft declaration
/v1/intrastat/declarations/{id}/lines/{lineId}Remove a line of a draft declaration
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: remove-intrastat-line
Path parameters
idstringrequiredlineIdstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequireddirectionstringrequiredkindstringrequiredstatusstringrequireddeadlinestringrequireddatefiledAtnull | stringrequireddate-timelinesobject[]requiredobject"intrastat_line"requiredidstringrequiredsourcestringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredcountryCodenull | stringrequiredoriginCountrynull | stringrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredrecordTypestringrequiredpartnerVatnull | stringrequireddescriptionnull | stringrequiredmassGramsintegerrequiredsupplementaryMilliintegerrequiredvalueHalerintegerrequireddocumentNumbersstring[]requiredproblemsstring[]requiredtotalValueHalerintegerrequiredproblemCountintegerrequiredRead the documents again after changing item or document data. Manual lines stay
/v1/intrastat/declarations/{id}/regenerateRead the documents again after changing item or document data. Manual lines stay
MCP tool: regenerate-intrastat-declaration
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequireddirectionstringrequiredkindstringrequiredstatusstringrequireddeadlinestringrequireddatefiledAtnull | stringrequireddate-timelinesobject[]requiredobject"intrastat_line"requiredidstringrequiredsourcestringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredcountryCodenull | stringrequiredoriginCountrynull | stringrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredrecordTypestringrequiredpartnerVatnull | stringrequireddescriptionnull | stringrequiredmassGramsintegerrequiredsupplementaryMilliintegerrequiredvalueHalerintegerrequireddocumentNumbersstring[]requiredproblemsstring[]requiredtotalValueHalerintegerrequiredproblemCountintegerrequiredUnlock a filed declaration to correct it. A correction must also be sent in InstatEvo
/v1/intrastat/declarations/{id}/reopenUnlock a filed declaration to correct it. A correction must also be sent in InstatEvo
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: reopen-intrastat-declaration
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequireddirectionstringrequiredkindstringrequiredstatusstringrequireddeadlinestringrequireddatefiledAtnull | stringrequireddate-timelinesobject[]requiredobject"intrastat_line"requiredidstringrequiredsourcestringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredcountryCodenull | stringrequiredoriginCountrynull | stringrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredrecordTypestringrequiredpartnerVatnull | stringrequireddescriptionnull | stringrequiredmassGramsintegerrequiredsupplementaryMilliintegerrequiredvalueHalerintegerrequireddocumentNumbersstring[]requiredproblemsstring[]requiredtotalValueHalerintegerrequiredproblemCountintegerrequiredSet the default transaction nature, transport, and delivery terms used for documents without their own
/v1/intrastat/defaultsSet the default transaction nature, transport, and delivery terms used for documents without their own
MCP tool: update-intrastat-defaults
Request body
transaction"11" | "12" | "21" | "22" | "23" | "31" | "32" | "33" | "34" | "41" | "42" | "51" | "52" | "71" | "72" | "80" | "91" | "99"requiredtransport"2" | "3" | "4" | "5" | "7" | "8" | "9"requireddeliveryTerms"K" | "L" | "M" | "N"requiredResponse · 200
transactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequiredGet the Intrastat data of a document: transaction nature, transport, delivery terms, or that it is excluded
/v1/intrastat/documents/{kind}/{id}Get the Intrastat data of a document: transaction nature, transport, delivery terms, or that it is excluded
MCP tool: get-intrastat-document
Path parameters
kindstringrequiredidstringrequiredResponse · 200
kindstringrequireddocumentIdnull | stringrequiredtransactionstringtransportnull | stringdeliveryTermsnull | stringcountryCodenull | stringexcludedbooleanrequiredcreditKindnull | stringSet the Intrastat data of a document, overriding the defaults, or exclude it from declarations
/v1/intrastat/documents/{kind}/{id}Set the Intrastat data of a document, overriding the defaults, or exclude it from declarations
MCP tool: update-intrastat-document
Path parameters
kindstringrequiredidstringrequiredRequest body
transaction"11" | "12" | "21" | "22" | "23" | "31" | "32" | "33" | "34" | "41" | "42" | "51" | "52" | "71" | "72" | "80" | "91" | "99" | nulltransport"2" | "3" | "4" | "5" | "7" | "8" | "9" | nulldeliveryTerms"K" | "L" | "M" | "N" | nullcountryCodestring | nullexcludedbooleancreditKind"return" | "price" | nullResponse · 200
kindstringrequireddocumentIdnull | stringrequiredtransactionstringtransportnull | stringdeliveryTermsnull | stringcountryCodenull | stringexcludedbooleanrequiredcreditKindnull | stringGet the Intrastat data of a stock item: commodity code, mass per unit, country of origin
/v1/intrastat/items/{itemId}Get the Intrastat data of a stock item: commodity code, mass per unit, country of origin
MCP tool: get-intrastat-item
Path parameters
itemIdstringrequiredResponse · 200
itemIdnull | stringrequiredskustringrequirednamenull | stringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredoriginCountrynull | stringrequiredmassGramsinteger | nullrequiredsupplementaryMilliinteger | nullrequiredSet the Intrastat data of a stock item
/v1/intrastat/items/{itemId}Set the Intrastat data of a stock item
MCP tool: update-intrastat-item
Path parameters
itemIdstringrequiredRequest body
commodityCodestring | nullstatisticalSignstring | nulloriginCountrystring | nullmassGramsinteger | nullsupplementaryMilliinteger | nullResponse · 200
itemIdnull | stringrequiredskustringrequirednamenull | stringrequiredcommodityCodenull | stringrequiredstatisticalSignstring | nullrequiredoriginCountrynull | stringrequiredmassGramsinteger | nullrequiredsupplementaryMilliinteger | nullrequiredWhether Intrastat is due this month in each direction: running total against the 15 million CZK threshold, duty carried from last year, deadline
/v1/intrastat/statusWhether Intrastat is due this month in each direction: running total against the 15 million CZK threshold, duty carried from last year, deadline
MCP tool: get-intrastat-status
Query parameters
yearintegermin 2020max 2100monthintegermin 1max 12Response · 200
yearintegerrequiredmonthinteger | nullrequiredthresholdHalerintegerrequiredsimplifiedLimitHalerintegerrequireddeadlinestringrequireddatevatRegisteredbooleanrequireddefaultsobjectrequiredtransactionstringrequiredtransportnull | stringrequireddeliveryTermsnull | stringrequireddispatchobjectrequireddirectionstringrequiredmonthsobjectrequiredpreviousYearHalerintegerrequiredyearintegerrequiredmonthinteger | nullrequiredrequiredbooleanrequiredcarriedOverbooleanrequiredreachedInMonthinteger | nullrequiredfirstMonthinteger | nullrequiredrunningHalerintegerrequiredyearTotalHalerintegerrequiredthresholdHalerintegerrequiredremainingHalerinteger | nullrequiredsimplifiedPossiblebooleanrequiredrequiredUntilYearinteger | nullrequireddeadlinestringrequireddatesimplifiedBlockersstring[]coveredBySimplifiedbooleanarrivalobjectrequireddirectionstringrequiredmonthsobjectrequiredpreviousYearHalerintegerrequiredyearintegerrequiredmonthinteger | nullrequiredrequiredbooleanrequiredcarriedOverbooleanrequiredreachedInMonthanyrequiredfirstMonthanyrequiredrunningHalerintegerrequiredyearTotalHalerintegerrequiredthresholdHalerintegerrequiredremainingHalerinteger | nullrequiredsimplifiedPossiblebooleanrequiredrequiredUntilYearanyrequireddeadlinestringrequireddatesimplifiedBlockersany[]coveredBySimplifiedbooleanList received invoices and advances to suppliers in approval, with their status and approver
/v1/invoice-approvalsList received invoices and advances to suppliers in approval, with their status and approver
MCP tool: list-invoice-approvals
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"pending" | "approved" | "rejected" | "cancelled"Response · 200
dataobject[]requiredobject"invoice_approval"requiredidstringrequireddocumentKindnull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredstatusstringrequiredapproverIdnull | stringrequiredapproverNamenull | stringrequiredcommentnull | stringrequireddecidedByIdnull | stringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeinvoicenull | objectrequiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredstatusstringrequiredscenarioIdnull | stringcurrentStepinteger | nullstepCountinteger | nullsalesDocumentIdnull | stringinboxDocumentIdnull | stringwaitingOnobject[]idstringrequirednamenull | stringrequiredkindstringrequiredhistoryobject[]actionstringrequiredactorNamenull | stringrequiredcommentnull | stringrequiredatstringrequireddate-timestepsobject[]positioninteger | nullrequiredapproverIdnull | stringrequiredapproverNamestringrequiredstatusstringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecommentnull | stringrequiredstageintegermodestringkindstringdecidedForNamenull | stringtotalintegerhasMorebooleanrequiredGet one approval with its history
/v1/invoice-approvals/{id}Get one approval with its history
MCP tool: get-invoice-approval
Path parameters
idstringrequiredResponse · 200
idstringrequireddocumentKindnull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredstatusstringrequiredapproverIdnull | stringrequiredapproverNamenull | stringrequiredcommentnull | stringrequireddecidedByIdnull | stringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeinvoicenull | objectrequiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredstatusstringrequiredscenarioIdnull | stringcurrentStepinteger | nullstepCountinteger | nullsalesDocumentIdnull | stringinboxDocumentIdnull | stringwaitingOnobject[]idstringrequirednamenull | stringrequiredkindstringrequiredhistoryobject[]actionstringrequiredactorNamenull | stringrequiredcommentnull | stringrequiredatstringrequireddate-timestepsobject[]positioninteger | nullrequiredapproverIdnull | stringrequiredapproverNamestringrequiredstatusstringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecommentnull | stringrequiredstageintegermodestringkindstringdecidedForNamenull | stringApprove a received invoice or an advance to a supplier for payment, or one step of its scenario. Only the named approver, an owner, or an accountant can, and one person decides one step
/v1/invoice-approvals/{id}/approveApprove a received invoice or an advance to a supplier for payment, or one step of its scenario. Only the named approver, an owner, or an accountant can, and one person decides one step
MCP tool: approve-invoice
Path parameters
idstringrequiredRequest body
commentstring | nullResponse · 200
idstringrequireddocumentKindnull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredstatusstringrequiredapproverIdnull | stringrequiredapproverNamenull | stringrequiredcommentnull | stringrequireddecidedByIdnull | stringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeinvoicenull | objectrequiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredstatusstringrequiredscenarioIdnull | stringcurrentStepinteger | nullstepCountinteger | nullsalesDocumentIdnull | stringinboxDocumentIdnull | stringwaitingOnobject[]idstringrequirednamenull | stringrequiredkindstringrequiredhistoryobject[]actionstringrequiredactorNamenull | stringrequiredcommentnull | stringrequiredatstringrequireddate-timestepsobject[]positioninteger | nullrequiredapproverIdnull | stringrequiredapproverNamestringrequiredstatusstringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecommentnull | stringrequiredstageintegermodestringkindstringdecidedForNamenull | stringReject a received invoice or an advance to a supplier with a comment. It stays out of payment orders until sent for approval again
/v1/invoice-approvals/{id}/rejectReject a received invoice or an advance to a supplier with a comment. It stays out of payment orders until sent for approval again
MCP tool: reject-invoice
Path parameters
idstringrequiredRequest body
commentstringrequiredmax 2000 charsResponse · 200
idstringrequireddocumentKindnull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredstatusstringrequiredapproverIdnull | stringrequiredapproverNamenull | stringrequiredcommentnull | stringrequireddecidedByIdnull | stringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeinvoicenull | objectrequiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredstatusstringrequiredscenarioIdnull | stringcurrentStepinteger | nullstepCountinteger | nullsalesDocumentIdnull | stringinboxDocumentIdnull | stringwaitingOnobject[]idstringrequirednamenull | stringrequiredkindstringrequiredhistoryobject[]actionstringrequiredactorNamenull | stringrequiredcommentnull | stringrequiredatstringrequireddate-timestepsobject[]positioninteger | nullrequiredapproverIdnull | stringrequiredapproverNamestringrequiredstatusstringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecommentnull | stringrequiredstageintegermodestringkindstringdecidedForNamenull | stringMembers of the company who can be named as approvers
/v1/invoice-approvals/approversMembers of the company who can be named as approvers
MCP tool: list-invoice-approvers
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"invoice_approver"requiredidstringrequirednamenull | stringrequiredemailnull | stringrequiredrolestringrequiredtotalintegerhasMorebooleanrequiredList who stands in for whom in approvals, and when
/v1/invoice-approvals/delegationsList who stands in for whom in approvals, and when
MCP tool: list-approval-delegations
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataany[]requiredtotalintegerhasMorebooleanrequiredName who stands in during an absence: between the dates they may decide what waits on the person away. One person still decides one step
/v1/invoice-approvals/delegationsName who stands in during an absence: between the dates they may decide what waits on the person away. One person still decides one step
MCP tool: create-approval-delegation
Request body
delegatorIdstringdelegateIdstringrequiredstartsOnstringrequiredYYYY-MM-DDendsOnstringrequiredYYYY-MM-DDnotestring | nullResponse · 201
idstringrequireddelegatorIdstringrequireddelegatorNamestringrequireddelegateIdstringrequireddelegateNamestringrequiredstartsOnstringrequireddateendsOnstringrequireddatenotenull | stringrequiredcreatedAtstringrequireddate-timeEnd a stand-in
/v1/invoice-approvals/delegations/{id}End a stand-in
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-approval-delegation
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList approval scenarios: several approvers in order, optionally applied on their own from an amount
/v1/invoice-approvals/scenariosList approval scenarios: several approvers in order, optionally applied on their own from an amount
MCP tool: list-approval-scenarios
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"approval_scenario"requiredidstringrequirednamestringrequiredminTotalHalerinteger | nullrequiredactivebooleanrequiredapproversobject[]requiredidstringrequirednamestringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timestagesarray | nullmodestringrequiredapproversobject[]requiredidstringrequirednamestringrequiredprocessornull | objectidstringrequirednamestringrequireddocumentKindsstring[]totalintegerhasMorebooleanrequiredCreate an approval scenario: at least two members in the order they approve, and optionally the amount in haléře from which it applies on its own
/v1/invoice-approvals/scenariosCreate an approval scenario: at least two members in the order they approve, and optionally the amount in haléře from which it applies on its own. A document already in approval stays on its route. With no scenario a document goes to one approver, as before.
MCP tool: create-approval-scenario
Request body
namestringrequiredmax 120 charsapproverIdsstring[]stagesobject[]approverIdsstring[]requiredmode"all" | "any"processorIdstring | nulldocumentKinds"received_invoice" | "supplier_advance" | "inbox_document" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable"[]minTotalHalerinteger | nullactivebooleanResponse · 201
idstringrequirednamestringrequiredminTotalHalerinteger | nullrequiredactivebooleanrequiredapproversobject[]requiredidstringrequirednamestringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timestagesarray | nullmodestringrequiredapproversobject[]requiredidstringrequirednamestringrequiredprocessornull | objectidstringrequirednamestringrequireddocumentKindsstring[]Change an approval scenario. A document already in approval stays on the steps it started with
/v1/invoice-approvals/scenarios/{id}Change an approval scenario. A document already in approval stays on the steps it started with
MCP tool: update-approval-scenario
Path parameters
idstringrequiredRequest body
namestringmax 120 charsapproverIdsstring[]stagesobject[]approverIdsstring[]requiredmode"all" | "any"processorIdstring | nulldocumentKinds"received_invoice" | "supplier_advance" | "inbox_document" | "quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable"[]minTotalHalerinteger | nullactivebooleanResponse · 200
idstringrequirednamestringrequiredminTotalHalerinteger | nullrequiredactivebooleanrequiredapproversobject[]requiredidstringrequirednamestringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timestagesarray | nullmodestringrequiredapproversobject[]requiredidstringrequirednamestringrequiredprocessornull | objectidstringrequirednamestringrequireddocumentKindsstring[]Delete an approval scenario. Documents under way keep their steps
/v1/invoice-approvals/scenarios/{id}Delete an approval scenario. Documents under way keep their steps
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-approval-scenario
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredWhether received invoices must be approved before a payment order, and who approves by default
/v1/invoice-approvals/settingsWhether received invoices must be approved before a payment order, and who approves by default
MCP tool: get-invoice-approval-settings
Response · 200
requiredbooleanrequireddefaultApproverIdnull | stringrequireddefaultProcessorIdnull | stringsalesKindsstring[]Turn approval on or off. Turning it on sends every unpaid recorded invoice and advance to a supplier for approval
/v1/invoice-approvals/settingsTurn approval on or off. Turning it on sends every unpaid recorded invoice and advance to a supplier for approval
MCP tool: update-invoice-approval-settings
Request body
requiredbooleanrequireddefaultApproverIdstring | nulldefaultProcessorIdstring | nullsalesKinds"quote" | "rfq" | "order_received" | "order_issued" | "debit_note" | "other_receivable" | "other_payable"[]Response · 200
requiredbooleanrequireddefaultApproverIdnull | stringrequireddefaultProcessorIdnull | stringsalesKindsstring[]List job orders (zakázky) with revenue, cost, and margin from the books
/v1/job-ordersList job orders (zakázky) with revenue, cost, and margin from the books
MCP tool: list-job-orders
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"planned" | "active" | "finished" | "cancelled"contactIdstringResponse · 200
dataobject[]requiredobject"job_order"requiredidstringrequirednumberstringrequirednamestringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequireddimensionIdstringrequiredstatusstringrequiredstartsOnnull | stringrequireddateendsOnstring | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequirednotestring | nullrequiredprofitabilityobjectrequiredrevenueHalerintegerrequiredcostHalerintegerrequiredmarginHalerintegerrequiredmarginPercentinteger | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequiredbudgetMarginHalerintegerrequiredrevenueBudgetUsedPercentinteger | nullrequiredcostBudgetUsedPercentinteger | nullrequiredcostBudgetLeftHalerinteger | nullrequiredoverBudgetbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timemonthsobject[]monthnull | stringrequiredrevenueHalerintegerrequiredcostHalerintegerrequireddocumentsobject[]kindstringrequiredtabnull | stringrequiredidstringrequirednumberstringrequiredstatusstringrequiredcontactNamenull | stringrequireddatestringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredtotalintegerhasMorebooleanrequiredCreate a job order. It gets its own project dimension to choose on documents, so their postings count toward it
/v1/job-ordersCreate a job order. It gets its own project dimension to choose on documents, so their postings count toward it
MCP tool: create-job-order
Request body
namestringrequiredmax 200 charscontactIdstring | nullstatus"planned" | "active" | "finished" | "cancelled"startsOnstring | nullendsOnstring | nullbudgetRevenueHalerintegermin 0max 9007199254740991budgetCostHalerintegermin 0max 9007199254740991notestring | nullResponse · 201
idstringrequirednumberstringrequirednamestringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequireddimensionIdstringrequiredstatusstringrequiredstartsOnnull | stringrequireddateendsOnstring | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequirednotestring | nullrequiredprofitabilityobjectrequiredrevenueHalerintegerrequiredcostHalerintegerrequiredmarginHalerintegerrequiredmarginPercentinteger | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequiredbudgetMarginHalerintegerrequiredrevenueBudgetUsedPercentinteger | nullrequiredcostBudgetUsedPercentinteger | nullrequiredcostBudgetLeftHalerinteger | nullrequiredoverBudgetbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timemonthsobject[]monthnull | stringrequiredrevenueHalerintegerrequiredcostHalerintegerrequireddocumentsobject[]kindstringrequiredtabnull | stringrequiredidstringrequirednumberstringrequiredstatusstringrequiredcontactNamenull | stringrequireddatestringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredGet a job order with its documents, monthly revenue and cost, and profitability
/v1/job-orders/{id}Get a job order with its documents, monthly revenue and cost, and profitability
MCP tool: get-job-order
Path parameters
idstringrequiredResponse · 200
idstringrequirednumberstringrequirednamestringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequireddimensionIdstringrequiredstatusstringrequiredstartsOnnull | stringrequireddateendsOnstring | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequirednotestring | nullrequiredprofitabilityobjectrequiredrevenueHalerintegerrequiredcostHalerintegerrequiredmarginHalerintegerrequiredmarginPercentinteger | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequiredbudgetMarginHalerintegerrequiredrevenueBudgetUsedPercentinteger | nullrequiredcostBudgetUsedPercentinteger | nullrequiredcostBudgetLeftHalerinteger | nullrequiredoverBudgetbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timemonthsobject[]monthnull | stringrequiredrevenueHalerintegerrequiredcostHalerintegerrequireddocumentsobject[]kindstringrequiredtabnull | stringrequiredidstringrequirednumberstringrequiredstatusstringrequiredcontactNamenull | stringrequireddatestringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredUpdate a job order. Cancelling it hides its dimension from new documents
/v1/job-orders/{id}Update a job order. Cancelling it hides its dimension from new documents
MCP tool: update-job-order
Path parameters
idstringrequiredRequest body
namestringmax 200 charscontactIdstring | nullstatus"planned" | "active" | "finished" | "cancelled"startsOnstring | nullendsOnstring | nullbudgetRevenueHalerintegermin 0max 9007199254740991budgetCostHalerintegermin 0max 9007199254740991notestring | nullResponse · 200
idstringrequirednumberstringrequirednamestringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequireddimensionIdstringrequiredstatusstringrequiredstartsOnnull | stringrequireddateendsOnstring | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequirednotestring | nullrequiredprofitabilityobjectrequiredrevenueHalerintegerrequiredcostHalerintegerrequiredmarginHalerintegerrequiredmarginPercentinteger | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequiredbudgetMarginHalerintegerrequiredrevenueBudgetUsedPercentinteger | nullrequiredcostBudgetUsedPercentinteger | nullrequiredcostBudgetLeftHalerinteger | nullrequiredoverBudgetbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timemonthsobject[]monthnull | stringrequiredrevenueHalerintegerrequiredcostHalerintegerrequireddocumentsobject[]kindstringrequiredtabnull | stringrequiredidstringrequirednumberstringrequiredstatusstringrequiredcontactNamenull | stringrequireddatestringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredDelete a job order nothing was posted or linked to. Otherwise cancel it
/v1/job-orders/{id}Delete a job order nothing was posted or linked to. Otherwise cancel it
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-job-order
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredAssign a draft document to a job order. A posted document cannot move: its journal entry already carries the dimension
/v1/job-orders/{id}/documentsAssign a draft document to a job order. A posted document cannot move: its journal entry already carries the dimension
MCP tool: link-job-order-document
Path parameters
idstringrequiredRequest body
kind"invoice" | "received_invoice" | "credit_note" | "proforma"requireddocumentIdstringrequiredResponse · 200
jobOrderIdnull | stringrequiredkindstringrequireddocumentIdnull | stringrequiredProfitability report across job orders: revenue, cost, margin, and budget use, with totals
/v1/job-orders/reportProfitability report across job orders: revenue, cost, margin, and budget use, with totals
MCP tool: get-job-order-report
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"planned" | "active" | "finished" | "cancelled"contactIdstringResponse · 200
dataobject[]requiredobject"job_order"requiredidstringrequirednumberstringrequirednamestringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequireddimensionIdstringrequiredstatusstringrequiredstartsOnnull | stringrequireddateendsOnstring | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequirednotestring | nullrequiredprofitabilityobjectrequiredrevenueHalerintegerrequiredcostHalerintegerrequiredmarginHalerintegerrequiredmarginPercentinteger | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequiredbudgetMarginHalerintegerrequiredrevenueBudgetUsedPercentinteger | nullrequiredcostBudgetUsedPercentinteger | nullrequiredcostBudgetLeftHalerinteger | nullrequiredoverBudgetbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timemonthsobject[]monthnull | stringrequiredrevenueHalerintegerrequiredcostHalerintegerrequireddocumentsobject[]kindstringrequiredtabnull | stringrequiredidstringrequirednumberstringrequiredstatusstringrequiredcontactNamenull | stringrequireddatestringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredtotalsobjectrequiredrevenueHalerintegerrequiredcostHalerintegerrequiredmarginHalerintegerrequiredmarginPercentinteger | nullrequiredbudgetRevenueHalerintegerrequiredbudgetCostHalerintegerrequiredbudgetMarginHalerintegerrequiredrevenueBudgetUsedPercentinteger | nullrequiredcostBudgetUsedPercentinteger | nullrequiredcostBudgetLeftHalerinteger | nullrequiredoverBudgetbooleanrequiredGet the document print options: logo position, accent colour, footer, and what shows
/v1/print-templateGet the document print options: logo position, accent colour, footer, and what shows
MCP tool: get-print-template
Response · 200
logoPositionstringrequiredaccentColornull | stringrequiredfooterTextnull | stringrequiredshowLogobooleanrequiredshowQrCodebooleanrequiredshowBankDetailsbooleanrequiredshowNotesbooleanrequiredshowSellerContactbooleanrequiredshowSignaturebooleanrequiredhasLogobooleanrequiredhasStampbooleanSet the document print options. New PDFs use them; an issued document keeps the PDF it was issued with
/v1/print-templateSet the document print options. New PDFs use them; an issued document keeps the PDF it was issued with. What the law requires on a tax document, such as seller and buyer, VAT breakdown, and tax wording, cannot be switched off.
MCP tool: update-print-template
Request body
logoPosition"left" | "center" | "right"accentColorstring | nullfooterTextstring | nullshowLogobooleanshowQrCodebooleanshowBankDetailsbooleanshowNotesbooleanshowSellerContactbooleanshowSignaturebooleanResponse · 200
logoPositionstringrequiredaccentColornull | stringrequiredfooterTextnull | stringrequiredshowLogobooleanrequiredshowQrCodebooleanrequiredshowBankDetailsbooleanrequiredshowNotesbooleanrequiredshowSellerContactbooleanrequiredshowSignaturebooleanrequiredhasLogobooleanrequiredhasStampbooleanList the document types with a print layout: their blocks and columns, which of them the law keeps on the document, and the languages each prints in
/v1/print-template/catalogList the document types with a print layout: their blocks and columns, which of them the law keeps on the document, and the languages each prints in
MCP tool: get-print-catalog
Response · 200
typesobject[]requiredtypestringrequiredlanguagesstring[]requiredblocksobject[]requiredkeystringrequiredrequiredbooleanrequiredcolumnsobject[]requiredkeystringrequiredwidthintegerrequiredrequiredbooleanrequiredflexiblebooleanrequiredfreeOnlybooleandesignobjecttypestringrequiredfreeOnlybooleanrequiredpagesstring[]requiredcustomPagebooleanrequiredsheetbooleanrequiredblocksobject[]requiredkeystringrequiredrequiredbooleanrequiredreasonnull | stringrequiredminWidthintegerrequiredfieldsobject[]requiredkeystringrequiredkindstringrequiredlistbooleanrequiredlinkKindsstring[]requiredrequiredFieldsstring[]requiredoptionsobjectelementsstring[]requiredformatsstring[]requiredalignsstring[]requiredsymbologiesstring[]requiredcontentKindsstring[]requiredimageSourcesstring[]requiredchartsstring[]requiredshapesstring[]requiredfunctionsstring[]requiredpagesobjectrequireda4objectrequiredwidthintegerrequiredheightintegerrequireda4_landscapeobjectrequiredwidthintegerrequiredheightintegerrequireda5objectrequiredwidthintegerrequiredheightintegerrequiredreceipt80objectrequiredwidthintegerrequiredheightanyrequiredCheck a layout without saving it, and say by name what stops it being used: anything the law requires that is missing or covered, a formula that cannot be read, a field the document does not have
/v1/print-template/checkCheck a layout without saving it, and say by name what stops it being used: anything the law requires that is missing or covered, a formula that cannot be read, a field the document does not have
MCP tool: check-print-layout
Request body
documentType"invoice" | "proforma" | "credit_note" | "delivery_note" | "sales_document" | "reminder" | "stock_document" | "protocol" | "receipt" | "item_label" | "contact_label" | "postal_order"requiredlayoutobjectrequiredmode"free"requiredpageobjectrequiredelementsobject[]requiredcolumnsobject[]keystringrequiredmax 40 charsvisiblebooleanwidthnumbermin 0max 200Response · 200
okbooleanrequiredproblemsobject[]requiredcodenull | stringrequiredmessagenull | stringrequiredblockstringGet the pictures a layout can use: PNG and JPEG images from the document archive, and pictures of stock items
/v1/print-template/imagesGet the pictures a layout can use: PNG and JPEG images from the document archive, and pictures of stock items
MCP tool: get-print-images
Response · 200
archiveobject[]requiredfileIdnull | stringrequiredtitlenull | stringrequireditemsobject[]requiredfileIdnull | stringrequireditemIdnull | stringrequiredtitlenull | stringrequiredDownload a picture from the archive or a stock item, to show it in the layout editor
/v1/print-template/images/{id}Download a picture from the archive or a stock item, to show it in the layout editor
MCP tool: get-print-image
Path parameters
idstringrequiredResponse · 200
Returns a image/png file.
Print labels on a sheet: stock items or the addresses of contacts, in the default variant or the one asked for. A part-used sheet can go through again with `skip`
/v1/print-template/labelsPrint labels on a sheet: stock items or the addresses of contacts, in the default variant or the one asked for. A part-used sheet can go through again with `skip`
MCP tool: print-labels
Request body
documentType"item_label" | "contact_label"requiredidsstring[]requiredcopiesintegermin 1max 100skipintegermin 0max 479variantIdstringResponse · 200
Returns a application/pdf file.
Get the print layout of a document type: which blocks appear in what order, the line table columns and their widths, added text. Language optional; without it, the layout all languages share
/v1/print-template/layouts/{documentType}Get the print layout of a document type: which blocks appear in what order, the line table columns and their widths, added text. Language optional; without it, the layout all languages share
MCP tool: get-print-layout
Path parameters
documentTypestringrequiredQuery parameters
language"cs" | "en" | "de" | "fr"Response · 200
documentTypenull | stringrequiredlanguagenull | stringrequiredcustomizedbooleanrequiredblocksobject[]requiredkeystringrequiredvisiblebooleanrequiredtextstringcolumnsobject[]requiredkeystringrequiredvisiblebooleanrequiredwidthintegerrequiredSet the print layout of a document type, for one language or for all. New PDFs use it; an issued document keeps the PDF it was issued with
/v1/print-template/layouts/{documentType}Set the print layout of a document type, for one language or for all. New PDFs use it; an issued document keeps the PDF it was issued with. Blocks and columns the law requires are refused when hidden, so a tax document stays a tax document. To place things freely on the page, save a free layout as a print variant.
MCP tool: update-print-layout
Path parameters
documentTypestringrequiredRequest body
language"cs" | "en" | "de" | "fr" | nullblocksobject[]requiredkeystringrequiredmax 60 charsvisiblebooleantextstringmax 1000 charscolumnsobject[]keystringrequiredmax 40 charsvisiblebooleanwidthnumbermin 0max 200Response · 200
documentTypenull | stringrequiredlanguagenull | stringrequiredcustomizedbooleanrequiredblocksobject[]requiredkeystringrequiredvisiblebooleanrequiredtextstringcolumnsobject[]requiredkeystringrequiredvisiblebooleanrequiredwidthintegerrequiredForget the print layout of a document type and go back to the built-in one
/v1/print-template/layouts/{documentType}Forget the print layout of a document type and go back to the built-in one
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: reset-print-layout
Path parameters
documentTypestringrequiredQuery parameters
language"cs" | "en" | "de" | "fr"Response · 200
documentTypenull | stringrequiredlanguagenull | stringrequiredcustomizedbooleanrequiredblocksobject[]requiredkeystringrequiredvisiblebooleanrequiredtextstringcolumnsobject[]requiredkeystringrequiredvisiblebooleanrequiredwidthintegerrequiredFill in Poštovní poukázka A for what a document asks to be paid, to print over a form from Česká pošta
/v1/print-template/postal-orderFill in Poštovní poukázka A for what a document asks to be paid, to print over a form from Česká pošta. Values follow the Česká pošta notice for account holders: whole crowns, equals signs in empty places, the account checked by modulo 11, codes 110 and 116. Field positions of the starting layout come from the dimensioned drawing in its Technická specifikace Pk A of 1. 6. 2019, read from a web archive's copy, with OCR-B type in the boxes and reading zone. A saved layout keeps its own positions. The notice requires machine-printed forms to be approved by Česká pošta from 20 samples, and the file number it assigns to be on each. Nothing has been printed on paper, and approval is the post's decision.
MCP tool: print-postal-order
Request body
documentType"invoice" | "proforma" | "reminder"requireddocumentIdstringrequiredkind"standard" | "cash_on_delivery"variantIdstringResponse · 200
Returns a application/pdf file.
Render a sample PDF of a document type with these options and this layout, without saving them. Refreshing it after each change is a live preview
/v1/print-template/previewRender a sample PDF of a document type with these options and this layout, without saving them. Refreshing it after each change is a live preview
MCP tool: preview-print-template
Query parameters
language"cs" | "en" | "de" | "fr"Request body
logoPosition"left" | "center" | "right"accentColorstring | nullfooterTextstring | nullshowLogobooleanshowQrCodebooleanshowBankDetailsbooleanshowNotesbooleanshowSellerContactbooleanshowSignaturebooleandocumentType"invoice" | "proforma" | "credit_note" | "delivery_note" | "sales_document" | "reminder" | "stock_document" | "protocol" | "receipt" | "item_label" | "contact_label" | "postal_order"language"cs" | "en" | "de" | "fr"layoutobjectmode"free"requiredpageobjectrequiredelementsobject[]requiredcolumnsobject[]keystringrequiredmax 40 charsvisiblebooleanwidthnumbermin 0max 200variantIdstringResponse · 200
Returns a application/pdf file.
Print a document in a variant, together with what is linked to that variant, as one PDF. The PDF stored when it was issued stays its original
/v1/print-template/printPrint a document in a variant, together with what is linked to that variant, as one PDF. The PDF stored when it was issued stays its original. Without a variant it uses the default for the document. `alone` leaves linked reports out.
MCP tool: print-document-variant
Request body
documentType"invoice" | "proforma" | "credit_note" | "delivery_note" | "sales_document" | "reminder" | "stock_document" | "protocol" | "receipt" | "item_label" | "contact_label" | "postal_order"requireddocumentIdstringrequiredvariantIdstringlanguage"cs" | "en" | "de" | "fr"alonebooleanResponse · 200
Returns a application/pdf file.
List the saved variants of the reports, for one document type or all, with which is the default
/v1/print-template/variantsList the saved variants of the reports, for one document type or all, with which is the default
MCP tool: list-print-variants
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsdocumentType"invoice" | "proforma" | "credit_note" | "delivery_note" | "sales_document" | "reminder" | "stock_document" | "protocol" | "receipt" | "item_label" | "contact_label" | "postal_order"Response · 200
dataobject[]requiredobject"print_variant"requiredidstringrequireddocumentTypestringrequiredlanguagenull | stringrequirednamestringrequiredisDefaultbooleanrequiredmodestringrequiredlayoutobjectrequiredmodestringrequiredpageobjectpresetstringrequiredsheetobjectelementsobject[]hintegerrequiredwintegerrequiredxintegerrequiredyintegerrequiredidstringrequiredkeystringtypestringrequiredtextstringboldbooleancolorstringfieldnull | stringexpressionstringcontentobjectsymbologystringchartstringlabelsstringvaluesstringfileIdnull | stringsourcestringitemImagesbooleanlineintegeritemIdnull | stringblocksobject[]keystringrequiredvisiblebooleanrequiredtextstringcolumnsobject[]keystringrequiredwidthintegerrequiredvisiblebooleanrequiredlinkedobject[]requiredkindstringrequiredvariantIdstringproblemsobject[]requiredcodenull | stringrequiredblockstringrequiredmessagenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredSave a named variant of a report. Without a layout it starts from a free layout that holds everything the document requires
/v1/print-template/variantsSave a named variant of a report. Without a layout it starts from a free layout that holds everything the document requires. A free layout places elements anywhere on the page in millimetres. A layout that leaves out or covers something the law requires is refused with the reason by name in `problems`. Marking it as the default makes new PDFs use it; an issued document keeps the PDF it was issued with.
MCP tool: create-print-variant
Request body
documentType"invoice" | "proforma" | "credit_note" | "delivery_note" | "sales_document" | "reminder" | "stock_document" | "protocol" | "receipt" | "item_label" | "contact_label" | "postal_order"requirednamestringrequiredmax 80 charslanguage"cs" | "en" | "de" | "fr" | nullisDefaultbooleanlayoutobjectmode"free"requiredpageobjectrequiredelementsobject[]requiredcolumnsobject[]keystringrequiredmax 40 charsvisiblebooleanwidthnumbermin 0max 200linkedobject[]kindstringrequiredmax 40 charsvariantIdstringResponse · 201
idstringrequireddocumentTypestringrequiredlanguagenull | stringrequirednamestringrequiredisDefaultbooleanrequiredmodestringrequiredlayoutobjectrequiredmodestringrequiredpageobjectpresetstringrequiredsheetobjectgapXintegerrequiredgapYintegerrequiredrowsintegerrequiredcolumnsintegerrequiredoffsetXintegerrequiredoffsetYintegerrequiredlabelWidthintegerrequiredlabelHeightintegerrequiredelementsobject[]hintegerrequiredwintegerrequiredxintegerrequiredyintegerrequiredidstringrequiredkeystringtypestringrequiredtextstringboldbooleancolorstringfieldnull | stringexpressionstringcontentobjectkindstringrequiredvaluestringsymbologystringchartstringlabelsstringvaluesstringfileIdnull | stringsourcestringitemImagesbooleanlineintegeritemIdnull | stringblocksobject[]keystringrequiredvisiblebooleanrequiredtextstringcolumnsobject[]keystringrequiredwidthintegerrequiredvisiblebooleanrequiredlinkedobject[]requiredkindstringrequiredvariantIdstringproblemsobject[]requiredcodenull | stringrequiredblockstringrequiredmessagenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeGet one saved variant of a report with its layout, what prints with it, and anything that stops it printing
/v1/print-template/variants/{id}Get one saved variant of a report with its layout, what prints with it, and anything that stops it printing
MCP tool: get-print-variant
Path parameters
idstringrequiredResponse · 200
idstringrequireddocumentTypestringrequiredlanguagenull | stringrequirednamestringrequiredisDefaultbooleanrequiredmodestringrequiredlayoutobjectrequiredmodestringrequiredpageobjectpresetstringrequiredsheetobjectgapXintegerrequiredgapYintegerrequiredrowsintegerrequiredcolumnsintegerrequiredoffsetXintegerrequiredoffsetYintegerrequiredlabelWidthintegerrequiredlabelHeightintegerrequiredelementsobject[]hintegerrequiredwintegerrequiredxintegerrequiredyintegerrequiredidstringrequiredkeystringtypestringrequiredtextstringboldbooleancolorstringfieldnull | stringexpressionstringcontentobjectkindstringrequiredvaluestringsymbologystringchartstringlabelsstringvaluesstringfileIdnull | stringsourcestringitemImagesbooleanlineintegeritemIdnull | stringblocksobject[]keystringrequiredvisiblebooleanrequiredtextstringcolumnsobject[]keystringrequiredwidthintegerrequiredvisiblebooleanrequiredlinkedobject[]requiredkindstringrequiredvariantIdstringproblemsobject[]requiredcodenull | stringrequiredblockstringrequiredmessagenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeChange a saved variant: its name, layout, what prints with it, or whether it is the default
/v1/print-template/variants/{id}Change a saved variant: its name, layout, what prints with it, or whether it is the default. A layout that leaves out or covers something the law requires is refused with the reason by name in `problems`.
MCP tool: update-print-variant
Path parameters
idstringrequiredRequest body
namestringmax 80 charslanguage"cs" | "en" | "de" | "fr" | nullisDefaultbooleanlayoutobjectmode"free"requiredpageobjectrequiredelementsobject[]requiredcolumnsobject[]keystringrequiredmax 40 charsvisiblebooleanwidthnumbermin 0max 200linkedobject[]kindstringrequiredmax 40 charsvariantIdstringResponse · 200
idstringrequireddocumentTypestringrequiredlanguagenull | stringrequirednamestringrequiredisDefaultbooleanrequiredmodestringrequiredlayoutobjectrequiredmodestringrequiredpageobjectpresetstringrequiredsheetobjectgapXintegerrequiredgapYintegerrequiredrowsintegerrequiredcolumnsintegerrequiredoffsetXintegerrequiredoffsetYintegerrequiredlabelWidthintegerrequiredlabelHeightintegerrequiredelementsobject[]hintegerrequiredwintegerrequiredxintegerrequiredyintegerrequiredidstringrequiredkeystringtypestringrequiredtextstringboldbooleancolorstringfieldnull | stringexpressionstringcontentobjectkindstringrequiredvaluestringsymbologystringchartstringlabelsstringvaluesstringfileIdnull | stringsourcestringitemImagesbooleanlineintegeritemIdnull | stringblocksobject[]keystringrequiredvisiblebooleanrequiredtextstringcolumnsobject[]keystringrequiredwidthintegerrequiredvisiblebooleanrequiredlinkedobject[]requiredkindstringrequiredvariantIdstringproblemsobject[]requiredcodenull | stringrequiredblockstringrequiredmessagenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeDelete a saved variant. If it was the default, the section layout prints again. Other variants linked to it stop printing it
/v1/print-template/variants/{id}Delete a saved variant. If it was the default, the section layout prints again. Other variants linked to it stop printing it
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-print-variant
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredSend a received invoice for approval, or again after a rejection: to one approver (one click, the default) or through a scenario of several in order
/v1/received-invoices/{id}/approvalSend a received invoice for approval, or again after a rejection: to one approver (one click, the default) or through a scenario of several in order
MCP tool: request-invoice-approval
Path parameters
idstringrequiredRequest body
approverIdstring | nullscenarioIdstring | nullcommentstring | nullResponse · 201
idstringrequireddocumentKindnull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredstatusstringrequiredapproverIdnull | stringrequiredapproverNamenull | stringrequiredcommentnull | stringrequireddecidedByIdnull | stringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeinvoicenull | objectrequiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredstatusstringrequiredscenarioIdnull | stringcurrentStepinteger | nullstepCountinteger | nullsalesDocumentIdnull | stringinboxDocumentIdnull | stringwaitingOnobject[]idstringrequirednamenull | stringrequiredkindstringrequiredhistoryobject[]actionstringrequiredactorNamenull | stringrequiredcommentnull | stringrequiredatstringrequireddate-timestepsobject[]positioninteger | nullrequiredapproverIdnull | stringrequiredapproverNamestringrequiredstatusstringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecommentnull | stringrequiredstageintegermodestringkindstringdecidedForNamenull | stringSend a draft sales document, such as an issued order, for approval before it is issued: to one approver or through a scenario
/v1/sales/documents/{id}/approvalSend a draft sales document, such as an issued order, for approval before it is issued: to one approver or through a scenario. Which kinds must be approved before issue is a company setting (salesKinds). Changing the lines, partner or currency of an approved draft cancels the approval.
MCP tool: request-sales-document-approval
Path parameters
idstringrequiredRequest body
approverIdstring | nullscenarioIdstring | nullcommentstring | nullResponse · 201
idstringrequireddocumentKindnull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredstatusstringrequiredapproverIdnull | stringrequiredapproverNamenull | stringrequiredcommentnull | stringrequireddecidedByIdnull | stringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeinvoicenull | objectrequiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredstatusstringrequiredscenarioIdnull | stringcurrentStepinteger | nullstepCountinteger | nullsalesDocumentIdnull | stringinboxDocumentIdnull | stringwaitingOnobject[]idstringrequirednamenull | stringrequiredkindstringrequiredhistoryobject[]actionstringrequiredactorNamenull | stringrequiredcommentnull | stringrequiredatstringrequireddate-timestepsobject[]positioninteger | nullrequiredapproverIdnull | stringrequiredapproverNamestringrequiredstatusstringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecommentnull | stringrequiredstageintegermodestringkindstringdecidedForNamenull | stringList saved custom reports
/v1/saved-reportsList saved custom reports
MCP tool: list-saved-reports
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"saved_report"requiredidstringrequirednamestringrequiredagendastringrequiredsortByanyrequiredtotalsstring[]requiredcolumnsstring[]requiredfiltersobject[]requiredvaluestringrequiredcolumnstringrequiredoperatorstringrequiredgroupByanyrequiredsortDirectionstringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredSave a custom report
/v1/saved-reportsSave a custom report
MCP tool: create-saved-report
Request body
namestringrequiredmax 200 charsagendastringrequiredmax 60 charscolumnsstring[]requiredfiltersobject[]columnstringrequiredmax 60 charsoperator"eq" | "ne" | "contains" | "gte" | "lte" | "empty" | "not_empty"requiredvaluestring | number | nulltotalsstring[]sortBystring | nullsortDirection"asc" | "desc"groupBystring | nullResponse · 201
idstringrequirednamestringrequiredagendastringrequiredsortByanyrequiredtotalsstring[]requiredcolumnsstring[]requiredfiltersobject[]requiredvaluestringrequiredcolumnstringrequiredoperatorstringrequiredgroupByanyrequiredsortDirectionstringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeGet a saved report
/v1/saved-reports/{id}Get a saved report
MCP tool: get-saved-report
Path parameters
idstringrequiredResponse · 200
idstringrequirednamestringrequiredagendastringrequiredsortByanyrequiredtotalsstring[]requiredcolumnsstring[]requiredfiltersobject[]requiredvaluestringrequiredcolumnstringrequiredoperatorstringrequiredgroupByanyrequiredsortDirectionstringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeChange a saved report
/v1/saved-reports/{id}Change a saved report
MCP tool: update-saved-report
Path parameters
idstringrequiredRequest body
namestringmax 200 charsagendastringmax 60 charscolumnsstring[]filtersobject[]columnstringrequiredmax 60 charsoperator"eq" | "ne" | "contains" | "gte" | "lte" | "empty" | "not_empty"requiredvaluestring | number | nulltotalsstring[]sortBystring | nullsortDirection"asc" | "desc"groupBystring | nullResponse · 200
idstringrequirednamestringrequiredagendastringrequiredsortByanyrequiredtotalsstring[]requiredcolumnsstring[]requiredfiltersobject[]requiredvaluestringrequiredcolumnstringrequiredoperatorstringrequiredgroupByanyrequiredsortDirectionstringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeDelete a saved report
/v1/saved-reports/{id}Delete a saved report
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-saved-report
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredExport a saved report as format=xlsx, csv, or pdf
/v1/saved-reports/{id}/exportExport a saved report as format=xlsx, csv, or pdf
MCP tool: export-saved-report
Path parameters
idstringrequiredQuery parameters
format"csv" | "xlsx" | "pdf"language"cs" | "en"Response · 200
Returns a application/octet-stream file.
Run a saved report
/v1/saved-reports/{id}/runRun a saved report
MCP tool: run-saved-report
Path parameters
idstringrequiredQuery parameters
format"csv" | "xlsx" | "pdf"language"cs" | "en"Response · 200
agendastringrequiredcolumnsobject[]requiredkeystringrequiredtypestringrequiredlabelnull | stringrequiredrowsobject[]requiredaccountNumbernull | stringdebitHalerintegerpairingSymbolnull | stringdocumentTypenull | stringnumbernull | stringtotalHalerinteger | nullcontactNamenull | stringstatusstringnetHalerintegernamenull | stringicostring | nulldicstring | nullemailnull | stringphonestring | nullrolesstringtotalsobjectrequiredoverallobjectrequireddebitHalerintegernetHalerintegertotalHalerinteger | nullgroupsobject[]requiredvaluestringrequiredcountintegerrequiredtotalsobjectrequirednetHalerintegerrequiredtotalHalerinteger | nullrequiredtruncatedbooleanrequiredmixedCurrenciesbooleanrequirednamenull | stringWhat a custom report can show: agendas, their columns, and the conditions each column allows
/v1/saved-reports/catalogWhat a custom report can show: agendas, their columns, and the conditions each column allows
MCP tool: get-report-catalog
Response · 200
agendasobject[]requiredkeystringrequiredcsstringrequiredenstringrequireddefaultColumnsstring[]requiredcolumnsobject[]requiredkeystringrequiredtypestringrequiredcsstringrequiredenstringrequiredoperatorsstring[]requiredExport a custom report as format=xlsx, csv, or pdf without saving it
/v1/saved-reports/exportExport a custom report as format=xlsx, csv, or pdf without saving it
MCP tool: export-custom-report
Query parameters
format"csv" | "xlsx" | "pdf"language"cs" | "en"Request body
agendastringrequiredmax 60 charscolumnsstring[]requiredfiltersobject[]columnstringrequiredmax 60 charsoperator"eq" | "ne" | "contains" | "gte" | "lte" | "empty" | "not_empty"requiredvaluestring | number | nulltotalsstring[]sortBystring | nullsortDirection"asc" | "desc"groupBystring | nullResponse · 200
Returns a application/octet-stream file.
Run a custom report without saving it. Returns rows and totals, up to 5000 rows
/v1/saved-reports/runRun a custom report without saving it. Returns rows and totals, up to 5000 rows
MCP tool: run-report
Query parameters
format"csv" | "xlsx" | "pdf"language"cs" | "en"Request body
agendastringrequiredmax 60 charscolumnsstring[]requiredfiltersobject[]columnstringrequiredmax 60 charsoperator"eq" | "ne" | "contains" | "gte" | "lte" | "empty" | "not_empty"requiredvaluestring | number | nulltotalsstring[]sortBystring | nullsortDirection"asc" | "desc"groupBystring | nullResponse · 200
agendastringrequiredcolumnsobject[]requiredkeystringrequiredtypestringrequiredlabelnull | stringrequiredrowsobject[]requiredaccountNumbernull | stringdebitHalerintegerpairingSymbolnull | stringdocumentTypenull | stringnumbernull | stringtotalHalerinteger | nullcontactNamenull | stringstatusstringnetHalerintegernamenull | stringicostring | nulldicstring | nullemailnull | stringphonestring | nullrolesstringtotalsobjectrequiredoverallobjectrequireddebitHalerintegernetHalerintegertotalHalerinteger | nullgroupsobject[]requiredvaluestringrequiredcountintegerrequiredtotalsobjectrequirednetHalerintegerrequiredtotalHalerinteger | nullrequiredtruncatedbooleanrequiredmixedCurrenciesbooleanrequirednamenull | stringList service jobs
/v1/service-jobsList service jobs
MCP tool: list-service-jobs
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"received" | "in_progress" | "ready" | "invoiced" | "closed" | "cancelled"contactIdstringcustomFieldKeystringcustomFieldValuestringmax 2000 charsResponse · 200
dataobject[]requiredobject"service_job"requiredidstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requiredorderLineIdnull | stringrequiredrecyclingnull | objectvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]balancedbooleancashJournalobject[]receivablesBookobject[]payablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredtotalintegerhasMorebooleanrequiredTake in a device for service
/v1/service-jobsTake in a device for service
MCP tool: create-service-job
Request body
contactIdstringrequireddeviceNamestringrequiredmax 200 charsserialNumberstring | nullproblemstringrequiredmax 4000 charsaccessoriesstring | nulldiagnosisstring | nullreceivedOnstringYYYY-MM-DDpromisedOnstring | nullwarrantybooleanjobOrderIdstring | nullnotestring | nullseriesIdstringResponse · 201
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredGet a service job with its work log, parts, and totals
/v1/service-jobs/{id}Get a service job with its work log, parts, and totals
MCP tool: get-service-job
Path parameters
idstringrequiredResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredEdit an open service job
/v1/service-jobs/{id}Edit an open service job
MCP tool: update-service-job
Path parameters
idstringrequiredRequest body
contactIdstringdeviceNamestringmax 200 charsserialNumberstring | nullproblemstringmax 4000 charsaccessoriesstring | nulldiagnosisstring | nullreceivedOnstringYYYY-MM-DDpromisedOnstring | nullwarrantybooleanjobOrderIdstring | nullnotestring | nullResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredDelete a service job that has no parts yet. Otherwise cancel it
/v1/service-jobs/{id}Delete a service job that has no parts yet. Otherwise cancel it
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-service-job
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredClose a service job without an invoice, such as a warranty repair
/v1/service-jobs/{id}/closeClose a service job without an invoice, such as a warranty repair
MCP tool: close-service-job
Path parameters
idstringrequiredResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredTurn a service job into an invoice from its work log and parts, as a draft unless issue is set
/v1/service-jobs/{id}/invoiceTurn a service job into an invoice from its work log and parts, as a draft unless issue is set
MCP tool: invoice-service-job
Path parameters
idstringrequiredRequest body
issueDatestringYYYY-MM-DDtaxPointDatestringYYYY-MM-DDdueDatestringYYYY-MM-DDissuebooleanResponse · 201
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredUse a part from stock on a service job. The stock issue posts at once; there must be enough in the warehouse. On a warranty repair it posts as a cost (548), not as a sale
/v1/service-jobs/{id}/partsUse a part from stock on a service job. The stock issue posts at once; there must be enough in the warehouse. On a warranty repair it posts as a cost (548), not as a sale
MCP tool: add-service-job-part
Path parameters
idstringrequiredRequest body
itemIdstringrequiredwarehouseIdstringrequiredquantitynumberrequiredmax 1000000000unitPriceHalerintegermin 0max 9007199254740991vatRate0 | 10 | 12 | 15 | 21usedOnstringYYYY-MM-DDResponse · 201
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredRemove a part from a service job and return it to stock by reversing the issue
/v1/service-jobs/{id}/parts/{childId}Remove a part from a service job and return it to stock by reversing the issue
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: remove-service-job-part
Path parameters
idstringrequiredchildIdstringrequiredResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredService protocol PDF with device, problem, work, and parts, in Czech, English, German or French
/v1/service-jobs/{id}/pdfService protocol PDF with device, problem, work, and parts, in Czech, English, German or French
MCP tool: download-service-job-protocol
Path parameters
idstringrequiredQuery parameters
language"cs" | "en" | "de" | "fr"Response · 200
Returns a application/pdf file.
Move a service job between received, in progress, ready, and cancelled. Cancelling needs its parts removed first
/v1/service-jobs/{id}/statusMove a service job between received, in progress, ready, and cancelled. Cancelling needs its parts removed first
MCP tool: set-service-job-status
Path parameters
idstringrequiredRequest body
status"received" | "in_progress" | "ready" | "cancelled"requiredResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredLog work on a service job
/v1/service-jobs/{id}/workLog work on a service job
MCP tool: add-service-job-work
Path parameters
idstringrequiredRequest body
workedOnstringYYYY-MM-DDdescriptionstringrequiredmax 400 charsworkerNamestring | nullminutesintegerrequiredmax 100000hourlyRateHalerintegermin 0max 9007199254740991vatRate0 | 10 | 12 | 15 | 21Response · 201
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredRemove a work log entry
/v1/service-jobs/{id}/work/{childId}Remove a work log entry
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: remove-service-job-work
Path parameters
idstringrequiredchildIdstringrequiredResponse · 200
idstringrequirednumberstringrequiredcontactIdstringrequiredcontactNamenull | stringrequireddeviceNamestringrequiredserialNumbernull | stringrequiredproblemstringrequiredaccessoriesstring | nullrequireddiagnosisstring | nullrequiredreceivedOnstringrequireddatepromisedOnstring | nullrequiredfinishedOnnull | stringrequireddatewarrantybooleanrequiredstatusstringrequiredinvoiceIdnull | stringrequiredjobOrderIdnull | stringrequirednotenull | stringrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeseriesIdnull | stringcustomFieldsobjecttistene_polestringinvoiceNumbernull | stringworkobject[]object"service_job_work"requiredidstringrequiredworkedOnstringrequireddatedescriptionstringrequiredworkerNamestring | nullrequiredminutesintegerrequiredhourlyRateHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredpartsobject[]object"service_job_part"requiredidstringrequireditemIdstringrequiredwarehouseIdstringrequireddescriptionstringrequiredunitstringrequiredquantityintegerrequiredunitPriceHalerintegerrequiredvatRateintegerrequiredusedOnstringrequireddatenetHalerintegerrequiredworkNetHalerintegerpartsNetHalerintegertotalNetHalerintegerinvoiceobjectobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredList shipments (zásilky), by carrier, status, document, or contact
/v1/shipmentsList shipments (zásilky), by carrier, status, document, or contact
MCP tool: list-shipments
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDcarrierIdstringstatus"to_process" | "exported" | "in_transit" | "delivered" | "returned" | "cancelled"sourceIdstringcontactIdstringResponse · 200
dataobject[]requiredobject"shipment"requiredidstringrequirednumberstringrequiredcarrierIdstringrequiredcarrierNamestringrequiredsourceKindnull | stringrequiredsourceIdnull | stringrequiredsourceNumbernull | stringrequiredcontactIdnull | stringrequiredrecipientNamestringrequiredrecipientStreetnull | stringrequiredrecipientCitynull | stringrequiredrecipientPostalCodenull | stringrequiredrecipientCountrystringrequiredrecipientPhonenull | stringrequiredrecipientEmailnull | stringrequiredweightGramsinteger | nullrequiredparcelCountintegerrequiredcodHalerinteger | nullrequiredvalueHalerinteger | nullrequiredcurrencystringrequiredvariableSymbolnull | stringrequiredtrackingNumbernull | stringrequiredpickupPointIdnull | stringrequiredstatusstringrequiredstatusDetailnull | stringrequiredstatusAtnull | stringrequireddate-timeexportedAtnull | stringrequireddate-timeshippedOnstringrequireddatenotenull | stringrequiredcreatedAtstringrequireddate-timeexternalIdnull | stringpreferredDeliveryOnnull | stringdatepreferredDeliveryFromnull | stringpreferredDeliveryTonull | stringtotalintegerhasMorebooleanrequiredCreate a shipment for a carrier. Named from a document, it takes the delivery address and cash on delivery from it; from a contact, its address
/v1/shipmentsCreate a shipment for a carrier. Named from a document, it takes the delivery address and cash on delivery from it; from a contact, its address
MCP tool: create-shipment
Request body
carrierIdstringrequiredsourceKind"invoice" | "delivery_note" | "proforma" | "order_received"sourceIdstringcontactIdstringrecipientNamestringmax 160 charsrecipientStreetstring | nullrecipientCitystring | nullrecipientPostalCodestring | nullrecipientCountrystring2 charsrecipientPhonestring | nullrecipientEmailstring | nullweightGramsinteger | nullparcelCountintegermax 99codHalerinteger | nullvalueHalerinteger | nullcurrencystring3 charsvariableSymbolstring | nulltrackingNumberstring | nullpickupPointIdstring | nullpreferredDeliveryOnstring | nullpreferredDeliveryFromstring | nullpreferredDeliveryTostring | nullshippedOnstringYYYY-MM-DDnotestring | nullResponse · 201
idstringrequirednumberstringrequiredcarrierIdstringrequiredcarrierNamestringrequiredsourceKindnull | stringrequiredsourceIdnull | stringrequiredsourceNumbernull | stringrequiredcontactIdnull | stringrequiredrecipientNamestringrequiredrecipientStreetnull | stringrequiredrecipientCitynull | stringrequiredrecipientPostalCodenull | stringrequiredrecipientCountrystringrequiredrecipientPhonenull | stringrequiredrecipientEmailnull | stringrequiredweightGramsinteger | nullrequiredparcelCountintegerrequiredcodHalerinteger | nullrequiredvalueHalerinteger | nullrequiredcurrencystringrequiredvariableSymbolnull | stringrequiredtrackingNumbernull | stringrequiredpickupPointIdnull | stringrequiredstatusstringrequiredstatusDetailnull | stringrequiredstatusAtnull | stringrequireddate-timeexportedAtnull | stringrequireddate-timeshippedOnstringrequireddatenotenull | stringrequiredcreatedAtstringrequireddate-timeexternalIdnull | stringpreferredDeliveryOnnull | stringdatepreferredDeliveryFromnull | stringpreferredDeliveryTonull | stringGet a shipment
/v1/shipments/{id}Get a shipment
MCP tool: get-shipment
Path parameters
idstringrequiredResponse · 200
idstringrequirednumberstringrequiredcarrierIdstringrequiredcarrierNamestringrequiredsourceKindnull | stringrequiredsourceIdnull | stringrequiredsourceNumbernull | stringrequiredcontactIdnull | stringrequiredrecipientNamestringrequiredrecipientStreetnull | stringrequiredrecipientCitynull | stringrequiredrecipientPostalCodenull | stringrequiredrecipientCountrystringrequiredrecipientPhonenull | stringrequiredrecipientEmailnull | stringrequiredweightGramsinteger | nullrequiredparcelCountintegerrequiredcodHalerinteger | nullrequiredvalueHalerinteger | nullrequiredcurrencystringrequiredvariableSymbolnull | stringrequiredtrackingNumbernull | stringrequiredpickupPointIdnull | stringrequiredstatusstringrequiredstatusDetailnull | stringrequiredstatusAtnull | stringrequireddate-timeexportedAtnull | stringrequireddate-timeshippedOnstringrequireddatenotenull | stringrequiredcreatedAtstringrequireddate-timeexternalIdnull | stringpreferredDeliveryOnnull | stringdatepreferredDeliveryFromnull | stringpreferredDeliveryTonull | stringChange a shipment or its status. Once exported, only its tracking number, status, and note can change, as the carrier already holds the rest
/v1/shipments/{id}Change a shipment or its status. Once exported, only its tracking number, status, and note can change, as the carrier already holds the rest
MCP tool: update-shipment
Path parameters
idstringrequiredRequest body
carrierIdstringsourceKind"invoice" | "delivery_note" | "proforma" | "order_received"sourceIdstringcontactIdstringrecipientNamestringmax 160 charsrecipientStreetstring | nullrecipientCitystring | nullrecipientPostalCodestring | nullrecipientCountrystring2 charsrecipientPhonestring | nullrecipientEmailstring | nullweightGramsinteger | nullparcelCountintegermax 99codHalerinteger | nullvalueHalerinteger | nullcurrencystring3 charsvariableSymbolstring | nulltrackingNumberstring | nullpickupPointIdstring | nullpreferredDeliveryOnstring | nullpreferredDeliveryFromstring | nullpreferredDeliveryTostring | nullshippedOnstringYYYY-MM-DDnotestring | nullstatus"to_process" | "exported" | "in_transit" | "delivered" | "returned" | "cancelled"statusDetailstring | nullResponse · 200
idstringrequirednumberstringrequiredcarrierIdstringrequiredcarrierNamestringrequiredsourceKindnull | stringrequiredsourceIdnull | stringrequiredsourceNumbernull | stringrequiredcontactIdnull | stringrequiredrecipientNamestringrequiredrecipientStreetnull | stringrequiredrecipientCitynull | stringrequiredrecipientPostalCodenull | stringrequiredrecipientCountrystringrequiredrecipientPhonenull | stringrequiredrecipientEmailnull | stringrequiredweightGramsinteger | nullrequiredparcelCountintegerrequiredcodHalerinteger | nullrequiredvalueHalerinteger | nullrequiredcurrencystringrequiredvariableSymbolnull | stringrequiredtrackingNumbernull | stringrequiredpickupPointIdnull | stringrequiredstatusstringrequiredstatusDetailnull | stringrequiredstatusAtnull | stringrequireddate-timeexportedAtnull | stringrequireddate-timeshippedOnstringrequireddatenotenull | stringrequiredcreatedAtstringrequireddate-timeexternalIdnull | stringpreferredDeliveryOnnull | stringdatepreferredDeliveryFromnull | stringpreferredDeliveryTonull | stringDelete a shipment not yet handed to the carrier
/v1/shipments/{id}Delete a shipment not yet handed to the carrier
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-shipment
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredDownload the carrier's own labels through its API (Packeta, PPL, DPD, GLS). Only for shipments it already holds, and only where the operator allows live calls
/v1/shipments/carrier/labelsDownload the carrier's own labels through its API (Packeta, PPL, DPD, GLS). Only for shipments it already holds, and only where the operator allows live calls
MCP tool: download-carrier-labels
Request body
idsstring[]requiredformat"A6 on A6" | "A7 on A7" | "A6 on A4" | "A7 on A4" | "105x35mm on A4" | "A8 on A8"Response · 200
Returns a application/pdf file.
Ask the carrier for the status of shipments it holds (Packeta, PPL, DPD, GLS). Only where the operator allows live calls. A sweep also does this by itself
/v1/shipments/carrier/statusAsk the carrier for the status of shipments it holds (Packeta, PPL, DPD, GLS). Only where the operator allows live calls. A sweep also does this by itself
MCP tool: sync-carrier-status
Request body
idsstring[]requiredResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredHand shipments to the carrier through its own API (Packeta, PPL, DPD, GLS). Only where the operator allows live calls. Each answers on its own
/v1/shipments/carrier/submitHand shipments to the carrier through its own API (Packeta, PPL, DPD, GLS). Only where the operator allows live calls. Each answers on its own. The carrier assigns the tracking number: Packeta and DPD straight away, PPL when it has processed the batch, GLS with the first label.
MCP tool: submit-shipments-to-carrier
Request body
idsstring[]requiredResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredPrint addressed envelopes, DL by default or C6 or C5, for shipments or for contacts, one per page at envelope size
/v1/shipments/envelopesPrint addressed envelopes, DL by default or C6 or C5, for shipments or for contacts, one per page at envelope size
MCP tool: print-envelopes
Request body
idsstring[]contactIdsstring[]size"DL" | "C6" | "C5"Response · 200
Returns a application/pdf file.
Download the carrier file: the Česká pošta posting sheet (ePA), or generic CSV for any other carrier. Exported shipments leave later exports
/v1/shipments/exportDownload the carrier file: the Česká pošta posting sheet (ePA), or generic CSV for any other carrier. Exported shipments leave later exports
MCP tool: export-shipments
Request body
carrierIdstringrequiredidsstring[]Response · 200
Returns a text/csv file.
Make shipments for documents, as POHODA's Vygenerovat zásilky: one per document that has none yet, each answering on its own
/v1/shipments/generateMake shipments for documents, as POHODA's Vygenerovat zásilky: one per document that has none yet, each answering on its own
MCP tool: generate-shipments
Request body
carrierIdstringrequiredsourceKind"invoice" | "order_received" | "delivery_note" | "proforma"requiredidsstring[]requiredResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredPrint shipment labels as a PDF, one per parcel, A6 or four on an A4 sheet: our own layout with a Code 128 of the tracking number, not a carrier's label
/v1/shipments/labelsPrint shipment labels as a PDF, one per parcel, A6 or four on an A4 sheet: our own layout with a Code 128 of the tracking number, not a carrier's label. A carrier that scans its own label needs that one: downloadCarrierLabels, where its API is connected.
MCP tool: print-shipment-labels
Request body
idsstring[]requiredsize"A6" | "A4"Response · 200
Returns a application/pdf file.
Print a posting report (podací arch) of shipments: our own layout listing what goes out, not a form of a carrier
/v1/shipments/postal-reportPrint a posting report (podací arch) of shipments: our own layout listing what goes out, not a form of a carrier
MCP tool: print-postal-report
Request body
idsstring[]requiredResponse · 200
Returns a application/pdf file.
Read a CSV of shipment statuses from a carrier. Generic: a header row with a shipment or tracking number column and a status column
/v1/shipments/status-importRead a CSV of shipment statuses from a carrier. Generic: a header row with a shipment or tracking number column and a status column. Each row answers on its own. A status worded in a way we do not know is kept as text and changes nothing. No carrier publishes one status file format we could read, so columns go by name, not by carrier.
MCP tool: import-shipment-status
Request body
csvstringrequiredmax 5000000 charsResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredSend an advance to a supplier for approval, or again after a rejection: to one approver (one click, the default) or through a scenario of several in order
/v1/supplier-advances/{id}/approvalSend an advance to a supplier for approval, or again after a rejection: to one approver (one click, the default) or through a scenario of several in order
MCP tool: request-supplier-advance-approval
Path parameters
idstringrequiredRequest body
approverIdstring | nullscenarioIdstring | nullcommentstring | nullResponse · 201
idstringrequireddocumentKindnull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredstatusstringrequiredapproverIdnull | stringrequiredapproverNamenull | stringrequiredcommentnull | stringrequireddecidedByIdnull | stringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeinvoicenull | objectrequiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringrequireddatetotalHalerinteger | nullrequiredcurrencynull | stringrequiredstatusstringrequiredscenarioIdnull | stringcurrentStepinteger | nullstepCountinteger | nullsalesDocumentIdnull | stringinboxDocumentIdnull | stringwaitingOnobject[]idstringrequirednamenull | stringrequiredkindstringrequiredhistoryobject[]actionstringrequiredactorNamenull | stringrequiredcommentnull | stringrequiredatstringrequireddate-timestepsobject[]positioninteger | nullrequiredapproverIdnull | stringrequiredapproverNamestringrequiredstatusstringrequireddecidedByNamenull | stringrequireddecidedAtnull | stringrequireddate-timecommentnull | stringrequiredstageintegermodestringkindstringdecidedForNamenull | stringList tasks across all contacts, soonest first: assignedTo=me for my own or a colleague, checker=me and toCheck=true for what waits for my check
/v1/tasksList tasks across all contacts, soonest first: assignedTo=me for my own or a colleague, checker=me and toCheck=true for what waits for my check
MCP tool: list-tasks
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDassignedTostringmax 40 charsopen"true" | "false"checkerstringmax 40 charstoCheck"true" | "false"Response · 200
dataobject[]requiredobject"contact_activity"requiredidstringrequiredcontactIdstringrequiredkindstringrequiredsubjectstringrequiredbodynull | stringrequiredoccurredOnstringrequireddatedueOnnull | stringrequireddatedonebooleanrequireddoneAtnull | stringrequireddate-timeassignedToIdnull | stringrequiredcreatedAtstringrequireddate-timeparentIdnull | stringcheckerIdnull | stringcheckedbooleancheckedAtnull | stringdate-timewaitingForCheckbooleanrecurrencenull | stringrecurrenceUntilnull | stringdatenextTaskIdnull | stringremindDaysBeforeinteger | nullcontactNamenull | stringassignedToNamestringtotalintegerhasMorebooleanrequired