Platform
Operations in the Platform group.
- GET/v1/access-roles
- POST/v1/access-roles
- GET/v1/access-roles/{id}
- PATCH/v1/access-roles/{id}
- DEL/v1/access-roles/{id}
- GET/v1/access-roles/{id}/effective
- GET/v1/access-roles/catalog
- GET/v1/activity
- GET/v1/api-keys
- POST/v1/api-keys
- DEL/v1/api-keys/{id}
- GET/v1/audit-events
- GET/v1/audit/chain
- GET/v1/audit/entries
- GET/v1/audit/entries.csv
- GET/v1/audit/entries.xlsx
- GET/v1/audit/entries/{id}
- GET/v1/audit/facets
- GET/v1/audit/objects/{id}/history
- POST/v1/audit/verify
- GET/v1/billing
- GET/v1/company
- PATCH/v1/company
- GET/v1/company/agendas
- PUT/v1/company/agendas
- POST/v1/company/ares
- GET/v1/company/logo
- POST/v1/company/logo
- POST/v1/company/regime
- POST/v1/company/stamp
- DEL/v1/company/stamp
- GET/v1/document-comments
- POST/v1/document-comments
- DEL/v1/document-comments/{id}
- POST/v1/document-comments/{id}/resolve
- GET/v1/document-exports
- GET/v1/document-requests
- POST/v1/document-requests
- POST/v1/document-requests/{id}/cancel
- POST/v1/document-requests/{id}/fulfil
- GET/v1/exports
- POST/v1/exports
- GET/v1/exports/{id}
- GET/v1/exports/{id}/download
- GET/v1/imports
- POST/v1/imports
- GET/v1/imports/{id}
- POST/v1/imports/{id}/apply
- GET/v1/imports/{id}/reconciliation
- GET/v1/imports/{id}/undo
- POST/v1/imports/{id}/undo
- GET/v1/imports/documents
- POST/v1/imports/mid-year
- POST/v1/imports/opening-balances
- GET/v1/inbox/address
- POST/v1/inbox/address/rotate
- GET/v1/inbox/documents
- POST/v1/inbox/documents
- GET/v1/inbox/documents/{id}
- PATCH/v1/inbox/documents/{id}
- POST/v1/inbox/documents/{id}/discard
- POST/v1/inbox/documents/{id}/extract
- GET/v1/inbox/documents/{id}/file
- POST/v1/inbox/documents/{id}/received-invoice
- POST/v1/inbox/documents/{id}/supplier-advance
- GET/v1/inbox/email-settings
- PUT/v1/inbox/email-settings
- GET/v1/inbox/emails
- GET/v1/inbox/summary
- GET/v1/inbox/todo
- GET/v1/invitations
- DEL/v1/invitations/{id}
- POST/v1/invitations/{id}/resend
- GET/v1/mailboxes
- POST/v1/mailboxes
- PATCH/v1/mailboxes/{id}
- DEL/v1/mailboxes/{id}
- GET/v1/mailboxes/{id}/folders
- POST/v1/mailboxes/{id}/sync
- POST/v1/mailboxes/detect
- GET/v1/mailboxes/messages
- POST/v1/mailboxes/messages
- GET/v1/mailboxes/messages/{id}
- PATCH/v1/mailboxes/messages/{id}
- DEL/v1/mailboxes/messages/{id}
- POST/v1/mailboxes/messages/{id}/forward
- POST/v1/mailboxes/messages/{id}/reply
- GET/v1/mailboxes/providers
- GET/v1/members
- POST/v1/members
- PATCH/v1/members/{id}
- DEL/v1/members/{id}
- GET/v1/members/{id}/access
- GET/v1/members/me
- GET/v1/notifications
- GET/v1/search
- POST/v1/webhook-deliveries/{id}/retry
- GET/v1/webhook-events
- GET/v1/webhooks
- POST/v1/webhooks
- GET/v1/webhooks/{id}
- PATCH/v1/webhooks/{id}
- DEL/v1/webhooks/{id}
- GET/v1/webhooks/{id}/deliveries
- POST/v1/webhooks/{id}/rotate-secret
- POST/v1/webhooks/{id}/test
List the custom roles of this company and how many people have each
/v1/access-rolesList the custom roles of this company and how many people have each
MCP tool: list-access-roles
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"access_role"requiredidstringrequirednamestringrequireddescriptionstring | nullrequiredagendasobjectrequiredsalesstringpayrollstringadministrationstringbankstringcashstringreportsstringcontactsstringinventorystringinboxstringpurchasesstringassetsstringtravelstringtaxstringagendasstringledgerstringscopesobjectrequiredwarehousesarray | nullrequiredregistersarray | nullrequiredaccountsarray | nullrequiredseriesarray | nullrequiredcentersarray | nullmemberCountintegerrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeparentIdnull | stringdeniedobjectformatsstring[]requiredreportsstring[]requiredtotalintegerhasMorebooleanrequiredCreate a custom role: a level per agenda (none, read, own, write, full), and optionally only chosen warehouses, cash registers, bank accounts, number series, and cost centres, without some print reports or export types, or as a sub-role of another
/v1/access-rolesCreate a custom role: a level per agenda (none, read, own, write, full), and optionally only chosen warehouses, cash registers, bank accounts, number series, and cost centres, without some print reports or export types, or as a sub-role of another. own: reads everything, creates, and changes only what the person created. Delete and storno need full. A sub-role takes its parent's rights and can only take away. Members, API keys of others, webhooks, the audit log, and company-wide exports and imports stay with an owner or accountant whatever a custom role says.
MCP tool: create-access-role
Request body
namestringrequiredmax 120 charsdescriptionstring | nullagendasobjectrequiredscopesobjectwarehousesstring[] | nullregistersstring[] | nullaccountsstring[] | nullseriesstring[] | nullcentersstring[] | nullparentIdstring | nulldeniedobjectformats"pdf" | "xlsx" | "csv" | "xml" | "zip"[]reportsstring[]Response · 201
idstringrequirednamestringrequireddescriptionstring | nullrequiredagendasobjectrequiredsalesstringpayrollstringadministrationstringbankstringcashstringreportsstringcontactsstringinventorystringinboxstringpurchasesstringassetsstringtravelstringtaxstringagendasstringledgerstringscopesobjectrequiredwarehousesarray | nullrequiredregistersarray | nullrequiredaccountsarray | nullrequiredseriesarray | nullrequiredcentersarray | nullmemberCountintegerrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeparentIdnull | stringdeniedobjectformatsstring[]requiredreportsstring[]requiredGet one custom role with its rights
/v1/access-roles/{id}Get one custom role with its rights
MCP tool: get-access-role
Path parameters
idstringrequiredResponse · 200
idstringrequirednamestringrequireddescriptionstring | nullrequiredagendasobjectrequiredsalesstringpayrollstringadministrationstringbankstringcashstringreportsstringcontactsstringinventorystringinboxstringpurchasesstringassetsstringtravelstringtaxstringagendasstringledgerstringscopesobjectrequiredwarehousesarray | nullrequiredregistersarray | nullrequiredaccountsarray | nullrequiredseriesarray | nullrequiredcentersarray | nullmemberCountintegerrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeparentIdnull | stringdeniedobjectformatsstring[]requiredreportsstring[]requiredChange a custom role. It holds at once for everyone who has it, including their API keys and connected apps
/v1/access-roles/{id}Change a custom role. It holds at once for everyone who has it, including their API keys and connected apps
MCP tool: update-access-role
Path parameters
idstringrequiredRequest body
namestringmax 120 charsdescriptionstring | nullagendasobjectscopesobjectwarehousesstring[] | nullregistersstring[] | nullaccountsstring[] | nullseriesstring[] | nullcentersstring[] | nullparentIdstring | nulldeniedobjectformats"pdf" | "xlsx" | "csv" | "xml" | "zip"[]reportsstring[]Response · 200
idstringrequirednamestringrequireddescriptionstring | nullrequiredagendasobjectrequiredsalesstringpayrollstringadministrationstringbankstringcashstringreportsstringcontactsstringinventorystringinboxstringpurchasesstringassetsstringtravelstringtaxstringagendasstringledgerstringscopesobjectrequiredwarehousesarray | nullrequiredregistersarray | nullrequiredaccountsarray | nullrequiredseriesarray | nullrequiredcentersarray | nullmemberCountintegerrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timeparentIdnull | stringdeniedobjectformatsstring[]requiredreportsstring[]requiredDelete a custom role nobody has. A role in use is refused, so nobody is left without rights by accident
/v1/access-roles/{id}Delete a custom role nobody has. A role in use is refused, so nobody is left without rights by accident
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-access-role
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredWhat a custom role really comes to, with its parent applied: level per agenda and whether it is inherited, limits with their names, what it goes without, and who has it
/v1/access-roles/{id}/effectiveWhat a custom role really comes to, with its parent applied: level per agenda and whether it is inherited, limits with their names, what it goes without, and who has it
MCP tool: get-access-role-effective
Path parameters
idstringrequiredResponse · 200
rolenull | objectrequiredidstringrequirednamenull | stringrequiredfixedRolenull | stringrequiredparentnull | objectrequiredidstringrequirednamenull | stringrequiredagendasobject[]requiredkeystringrequiredlevelstringrequiredinheritedbooleanrequiredscopesobjectrequiredwarehousesarray | nullrequiredidstringrequirednamenull | stringrequiredregistersanyrequiredaccountsanyrequiredseriesanyrequiredcentersanyrequireddeniedobjectrequiredformatsstring[]requiredreportsobject[]requiredkeystringrequiredcsstringrequiredenstringrequiredfixedOnlystring[]requiredmembersstring[]requiredList the agendas and levels a custom role can set, what each agenda needs to work, and the fixed roles written as rights to start from
/v1/access-roles/catalogList the agendas and levels a custom role can set, what each agenda needs to work, and the fixed roles written as rights to start from
MCP tool: get-access-catalog
Response · 200
agendasobject[]requiredkeystringrequiredneedsstring[]requiredownbooleanlevelsstring[]requiredpresetsobjectrequiredownerobjectrequiredcontactsstringrequiredsalesstringrequiredpurchasesstringrequiredbankstringrequiredcashstringrequiredledgerstringrequiredtaxstringrequiredinventorystringrequiredassetsstringrequiredtravelstringrequiredpayrollstringrequiredagendasstringrequiredreportsstringrequiredinboxstringrequiredadministrationstringrequiredaccountantobjectrequiredcontactsstringrequiredsalesstringrequiredpurchasesstringrequiredbankstringrequiredcashstringrequiredledgerstringrequiredtaxstringrequiredinventorystringrequiredassetsstringrequiredtravelstringrequiredpayrollstringrequiredagendasstringrequiredreportsstringrequiredinboxstringrequiredadministrationstringrequiredinvoicingobjectrequiredcontactsstringrequiredsalesstringrequiredpurchasesstringrequiredbankstringrequiredcashstringrequiredledgerstringrequiredtaxstringrequiredinventorystringrequiredassetsstringrequiredtravelstringrequiredpayrollstringrequiredagendasstringrequiredreportsstringrequiredinboxstringrequiredadministrationstringrequiredwarehouseobjectrequiredcontactsstringrequiredsalesstringrequiredpurchasesstringrequiredbankstringrequiredcashstringrequiredledgerstringrequiredtaxstringrequiredinventorystringrequiredassetsstringrequiredtravelstringrequiredpayrollstringrequiredagendasstringrequiredreportsstringrequiredinboxstringrequiredadministrationstringrequiredreadonlyobjectrequiredcontactsstringrequiredsalesstringrequiredpurchasesstringrequiredbankstringrequiredcashstringrequiredledgerstringrequiredtaxstringrequiredinventorystringrequiredassetsstringrequiredtravelstringrequiredpayrollstringrequiredagendasstringrequiredreportsstringrequiredinboxstringrequiredadministrationstringrequiredexportFormatsstring[]printReportsobject[]keystringrequiredagendastringrequiredcsstringrequiredenstringrequiredList what happened in this company lately: documents issued, payments recorded, statements imported. Without IP addresses or technical calls; the full log is in the audit log
/v1/activityList what happened in this company lately: documents issued, payments recorded, statements imported. Without IP addresses or technical calls; the full log is in the audit log
MCP tool: list-activity
Query parameters
limitintegermin 1max 100Response · 200
dataobject[]requiredobject"activity"requiredidstringrequiredactionstringrequiredobjectTypenull | stringrequiredobjectIdnull | stringrequiredsummarynull | stringrequiredactorLabelnull | stringrequiredcreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredList API keys of this company. Secrets are never shown again after creation.
/v1/api-keysList API keys of this company. Secrets are never shown again after creation.
MCP tool: list-api-keys
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"api_key"requiredidstringrequirednamenull | stringrequiredhintstringrequiredscopestringrequiredsendScopebooleanrequiredlastUsedAtnull | stringrequireddate-timerevokedAtstring | nullrequiredcreatedAtstringrequireddate-timesecretstringtotalintegerhasMorebooleanrequiredCreate an API key. scope "read" allows only reading, "full" also writing. sendScope lets it confirm payment orders and filings where an owner turned that on: only an owner in the dashboard can give it. The secret is returned once.
/v1/api-keysCreate an API key. scope "read" allows only reading, "full" also writing. sendScope lets it confirm payment orders and filings where an owner turned that on: only an owner in the dashboard can give it. The secret is returned once.
MCP tool: create-api-key
Request body
namestringrequiredmax 120 charsscope"read" | "full"default "full"sendScopebooleandefault falseResponse · 201
idstringrequirednamenull | stringrequiredhintstringrequiredscopestringrequiredsendScopebooleanrequiredlastUsedAtnull | stringrequireddate-timerevokedAtstring | nullrequiredcreatedAtstringrequireddate-timesecretstringRevoke an API key. Anything using it stops working immediately.
/v1/api-keys/{id}Revoke an API key. Anything using it stops working immediately.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: revoke-api-key
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList the audit log: who did what, when, from which IP, on which object. Read only: entries can never be changed or deleted.
/v1/audit-eventsList the audit log: who did what, when, from which IP, on which object. Read only: entries can never be changed or deleted.
MCP tool: list-audit-events
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDactionstringmax 100 charsoidstringmax 64 charsactorIdstringmax 64 charsResponse · 200
dataobject[]requiredobject"audit_event"requiredidstringrequiredactionstringrequiredobjectTypenull | stringrequiredobjectIdnull | stringrequiredsummarynull | stringrequireddiffanyrequiredactorTypestringactorIdnull | stringactorLabelnull | stringipnull | stringcreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredThe state of the tamper-evident chain: its latest hash, what waits to be sealed, and the last verification.
/v1/audit/chainThe state of the tamper-evident chain: its latest hash, what waits to be sealed, and the last verification.
MCP tool: get-audit-chain
Response · 200
lastnull | objectrequiredokbooleanrequiredreasonnull | stringrequiredentriesintegerrequiredwaitingintegerrequiredcompletebooleanrequiredheadHashnull | stringrequiredbrokenSeqinteger | nullrequiredsealsCheckedintegerrequiredverifiedAtstringrequireddate-timeheadHashnull | stringrequiredheadSeqintegerrequiredsealedAtnull | stringrequireddate-timewaitingintegerrequiredThe company's audit as a timeline: who did what, when and from where. One entry per request or job, including everything a trigger recorded. Ordinary reads are not recorded.
/v1/audit/entriesThe company's audit as a timeline: who did what, when and from where. One entry per request or job, including everything a trigger recorded. Ordinary reads are not recorded.
MCP tool: list-audit-entries
Query parameters
actorIdstringmax 80 charsagendastringmax 40 charsobjectTypestringmax 80 charsobjectIdstringmax 200 charsactionstringmax 40 charssurface"dashboard" | "public_api" | "mcp" | "job" | "import" | "public_link" | "webhook" | "migration" | "unknown"fromstringYYYY-MM-DDtostringYYYY-MM-DDsearchstringmax 100 charslocale"cs" | "en"limitintegermin 1max 200offsetintegermin 0max 9007199254740991Response · 200
dataobject[]requiredobject"audit_entry"requiredidstringrequiredcreatedAtstringrequireddate-timeactorobjectrequiredtypestringrequiredidnull | stringrequirednamenull | stringrequiredemailnull | stringrequiredjobnull | stringrequireddisplaystringrequiredbehalfnull | objectrequiredidstringrequirednamenull | stringrequiredemailnull | stringrequiredsupportstring | nullrequiredwhereobjectrequiredsurfacestringrequiredsurfaceLabelstringrequiredoperationIdnull | stringrequiredmethodnull | stringrequiredroutenull | stringrequiredipnull | stringrequireduserAgentnull | stringrequiredrequestIdnull | stringrequiredactionnull | stringrequiredwhatstringrequiredsubjectnull | objectrequiredtypenull | stringrequiredtypeLabelnull | stringrequiredidstringrequiredlabelnull | stringrequiredagendanull | stringrequiredchangeCountintegerrequiredeventCountintegerrequiredagendasobject[]idstringrequiredlabelnull | stringrequiredlegacybooleanrequireddirectCountintegercollapsedobject[]tablestringrequiredopstringrequiredtypeLabelstringrequiredactionstringrequiredactionLabelstringrequiredcountintegerrequiredchangesobject[]object"audit_change"requiredidintegerrequiredtablestringrequiredtypeLabelstringrequiredagendastringrequiredagendaLabelstringrequiredobjectIdnull | stringrequiredparentIdnull | stringrequiredlabelnull | stringrequiredactionstringrequiredactionLabelstringrequiredfieldsobject[]requiredfieldnull | stringrequiredlabelnull | stringrequiredformatnull | stringrequiredbeforearray | integer | null | stringrequiredafterarray | boolean | integer | null | object | stringrequiredhiddenboolean | nullrequiredbeforeLabelnull | stringafterLabelnull | stringbeforeTextnull | stringafterTextnull | stringcurrencynull | stringeventsobject[]object"audit_event"requiredidstringrequiredactionstringrequiredobjectTypenull | stringrequiredobjectIdnull | stringrequiredsummarynull | stringrequireddiffanyrequiredactorTypestringactorIdnull | stringactorLabelnull | stringipnull | stringcreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredThe filtered audit as CSV, up to 20 000 entries. The export itself is recorded.
/v1/audit/entries.csvThe filtered audit as CSV, up to 20 000 entries. The export itself is recorded.
MCP tool: export-audit-csv
Query parameters
actorIdstringmax 80 charsagendastringmax 40 charsobjectTypestringmax 80 charsobjectIdstringmax 200 charsactionstringmax 40 charssurface"dashboard" | "public_api" | "mcp" | "job" | "import" | "public_link" | "webhook" | "migration" | "unknown"fromstringYYYY-MM-DDtostringYYYY-MM-DDsearchstringmax 100 charslocale"cs" | "en"limitintegermin 1max 200offsetintegermin 0max 9007199254740991Response · 200
Returns a text/csv file.
The filtered audit as XLSX, up to 20 000 entries. The export itself is recorded.
/v1/audit/entries.xlsxThe filtered audit as XLSX, up to 20 000 entries. The export itself is recorded.
MCP tool: export-audit-xlsx
Query parameters
actorIdstringmax 80 charsagendastringmax 40 charsobjectTypestringmax 80 charsobjectIdstringmax 200 charsactionstringmax 40 charssurface"dashboard" | "public_api" | "mcp" | "job" | "import" | "public_link" | "webhook" | "migration" | "unknown"fromstringYYYY-MM-DDtostringYYYY-MM-DDsearchstringmax 100 charslocale"cs" | "en"limitintegermin 1max 200offsetintegermin 0max 9007199254740991Response · 200
Returns a application/vnd.openxmlformats-officedocument.spreadsheetml.sheet file.
One audit entry with every row it changed, field by field. A secret field says it changed and never its value.
/v1/audit/entries/{id}One audit entry with every row it changed, field by field. A secret field says it changed and never its value.
MCP tool: get-audit-entry
Path parameters
idstringrequiredQuery parameters
locale"cs" | "en"tablestringmax 80 charsop"I" | "U" | "D"limitintegermin 1max 500offsetintegermin 0max 9007199254740991Response · 200
idstringrequiredcreatedAtstringrequireddate-timeactorobjectrequiredtypestringrequiredidnull | stringrequirednamenull | stringrequiredemailnull | stringrequiredjobnull | stringrequireddisplaystringrequiredbehalfnull | objectrequiredidstringrequirednamenull | stringrequiredemailnull | stringrequiredsupportstring | nullrequiredwhereobjectrequiredsurfacestringrequiredsurfaceLabelstringrequiredoperationIdnull | stringrequiredmethodnull | stringrequiredroutenull | stringrequiredipnull | stringrequireduserAgentnull | stringrequiredrequestIdnull | stringrequiredactionnull | stringrequiredwhatstringrequiredsubjectnull | objectrequiredtypenull | stringrequiredtypeLabelnull | stringrequiredidstringrequiredlabelnull | stringrequiredagendanull | stringrequiredchangeCountintegerrequiredeventCountintegerrequiredagendasobject[]idstringrequiredlabelnull | stringrequiredlegacybooleanrequireddirectCountintegercollapsedobject[]tablestringrequiredopstringrequiredtypeLabelstringrequiredactionstringrequiredactionLabelstringrequiredcountintegerrequiredchangesobject[]object"audit_change"requiredidintegerrequiredtablestringrequiredtypeLabelstringrequiredagendastringrequiredagendaLabelstringrequiredobjectIdnull | stringrequiredparentIdnull | stringrequiredlabelnull | stringrequiredactionstringrequiredactionLabelstringrequiredfieldsobject[]requiredfieldnull | stringrequiredlabelnull | stringrequiredformatnull | stringrequiredbeforearray | integer | null | stringrequiredafterarray | boolean | integer | null | object | stringrequireditemsintegeroffersintegerordersintegerpricesintegerjournalintegeraccountsintegerarchivedintegercontactsintegerinvoicesintegerpostingsintegervouchersinteger | stringenquiriesintegermovementsintegerdimensionsintegerpriceListsintegerwarehousesintegerproductionsintegerbankAccountsstringsaleVouchersinteger | stringbankMovementsintegercashRegistersintegerstockDocumentsintegerstockTransfersintegercontactsUpdatedintegerhiddenboolean | nullrequiredbeforeLabelnull | stringafterLabelnull | stringbeforeTextnull | stringafterTextnull | stringcurrencynull | stringeventsobject[]object"audit_event"requiredidstringrequiredactionstringrequiredobjectTypenull | stringrequiredobjectIdnull | stringrequiredsummarynull | stringrequireddiffanyrequiredactorTypestringactorIdnull | stringactorLabelnull | stringipnull | stringcreatedAtstringrequireddate-timeWhat the audit can be filtered by: people and keys that appear in it, agendas, actions and surfaces.
/v1/audit/facetsWhat the audit can be filtered by: people and keys that appear in it, agendas, actions and surfaces.
MCP tool: get-audit-facets
Query parameters
locale"cs" | "en"Response · 200
actorsobject[]requiredidstringrequiredtypestringrequirednamenull | stringrequiredemailnull | stringrequiredlabelnull | stringrequiredagendasobject[]requiredidstringrequiredlabelnull | stringrequiredactionsobject[]requiredidstringrequiredlabelnull | stringrequiredsurfacesobject[]requiredidstringrequiredlabelnull | stringrequiredThe whole trail of one record: a document with its lines and payments, or a contact. Whoever may read the record may read this.
/v1/audit/objects/{id}/historyThe whole trail of one record: a document with its lines and payments, or a contact. Whoever may read the record may read this.
MCP tool: get-audit-history
Path parameters
idstringrequiredQuery parameters
locale"cs" | "en"tablestringmax 80 charsop"I" | "U" | "D"limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"audit_entry"requiredidstringrequiredcreatedAtstringrequireddate-timeactorobjectrequiredtypestringrequiredidnull | stringrequirednamenull | stringrequiredemailnull | stringrequiredjobnull | stringrequireddisplaystringrequiredbehalfnull | objectrequiredidstringrequirednamenull | stringrequiredemailnull | stringrequiredsupportstring | nullrequiredwhereobjectrequiredsurfacestringrequiredsurfaceLabelstringrequiredoperationIdnull | stringrequiredmethodnull | stringrequiredroutenull | stringrequiredipnull | stringrequireduserAgentnull | stringrequiredrequestIdnull | stringrequiredactionnull | stringrequiredwhatstringrequiredsubjectnull | objectrequiredtypenull | stringrequiredtypeLabelnull | stringrequiredidstringrequiredlabelnull | stringrequiredagendanull | stringrequiredchangeCountintegerrequiredeventCountintegerrequiredagendasobject[]idstringrequiredlabelnull | stringrequiredlegacybooleanrequireddirectCountintegercollapsedobject[]tablestringrequiredopstringrequiredtypeLabelstringrequiredactionstringrequiredactionLabelstringrequiredcountintegerrequiredchangesobject[]object"audit_change"requiredidintegerrequiredtablestringrequiredtypeLabelstringrequiredagendastringrequiredagendaLabelstringrequiredobjectIdnull | stringrequiredparentIdnull | stringrequiredlabelnull | stringrequiredactionstringrequiredactionLabelstringrequiredfieldsobject[]requiredfieldnull | stringrequiredlabelnull | stringrequiredformatnull | stringrequiredbeforearray | integer | null | stringrequiredafterarray | boolean | integer | null | object | stringrequiredhiddenboolean | nullrequiredbeforeLabelnull | stringafterLabelnull | stringbeforeTextnull | stringafterTextnull | stringcurrencynull | stringeventsobject[]object"audit_event"requiredidstringrequiredactionstringrequiredobjectTypenull | stringrequiredobjectIdnull | stringrequiredsummarynull | stringrequireddiffanyrequiredactorTypestringactorIdnull | stringactorLabelnull | stringipnull | stringcreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredSeals what is waiting and recomputes the company's hash chain against the recorded data. Answers the first thing that does not hold.
/v1/audit/verifySeals what is waiting and recomputes the company's hash chain against the recorded data. Answers the first thing that does not hold.
MCP tool: verify-audit-chain
Response · 200
okbooleanrequiredcompletebooleanrequiredsealsCheckedintegerrequiredentriesintegerrequiredwaitingintegerrequiredheadHashnull | stringrequiredbrokenSeqinteger | nullrequiredreasonnull | stringrequiredverifiedAtstringrequireddate-timeShow the current plan, trial, usage against limits, and whether online payment is available
/v1/billingShow the current plan, trial, usage against limits, and whether online payment is available
MCP tool: get-billing
Response · 200
enabledbooleanrequiredsubscriptionobjectrequiredobject"billing_subscription"requiredidnull | stringrequiredplanstringrequiredstatusstringrequiredintervalnull | stringrequiredtrialEndsAtnull | stringrequireddate-timecurrentPeriodEndnull | stringrequireddate-timecancelAtPeriodEndbooleanrequiredhasCustomerbooleanrequiredplanobjectrequiredobject"plan"requiredidstringrequirednamenull | objectrequiredcsstringrequiredenstringrequireddescriptionnull | objectrequiredcsstringrequiredenstringrequiredmonthlyHalerintegerrequiredyearlyHalerintegerrequiredlimitsobjectrequireddocumentsPerMonthinteger | nullrequiredmembersinteger | nullrequiredfeaturesobjectrequiredapibooleanrequiredwebhooksbooleanrequiredinboxAibooleanrequiredpurchasablebooleanrequiredusageobjectrequireddocumentsThisMonthintegerrequiredmembersintegerrequiredplansobject[]requiredobject"plan"requiredidstringrequirednamenull | objectrequiredcsstringrequiredenstringrequireddescriptionnull | objectrequiredcsstringrequiredenstringrequiredmonthlyHalerintegerrequiredyearlyHalerintegerrequiredlimitsobjectrequireddocumentsPerMonthinteger | nullrequiredmembersinteger | nullrequiredfeaturesobjectrequiredapibooleanrequiredwebhooksbooleanrequiredinboxAibooleanrequiredpurchasablebooleanrequiredGet the company profile: name, IČO, DIČ, address, VAT status, default bank account, document design
/v1/companyGet the company profile: name, IČO, DIČ, address, VAT status, default bank account, document design
MCP tool: get-company
Response · 200
idstringrequiredsidstringrequirednamenull | stringrequirediconull | stringrequireddicnull | stringrequiredregimestringrequiredvatPayerbooleanrequiredvatPeriodstringrequireddefaultCurrencystringrequiredonboardedbooleanrequiredscheduledRegimeChangenull | objectrequiredregimestringrequiredeffectiveFromnull | stringrequireddatevatHistoryobject[]requiredfromnull | stringrequireddatevatPayerbooleanrequiredvatPeriodstringrequirednotenull | stringstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredwwwnull | stringrequiredregisterNoteanyrequireddefaultLanguagestringrequiredbankAccountobjectrequiredaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringswiftstring | nulllogoFileIdnull | stringrequireddesignobjectrequiredaccentColornull | stringrequiredfooterTextnull | stringrequiredshowLogobooleanrequiredshowQrCodebooleanrequiredlogoPositionstringcreatedAtstringrequireddate-timestampFileIdnull | stringUpdate the company profile. The accounting regime has its own operation.
/v1/companyUpdate the company profile. The accounting regime has its own operation.
MCP tool: update-company
Request body
namestringmax 160 charsicostring | nulldicstring | nullstreetstring | nullcitystring | nullpostalCodestring | nullcountrystring2 charsemailstring | nullphonestring | nullwwwstring | nullregisterNotestring | nullvatPayerbooleanvatPeriod"monthly" | "quarterly"defaultCurrencystring3 charsdefaultLanguage"cs" | "en"bankAccountobjectaccountNumberstring | nullbankCodestring | nullibanstring | nullswiftstring | nulldesignobjectaccentColorstring | nullfooterTextstring | nullshowLogobooleanshowQrCodebooleanResponse · 200
idstringrequiredsidstringrequirednamenull | stringrequirediconull | stringrequireddicnull | stringrequiredregimestringrequiredvatPayerbooleanrequiredvatPeriodstringrequireddefaultCurrencystringrequiredonboardedbooleanrequiredscheduledRegimeChangenull | objectrequiredregimestringrequiredeffectiveFromnull | stringrequireddatevatHistoryobject[]requiredfromnull | stringrequireddatevatPayerbooleanrequiredvatPeriodstringrequirednotenull | stringstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredwwwnull | stringrequiredregisterNoteanyrequireddefaultLanguagestringrequiredbankAccountobjectrequiredaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringswiftstring | nulllogoFileIdnull | stringrequireddesignobjectrequiredaccentColornull | stringrequiredfooterTextnull | stringrequiredshowLogobooleanrequiredshowQrCodebooleanrequiredlogoPositionstringcreatedAtstringrequireddate-timestampFileIdnull | stringWhich agendas this company shows in the dashboard. Display only: the API and MCP reach every agenda whatever this says, and data is never removed. An agenda holding data or required by the regime stays visible
/v1/company/agendasWhich agendas this company shows in the dashboard. Display only: the API and MCP reach every agenda whatever this says, and data is never removed. An agenda holding data or required by the regime stays visible
MCP tool: get-company-agendas
Response · 200
showAllbooleanrequiredchosenbooleanrequiredagendasobject[]requiredkeystringrequiredgroupstringrequiredparentnull | stringrequiredlockedbooleanrequiredhasDatabooleanrequiredenabledbooleanrequiredvisiblebooleanrequiredTurn agendas on or off in the dashboard, or show everything. Owner only. Nothing is removed, and an agenda holding data stays visible
/v1/company/agendasTurn agendas on or off in the dashboard, or show everything. Owner only. Nothing is removed, and an agenda holding data stays visible
MCP tool: update-company-agendas
Request body
showAllbooleanonstring[]offstring[]Response · 200
showAllbooleanrequiredchosenbooleanrequiredagendasobject[]requiredkeystringrequiredgroupstringrequiredparentnull | stringrequiredlockedbooleanrequiredhasDatabooleanrequiredenabledbooleanrequiredvisiblebooleanrequiredLook up an IČO in ARES and return name, address and DIČ to prefill. Saves nothing.
/v1/company/aresLook up an IČO in ARES and return name, address and DIČ to prefill. Saves nothing.
MCP tool: lookup-company-in-ares
Request body
icostringrequiredResponse · 200
sourcestringrequirediconull | stringrequireddicnull | stringrequirednamenull | stringrequiredvatPayerTypestringrequiredaddressnull | objectrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredDownload the company logo
/v1/company/logoDownload the company logo
MCP tool: get-company-logo
Response · 200
Returns a image/png file.
Upload the logo printed on documents (PNG or JPEG, up to 2 MB)
/v1/company/logoUpload the logo printed on documents (PNG or JPEG, up to 2 MB)
MCP tool: upload-company-logo
Request body
contentType"image/png" | "image/jpeg"requiredfileBase64stringrequiredmax 3145728 charsResponse · 200
idstringrequiredsidstringrequirednamenull | stringrequirediconull | stringrequireddicnull | stringrequiredregimestringrequiredvatPayerbooleanrequiredvatPeriodstringrequireddefaultCurrencystringrequiredonboardedbooleanrequiredscheduledRegimeChangenull | objectrequiredregimestringrequiredeffectiveFromnull | stringrequireddatevatHistoryobject[]requiredfromnull | stringrequireddatevatPayerbooleanrequiredvatPeriodstringrequirednotenull | stringstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredwwwnull | stringrequiredregisterNoteanyrequireddefaultLanguagestringrequiredbankAccountobjectrequiredaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringswiftstring | nulllogoFileIdnull | stringrequireddesignobjectrequiredaccentColornull | stringrequiredfooterTextnull | stringrequiredshowLogobooleanrequiredshowQrCodebooleanrequiredlogoPositionstringcreatedAtstringrequireddate-timestampFileIdnull | stringChange the accounting regime (daňová evidence, jednoduché, podvojné účetnictví). With entries in the books it can only be scheduled for the first day of a future period.
/v1/company/regimeChange the accounting regime (daňová evidence, jednoduché, podvojné účetnictví). With entries in the books it can only be scheduled for the first day of a future period.. Returns 409 regime_has_entries when the books hold entries and no valid effectiveFrom is given. This has tax consequences: confirm with the user.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: change-accounting-regime
Request body
regime"tax_records" | "single_entry" | "double_entry"requiredeffectiveFromstringYYYY-MM-DDResponse · 200
idstringrequiredsidstringrequirednamenull | stringrequirediconull | stringrequireddicnull | stringrequiredregimestringrequiredvatPayerbooleanrequiredvatPeriodstringrequireddefaultCurrencystringrequiredonboardedbooleanrequiredscheduledRegimeChangenull | objectrequiredregimestringrequiredeffectiveFromnull | stringrequireddatevatHistoryobject[]requiredfromnull | stringrequireddatevatPayerbooleanrequiredvatPeriodstringrequirednotenull | stringstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredwwwnull | stringrequiredregisterNoteanyrequireddefaultLanguagestringrequiredbankAccountobjectrequiredaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringswiftstring | nulllogoFileIdnull | stringrequireddesignobjectrequiredaccentColornull | stringrequiredfooterTextnull | stringrequiredshowLogobooleanrequiredshowQrCodebooleanrequiredlogoPositionstringcreatedAtstringrequireddate-timestampFileIdnull | stringUpload the company stamp a print layout can place as an element (PNG or JPEG, up to 2 MB)
/v1/company/stampUpload the company stamp a print layout can place as an element (PNG or JPEG, up to 2 MB)
MCP tool: upload-company-stamp
Request body
contentType"image/png" | "image/jpeg"requiredfileBase64stringrequiredmax 3145728 charsResponse · 200
idstringrequiredsidstringrequirednamenull | stringrequirediconull | stringrequireddicnull | stringrequiredregimestringrequiredvatPayerbooleanrequiredvatPeriodstringrequireddefaultCurrencystringrequiredonboardedbooleanrequiredscheduledRegimeChangenull | objectrequiredregimestringrequiredeffectiveFromnull | stringrequireddatevatHistoryobject[]requiredfromnull | stringrequireddatevatPayerbooleanrequiredvatPeriodstringrequirednotenull | stringstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredwwwnull | stringrequiredregisterNoteanyrequireddefaultLanguagestringrequiredbankAccountobjectrequiredaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringswiftstring | nulllogoFileIdnull | stringrequireddesignobjectrequiredaccentColornull | stringrequiredfooterTextnull | stringrequiredshowLogobooleanrequiredshowQrCodebooleanrequiredlogoPositionstringcreatedAtstringrequireddate-timestampFileIdnull | stringForget the company stamp picture. A stamp on a layout then prints the company name and numbers in a frame
/v1/company/stampForget the company stamp picture. A stamp on a layout then prints the company name and numbers in a frame
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-company-stamp
Response · 200
idstringrequiredsidstringrequirednamenull | stringrequirediconull | stringrequireddicnull | stringrequiredregimestringrequiredvatPayerbooleanrequiredvatPeriodstringrequireddefaultCurrencystringrequiredonboardedbooleanrequiredscheduledRegimeChangenull | objectrequiredregimestringrequiredeffectiveFromnull | stringrequireddatevatHistoryobject[]requiredfromnull | stringrequireddatevatPayerbooleanrequiredvatPeriodstringrequirednotenull | stringstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredwwwnull | stringrequiredregisterNoteanyrequireddefaultLanguagestringrequiredbankAccountobjectrequiredaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringswiftstring | nulllogoFileIdnull | stringrequireddesignobjectrequiredaccentColornull | stringrequiredfooterTextnull | stringrequiredshowLogobooleanrequiredshowQrCodebooleanrequiredlogoPositionstringcreatedAtstringrequireddate-timestampFileIdnull | stringList the comments on one document, oldest first
/v1/document-commentsList the comments on one document, oldest first
MCP tool: list-document-comments
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDdocumentKind"invoice" | "received_invoice" | "proforma" | "supplier_advance" | "credit_note" | "delivery_note" | "inbox_document" | "cash_document" | "sales_document"requireddocumentIdstringrequiredmax 64 charsResponse · 200
dataobject[]requiredobject"document_comment"requiredidstringrequireddocumentKindstringrequireddocumentIdstringrequiredauthorIdnull | stringrequiredauthorNamenull | stringrequiredbodystringrequiredresolvedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeminebooleanrequiredtotalintegerhasMorebooleanrequiredComment on a document. E-mails the other people who run the books here.
/v1/document-commentsComment on a document. E-mails the other people who run the books here.
MCP tool: create-document-comment
Request body
documentKind"invoice" | "received_invoice" | "proforma" | "supplier_advance" | "credit_note" | "delivery_note" | "inbox_document" | "cash_document" | "sales_document"requireddocumentIdstringrequiredmax 64 charsbodystringrequiredmax 4000 charsResponse · 201
idstringrequireddocumentKindstringrequireddocumentIdstringrequiredauthorIdnull | stringrequiredauthorNamenull | stringrequiredbodystringrequiredresolvedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeminebooleanrequiredDelete your own comment
/v1/document-comments/{id}Delete your own comment
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-document-comment
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredMark a comment as dealt with, so it no longer counts as open
/v1/document-comments/{id}/resolveMark a comment as dealt with, so it no longer counts as open
MCP tool: resolve-document-comment
Path parameters
idstringrequiredResponse · 200
idstringrequireddocumentKindstringrequireddocumentIdstringrequiredauthorIdnull | stringrequiredauthorNamenull | stringrequiredbodystringrequiredresolvedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeminebooleanrequiredDownload finished documents for another accounting system: POHODA XML, Money S3 XML, CSV with the journal, or ISDOC files in a ZIP
/v1/document-exportsDownload finished documents for another accounting system: POHODA XML, Money S3 XML, CSV with the journal, or ISDOC files in a ZIP. format=pohoda gives a dataPack of invoices, credit notes, advance invoices, orders, stock cards and stock documents. format=money_s3 gives MoneyData with issued and received invoices, orders, stock cards and stock documents; proformas have no place there. format=csv gives a ZIP of invoices, lines and journal. format=isdoc gives a ZIP of issued documents. Drafts and cancelled documents are left out. kinds narrows it: order, stock_card, stock_document only for the two XML formats.
MCP tool: export-accounting-documents
Query parameters
format"pohoda" | "money_s3" | "csv" | "isdoc"requiredfromstringYYYY-MM-DDtostringYYYY-MM-DDkindsstringResponse · 200
Returns a application/octet-stream file.
List requests for documents in this company, newest first
/v1/document-requestsList requests for documents in this company, newest first
MCP tool: list-document-requests
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"open" | "fulfilled" | "cancelled"Response · 200
dataobject[]requiredobject"document_request"requiredidstringrequiredtitlestringrequiredmessagestring | nullrequiredperiodFromstring | nullrequiredperiodTostring | nullrequireddueOnstringrequireddaterecipientsstring[]requiredstatusstringrequiredreminderEveryDaysintegerrequiredmaxRemindersintegerrequiredremindersSentintegerrequirednextReminderOnnull | stringrequireddatelastRemindedAtnull | stringrequireddate-timedocumentsReceivedintegerrequiredfulfilledAtnull | stringrequireddate-timecreatedAtstringrequireddate-timefailedRecipientsany[]totalintegerhasMorebooleanrequiredAsk the client for documents and remind them by e-mail until they are in. Sends real e-mail; confirm the recipients first.
/v1/document-requestsAsk the client for documents and remind them by e-mail until they are in. Sends real e-mail; confirm the recipients first.
MCP tool: create-document-request
Request body
titlestringrequiredmax 160 charsmessagestringmax 2000 charsperiodFromstringYYYY-MM-DDperiodTostringYYYY-MM-DDdueOnstringrequiredYYYY-MM-DDrecipientsstring[]reminderEveryDaysintegermin 1max 30default 3maxRemindersintegermin 0max 20default 5Response · 201
idstringrequiredtitlestringrequiredmessagestring | nullrequiredperiodFromstring | nullrequiredperiodTostring | nullrequireddueOnstringrequireddaterecipientsstring[]requiredstatusstringrequiredreminderEveryDaysintegerrequiredmaxRemindersintegerrequiredremindersSentintegerrequirednextReminderOnnull | stringrequireddatelastRemindedAtnull | stringrequireddate-timedocumentsReceivedintegerrequiredfulfilledAtnull | stringrequireddate-timecreatedAtstringrequireddate-timefailedRecipientsany[]Withdraw a request for documents. Stops the reminders.
/v1/document-requests/{id}/cancelWithdraw a request for documents. Stops the reminders.
MCP tool: cancel-document-request
Path parameters
idstringrequiredResponse · 200
idstringrequiredtitlestringrequiredmessagestring | nullrequiredperiodFromstring | nullrequiredperiodTostring | nullrequireddueOnstringrequireddaterecipientsstring[]requiredstatusstringrequiredreminderEveryDaysintegerrequiredmaxRemindersintegerrequiredremindersSentintegerrequirednextReminderOnnull | stringrequireddatelastRemindedAtnull | stringrequireddate-timedocumentsReceivedintegerrequiredfulfilledAtnull | stringrequireddate-timecreatedAtstringrequireddate-timefailedRecipientsany[]Say the requested documents are all in. Stops the reminders.
/v1/document-requests/{id}/fulfilSay the requested documents are all in. Stops the reminders.
MCP tool: fulfil-document-request
Path parameters
idstringrequiredResponse · 200
idstringrequiredtitlestringrequiredmessagestring | nullrequiredperiodFromstring | nullrequiredperiodTostring | nullrequireddueOnstringrequireddaterecipientsstring[]requiredstatusstringrequiredreminderEveryDaysintegerrequiredmaxRemindersintegerrequiredremindersSentintegerrequirednextReminderOnnull | stringrequireddatelastRemindedAtnull | stringrequireddate-timedocumentsReceivedintegerrequiredfulfilledAtnull | stringrequireddate-timecreatedAtstringrequireddate-timefailedRecipientsany[]List workspace exports, newest first
/v1/exportsList workspace exports, newest first
MCP tool: list-data-exports
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"data_export"requiredidstringrequiredstatusstringrequiredbyteSizeinteger | nullrequiredsummarynull | objectrequiredpdfsintegerrequiredfilesintegerrequiredtablesobjectrequiredbomsintegerfilesintegerrequireditemsintegerassetsintegerleasesintegerseriesintegerrequiredperiodsintegerrequiredaccountsintegerrequiredcontactsintegerrequiredinvoicesintegerrequiredvehiclesintegerbom_linesintegeremployeesintegermovementsintegerproformasintegerdimensionsintegerstock_lotsintegerstocktakesintegerwarehousesintegercredentialsintegerrequiredaudit_eventsintegerrequiredcredit_notesintegerdata_exportsintegerrequiredstock_layersintegertax_profilesintegerbank_accountsintegercash_countersintegerinvoice_linesintegerrequiredjournal_linesintegerrequiredmovement_lotsintegertravel_ordersintegerbank_movementsintegercash_documentsintegercash_registersintegercontact_groupsintegerdelivery_notesintegerimport_batchesintegerproforma_linesintegerstock_balancesintegeruser_workspaceintegerrequiredvehicle_routesintegerinbox_documentsintegerrequiredjournal_entriesintegerrequiredmovement_layersintegerstock_documentsintegerstocktake_linesintegerbank_allocationsintegerinvoice_paymentsintegercredit_note_linesintegerinvoice_vat_linesintegerrequiredlease_instalmentsintegerreceived_invoicesintegerproforma_vat_linesintegerstock_lot_balancesintegerstock_reservationsintegerdelivery_note_linesintegerstock_number_seriesintegeraccounting_templatesintegerrequiredcredit_note_paymentsintegeremployment_contractsintegerstock_document_linesintegerreceived_invoice_linesintegerreceived_invoice_vat_linesintegerreceived_invoice_settlementsintegercontact_addressesintegerwebhook_endpointsintegerwarningsany[]requirederrorstring | nullrequiredcreatedAtstringrequireddate-timefinishedAtnull | stringrequireddate-timetotalintegerhasMorebooleanrequiredStart a full export of this company: a ZIP of JSON, spreadsheets, document PDFs and attachments, built in the background
/v1/exportsStart a full export of this company: a ZIP of JSON, spreadsheets, document PDFs and attachments, built in the background
MCP tool: create-data-export
Response · 202
idstringrequiredstatusstringrequiredbyteSizeinteger | nullrequiredsummarynull | objectrequiredpdfsintegerrequiredfilesintegerrequiredtablesobjectrequiredbomsintegerfilesintegerrequireditemsintegerassetsintegerleasesintegerseriesintegerrequiredperiodsintegerrequiredaccountsintegerrequiredcontactsintegerrequiredinvoicesintegerrequiredvehiclesintegerbom_linesintegeremployeesintegermovementsintegerproformasintegerdimensionsintegerstock_lotsintegerstocktakesintegerwarehousesintegercredentialsintegerrequiredaudit_eventsintegerrequiredcredit_notesintegerdata_exportsintegerrequiredstock_layersintegertax_profilesintegerbank_accountsintegercash_countersintegerinvoice_linesintegerrequiredjournal_linesintegerrequiredmovement_lotsintegertravel_ordersintegerbank_movementsintegercash_documentsintegercash_registersintegercontact_groupsintegerdelivery_notesintegerimport_batchesintegerproforma_linesintegerstock_balancesintegeruser_workspaceintegerrequiredvehicle_routesintegerinbox_documentsintegerrequiredjournal_entriesintegerrequiredmovement_layersintegerstock_documentsintegerstocktake_linesintegerbank_allocationsintegerinvoice_paymentsintegercredit_note_linesintegerinvoice_vat_linesintegerrequiredlease_instalmentsintegerreceived_invoicesintegerproforma_vat_linesintegerstock_lot_balancesintegerstock_reservationsintegerdelivery_note_linesintegerstock_number_seriesintegeraccounting_templatesintegerrequiredcredit_note_paymentsintegeremployment_contractsintegerstock_document_linesintegerreceived_invoice_linesintegerreceived_invoice_vat_linesintegerreceived_invoice_settlementsintegercontact_addressesintegerwebhook_endpointsintegerwarningsany[]requirederrorstring | nullrequiredcreatedAtstringrequireddate-timefinishedAtnull | stringrequireddate-timeGet the status of a workspace export
/v1/exports/{id}Get the status of a workspace export
MCP tool: get-data-export
Path parameters
idstringrequiredResponse · 200
idstringrequiredstatusstringrequiredbyteSizeinteger | nullrequiredsummarynull | objectrequiredpdfsintegerrequiredfilesintegerrequiredtablesobjectrequiredbomsintegerfilesintegerrequireditemsintegerassetsintegerleasesintegerseriesintegerrequiredperiodsintegerrequiredaccountsintegerrequiredcontactsintegerrequiredinvoicesintegerrequiredvehiclesintegerbom_linesintegeremployeesintegermovementsintegerproformasintegerdimensionsintegerstock_lotsintegerstocktakesintegerwarehousesintegercredentialsintegerrequiredaudit_eventsintegerrequiredcredit_notesintegerdata_exportsintegerrequiredstock_layersintegertax_profilesintegerbank_accountsintegercash_countersintegerinvoice_linesintegerrequiredjournal_linesintegerrequiredmovement_lotsintegertravel_ordersintegerbank_movementsintegercash_documentsintegercash_registersintegercontact_groupsintegerdelivery_notesintegerimport_batchesintegerproforma_linesintegerstock_balancesintegeruser_workspaceintegerrequiredvehicle_routesintegerinbox_documentsintegerrequiredjournal_entriesintegerrequiredmovement_layersintegerstock_documentsintegerstocktake_linesintegerbank_allocationsintegerinvoice_paymentsintegercredit_note_linesintegerinvoice_vat_linesintegerrequiredlease_instalmentsintegerreceived_invoicesintegerproforma_vat_linesintegerstock_lot_balancesintegerstock_reservationsintegerdelivery_note_linesintegerstock_number_seriesintegeraccounting_templatesintegerrequiredcredit_note_paymentsintegeremployment_contractsintegerstock_document_linesintegerreceived_invoice_linesintegerreceived_invoice_vat_linesintegerreceived_invoice_settlementsintegercontact_addressesintegerwebhook_endpointsintegerwarningsany[]requirederrorstring | nullrequiredcreatedAtstringrequireddate-timefinishedAtnull | stringrequireddate-timeDownload a finished workspace export as a ZIP
/v1/exports/{id}/downloadDownload a finished workspace export as a ZIP
MCP tool: download-data-export
Path parameters
idstringrequiredResponse · 200
Returns a application/zip file.
List imports, newest first
/v1/importsList imports, newest first
MCP tool: list-imports
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"import_batch"requiredidstringrequiredsourcestringrequiredkindstringrequiredfilenamenull | stringrequiredstatusstringrequiredreportobjectrequiredformatstringsectionsobjectrequiredcontactsobjectbankobjectvouchersobjectordersobjectoffersobjectstock_documentsobjectstockobjectaccountsobjectpostingsobjectdimensionsobjectprice_listsobjectjournalobjectinvoicesobjectopening_balancesobjectfixed_assetsobjectenquiriesobjectproductionsobjectsale_vouchersobjectstock_transfersobjectinternal_documentsobjectproduct_dataobjectmoneyobjectincomeobjectexpensesobjectpayablesobjectreceivablesobjectwarningsstring[]sourceIconull | stringapplicationnull | stringunsupportedobjectclaimintegerbalanceItemsintegerbalancedbooleandebitHalerintegercreditHalerintegeropeningDatenull | stringdateunknownColumnsstring[]taxBaseSoFarHalerintegerresultnull | objectrequiredlinesintegerjournalintegeritemsintegeroffersintegerordersintegerpricesintegeraccountsintegerarchivedintegercontactsintegerinvoicesintegerpostingsintegervouchersintegerenquiriesintegermovementsintegerdimensionsintegerpriceListsintegerwarehousesintegerproductionsintegerbankAccountsintegersaleVouchersintegerbankMovementsintegercashRegistersintegerstockDocumentsintegerstockTransfersintegercontactsUpdatedintegerfixedAssetsintegergpsrintegercustomFieldsintegerrecyclingFeesintegerincomeintegerexpensesintegerpayablesintegerregistersintegerreceivablesintegererrornull | stringrequiredcreatedAtstringrequireddate-timeappliedAtnull | stringrequireddate-timeundoneAtnull | stringrequireddate-timeundoobjectremovedobjectrequiredcontactintegerdimensionintegerinvoiceintegeritemintegerwarehouseintegerassetintegerstock_documentintegersales_documentintegerimported_documentintegergpsr_recordintegerrecycling_feeintegercustom_fieldintegerreceived_invoiceintegercash_book_entryintegerbook_balance_openingintegerreversedEntriesintegerrequiredkeptAccountsintegerrequiredkeptDimensionsintegerrequiredtotalintegerhasMorebooleanrequiredUpload a POHODA XML, XLSX or CSV file and get a dry-run report of what importing it would do. Changes nothing yet.
/v1/importsUpload a POHODA XML, XLSX or CSV file and get a dry-run report of what importing it would do. Changes nothing yet.. source=pohoda reads a dataPack or responsePack: adresář, faktury, zásoby, účetní deník, pokladna, banka, objednávky, nabídky, příjemky, výdejky, převodky, výroba, prodejky, poptávky, interní doklady, ceníky, účtová osnova, předkontace, střediska, činnosti, zakázky. With kind=opening_from_journal it turns a deník into opening balances at openingDate. source=tabular needs kind contacts, opening_balances or fixed_assets.
MCP tool: create-import
Request body
source"pohoda" | "tabular"requiredkind"contacts" | "opening_balances" | "fixed_assets" | "opening_from_journal"filenamestringrequiredmax 200 charsfileBase64stringrequiredmax 62914560 charsopeningDatestringYYYY-MM-DDResponse · 201
idstringrequiredsourcestringrequiredkindstringrequiredfilenamenull | stringrequiredstatusstringrequiredreportobjectrequiredformatstringsectionsobjectrequiredcontactsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredbankobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredvouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredordersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredoffersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredstock_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstockobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredaccountsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpostingsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requireddimensionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredprice_listsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredjournalobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredinvoicesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredopening_balancesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredfixed_assetsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredenquiriesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproductionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredsale_vouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstock_transfersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredinternal_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproduct_dataobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredmoneyobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesany[]requiredwarningsany[]requiredincomeobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredexpensesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpayablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredreceivablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredwarningsstring[]sourceIconull | stringapplicationnull | stringunsupportedobjectclaimintegerbalanceItemsintegerbalancedbooleandebitHalerintegercreditHalerintegeropeningDatenull | stringdateunknownColumnsstring[]taxBaseSoFarHalerintegerresultnull | objectrequiredlinesintegerjournalintegeritemsintegeroffersintegerordersintegerpricesintegeraccountsintegerarchivedintegercontactsintegerinvoicesintegerpostingsintegervouchersintegerenquiriesintegermovementsintegerdimensionsintegerpriceListsintegerwarehousesintegerproductionsintegerbankAccountsintegersaleVouchersintegerbankMovementsintegercashRegistersintegerstockDocumentsintegerstockTransfersintegercontactsUpdatedintegerfixedAssetsintegergpsrintegercustomFieldsintegerrecyclingFeesintegerincomeintegerexpensesintegerpayablesintegerregistersintegerreceivablesintegererrornull | stringrequiredcreatedAtstringrequireddate-timeappliedAtnull | stringrequireddate-timeundoneAtnull | stringrequireddate-timeundoobjectremovedobjectrequiredcontactintegerdimensionintegerinvoiceintegeritemintegerwarehouseintegerassetintegerstock_documentintegersales_documentintegerimported_documentintegergpsr_recordintegerrecycling_feeintegercustom_fieldintegerreceived_invoiceintegercash_book_entryintegerbook_balance_openingintegerreversedEntriesintegerrequiredkeptAccountsintegerrequiredkeptDimensionsintegerrequiredGet an import with its dry-run report and result
/v1/imports/{id}Get an import with its dry-run report and result
MCP tool: get-import
Path parameters
idstringrequiredResponse · 200
idstringrequiredsourcestringrequiredkindstringrequiredfilenamenull | stringrequiredstatusstringrequiredreportobjectrequiredformatstringsectionsobjectrequiredcontactsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredbankobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredvouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredordersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredoffersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredstock_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstockobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredaccountsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpostingsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requireddimensionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredprice_listsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredjournalobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredinvoicesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredopening_balancesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredfixed_assetsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredenquiriesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproductionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredsale_vouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstock_transfersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredinternal_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproduct_dataobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredmoneyobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesany[]requiredwarningsany[]requiredincomeobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredexpensesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpayablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredreceivablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredwarningsstring[]sourceIconull | stringapplicationnull | stringunsupportedobjectclaimintegerbalanceItemsintegerbalancedbooleandebitHalerintegercreditHalerintegeropeningDatenull | stringdateunknownColumnsstring[]taxBaseSoFarHalerintegerresultnull | objectrequiredlinesintegerjournalintegeritemsintegeroffersintegerordersintegerpricesintegeraccountsintegerarchivedintegercontactsintegerinvoicesintegerpostingsintegervouchersintegerenquiriesintegermovementsintegerdimensionsintegerpriceListsintegerwarehousesintegerproductionsintegerbankAccountsintegersaleVouchersintegerbankMovementsintegercashRegistersintegerstockDocumentsintegerstockTransfersintegercontactsUpdatedintegerfixedAssetsintegergpsrintegercustomFieldsintegerrecyclingFeesintegerincomeintegerexpensesintegerpayablesintegerregistersintegerreceivablesintegererrornull | stringrequiredcreatedAtstringrequireddate-timeappliedAtnull | stringrequireddate-timeundoneAtnull | stringrequireddate-timeundoobjectremovedobjectrequiredcontactintegerdimensionintegerinvoiceintegeritemintegerwarehouseintegerassetintegerstock_documentintegersales_documentintegerimported_documentintegergpsr_recordintegerrecycling_feeintegercustom_fieldintegerreceived_invoiceintegercash_book_entryintegerbook_balance_openingintegerreversedEntriesintegerrequiredkeptAccountsintegerrequiredkeptDimensionsintegerrequiredRun an import after its dry run. All or nothing. Posting a journal or opening balances writes to the books.
/v1/imports/{id}/applyRun an import after its dry run. All or nothing. Posting a journal or opening balances writes to the books.
MCP tool: apply-import
Path parameters
idstringrequiredRequest body
sections"accounts" | "postings" | "dimensions" | "contacts" | "stock" | "price_lists" | "invoices" | "vouchers" | "bank" | "orders" | "offers" | "stock_documents" | "journal"[]importStockQuantitiesbooleandefault trueResponse · 202
idstringrequiredsourcestringrequiredkindstringrequiredfilenamenull | stringrequiredstatusstringrequiredreportobjectrequiredformatstringsectionsobjectrequiredcontactsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredbankobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredvouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredordersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredoffersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredstock_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstockobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredaccountsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpostingsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requireddimensionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredprice_listsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredjournalobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredinvoicesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredopening_balancesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredfixed_assetsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredenquiriesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproductionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredsale_vouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstock_transfersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredinternal_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproduct_dataobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredmoneyobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesany[]requiredwarningsany[]requiredincomeobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredexpensesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpayablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredreceivablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredwarningsstring[]sourceIconull | stringapplicationnull | stringunsupportedobjectclaimintegerbalanceItemsintegerbalancedbooleandebitHalerintegercreditHalerintegeropeningDatenull | stringdateunknownColumnsstring[]taxBaseSoFarHalerintegerresultnull | objectrequiredlinesintegerjournalintegeritemsintegeroffersintegerordersintegerpricesintegeraccountsintegerarchivedintegercontactsintegerinvoicesintegerpostingsintegervouchersintegerenquiriesintegermovementsintegerdimensionsintegerpriceListsintegerwarehousesintegerproductionsintegerbankAccountsintegersaleVouchersintegerbankMovementsintegercashRegistersintegerstockDocumentsintegerstockTransfersintegercontactsUpdatedintegerfixedAssetsintegergpsrintegercustomFieldsintegerrecyclingFeesintegerincomeintegerexpensesintegerpayablesintegerregistersintegerreceivablesintegererrornull | stringrequiredcreatedAtstringrequireddate-timeappliedAtnull | stringrequireddate-timeundoneAtnull | stringrequireddate-timeundoobjectremovedobjectrequiredcontactintegerdimensionintegerinvoiceintegeritemintegerwarehouseintegerassetintegerstock_documentintegersales_documentintegerimported_documentintegergpsr_recordintegerrecycling_feeintegercustom_fieldintegerreceived_invoiceintegercash_book_entryintegerbook_balance_openingintegerreversedEntriesintegerrequiredkeptAccountsintegerrequiredkeptDimensionsintegerrequiredCompare what a POHODA file says with what is in the books now, section by section: counts, totals, missing documents and differences
/v1/imports/{id}/reconciliationCompare what a POHODA file says with what is in the books now, section by section: counts, totals, missing documents and differences
MCP tool: get-import-reconciliation
Path parameters
idstringrequiredResponse · 200
idstringrequiredstatusstringrequiredbalancedbooleanrequiredsectionsobject[]requiredkeystringrequiredlabelnull | stringrequiredpohodaCountintegerrequiredoursCountintegerrequiredtotalsobject[]requiredcurrencynull | stringrequiredpohodaHalerintegerrequiredoursHalerintegerrequireddifferenceHalerintegerrequiredmissingobject[]requirednumbernull | stringrequiredcurrencynull | stringpohodaHalerintegerdifferentobject[]requirednumbernull | stringrequiredcurrencynull | stringrequiredpohodaHalerintegerrequiredoursHalerintegerrequireddifferenceHalerintegerrequiredskippedintegerrequiredbalancedbooleanrequiredaccountsobject[]requiredaccountNumbernull | stringrequiredpohodaDebitHalerintegerrequiredpohodaCreditHalerintegerrequiredoursDebitHalerintegerrequiredoursCreditHalerintegerrequireddifferenceHalerintegerrequiredSay whether an applied import can still be undone, and what stands in the way
/v1/imports/{id}/undoSay whether an applied import can still be undone, and what stands in the way
MCP tool: get-import-undo-check
Path parameters
idstringrequiredResponse · 200
idstringrequiredpossiblebooleanrequiredreasonnull | stringrequiredblockersobject[]requiredobjectTypenull | stringrequiredobjectIdnull | stringrequiredreasonnull | stringrequiredcountsobjectrequiredcontactintegerdimensionintegerinvoiceintegeritemintegerwarehouseintegerreceived_invoiceintegerblockerCountintegerUndo a whole import while nothing has been built on it. Removes what it created and reverses what it posted. All or nothing.
/v1/imports/{id}/undoUndo a whole import while nothing has been built on it. Removes what it created and reverses what it posted. All or nothing.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: undo-import
Path parameters
idstringrequiredResponse · 200
idstringrequiredsourcestringrequiredkindstringrequiredfilenamenull | stringrequiredstatusstringrequiredreportobjectrequiredformatstringsectionsobjectrequiredcontactsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredbankobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredvouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredordersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredoffersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredstock_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstockobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredaccountsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpostingsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requireddimensionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredprice_listsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredjournalobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredinvoicesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredopening_balancesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredfixed_assetsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredenquiriesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproductionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredsale_vouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstock_transfersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredinternal_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproduct_dataobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredmoneyobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesany[]requiredwarningsany[]requiredincomeobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredexpensesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpayablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredreceivablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredwarningsstring[]sourceIconull | stringapplicationnull | stringunsupportedobjectclaimintegerbalanceItemsintegerbalancedbooleandebitHalerintegercreditHalerintegeropeningDatenull | stringdateunknownColumnsstring[]taxBaseSoFarHalerintegerresultnull | objectrequiredlinesintegerjournalintegeritemsintegeroffersintegerordersintegerpricesintegeraccountsintegerarchivedintegercontactsintegerinvoicesintegerpostingsintegervouchersintegerenquiriesintegermovementsintegerdimensionsintegerpriceListsintegerwarehousesintegerproductionsintegerbankAccountsintegersaleVouchersintegerbankMovementsintegercashRegistersintegerstockDocumentsintegerstockTransfersintegercontactsUpdatedintegerfixedAssetsintegergpsrintegercustomFieldsintegerrecyclingFeesintegerincomeintegerexpensesintegerpayablesintegerregistersintegerreceivablesintegererrornull | stringrequiredcreatedAtstringrequireddate-timeappliedAtnull | stringrequireddate-timeundoneAtnull | stringrequireddate-timeundoobjectremovedobjectrequiredcontactintegerdimensionintegerinvoiceintegeritemintegerwarehouseintegerassetintegerstock_documentintegersales_documentintegerimported_documentintegergpsr_recordintegerrecycling_feeintegercustom_fieldintegerreceived_invoiceintegercash_book_entryintegerbook_balance_openingintegerreversedEntriesintegerrequiredkeptAccountsintegerrequiredkeptDimensionsintegerrequiredPOHODA documents kept as history without an agenda of their own: interní doklady and received enquiries
/v1/imports/documentsPOHODA documents kept as history without an agenda of their own: interní doklady and received enquiries
MCP tool: list-imported-documents
Query parameters
kind"internal_document" | "received_enquiry"limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"imported_document"requiredidstringrequiredkindstringrequirednumberstringrequireddatestringrequireddatedescriptionnull | stringrequiredcontactNamenull | stringrequiredcurrencystringrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredlinesobject[]requiredunitnull | stringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequireddescriptionnull | stringrequiredquantityMilliinteger | nullrequiredtotalintegerhasMorebooleanrequiredMid-year transition for tax records and single entry: balances of accounts and registers, open receivables and payables, income and expenses so far. Returns a dry-run report. Changes nothing until the import is applied
/v1/imports/mid-yearMid-year transition for tax records and single entry: balances of accounts and registers, open receivables and payables, income and expenses so far. Returns a dry-run report. Changes nothing until the import is applied
MCP tool: create-mid-year-transition
Request body
openingDatestringrequiredYYYY-MM-DDbankAccountsobject[]idstringrequiredbalanceHalerintegerrequiredmin -9007199254740991max 9007199254740991cashRegistersobject[]idstringrequiredbalanceHalerintegerrequiredmin 0max 9007199254740991receivablesobject[]numberstringrequiredmax 60 charscontactNamestringrequiredmax 200 charsicostringissueDatestringrequiredYYYY-MM-DDdueDatestringYYYY-MM-DDamountHalerintegerrequiredmin 1max 9007199254740991vatHalerintegermin 0max 9007199254740991payablesobject[]numberstringrequiredmax 60 charscontactNamestringrequiredmax 200 charsicostringissueDatestringrequiredYYYY-MM-DDdueDatestringYYYY-MM-DDamountHalerintegerrequiredmin 1max 9007199254740991vatHalerintegermin 0max 9007199254740991incomeobject[]descriptionstringrequiredmax 200 charsamountHalerintegerrequiredmin 1max 9007199254740991vatHalerintegermin 0max 9007199254740991classification"income_taxable" | "income_exempt" | "expense_deductible" | "expense_nondeductible"categorystringmax 60 charsactivityKind"main" | "economic"moneyAccount"bank" | "cash"expensesobject[]descriptionstringrequiredmax 200 charsamountHalerintegerrequiredmin 1max 9007199254740991vatHalerintegermin 0max 9007199254740991classification"income_taxable" | "income_exempt" | "expense_deductible" | "expense_nondeductible"categorystringmax 60 charsactivityKind"main" | "economic"moneyAccount"bank" | "cash"Response · 201
idstringrequiredsourcestringrequiredkindstringrequiredfilenamenull | stringrequiredstatusstringrequiredreportobjectrequiredformatstringsectionsobjectrequiredcontactsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredbankobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredvouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredordersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredoffersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredstock_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstockobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredaccountsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpostingsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requireddimensionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredprice_listsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredjournalobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredinvoicesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredopening_balancesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredfixed_assetsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredenquiriesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproductionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredsale_vouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstock_transfersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredinternal_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproduct_dataobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredmoneyobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesany[]requiredwarningsany[]requiredincomeobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredexpensesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpayablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredreceivablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredwarningsstring[]sourceIconull | stringapplicationnull | stringunsupportedobjectclaimintegerbalanceItemsintegerbalancedbooleandebitHalerintegercreditHalerintegeropeningDatenull | stringdateunknownColumnsstring[]taxBaseSoFarHalerintegerresultnull | objectrequiredlinesintegerjournalintegeritemsintegeroffersintegerordersintegerpricesintegeraccountsintegerarchivedintegercontactsintegerinvoicesintegerpostingsintegervouchersintegerenquiriesintegermovementsintegerdimensionsintegerpriceListsintegerwarehousesintegerproductionsintegerbankAccountsintegersaleVouchersintegerbankMovementsintegercashRegistersintegerstockDocumentsintegerstockTransfersintegercontactsUpdatedintegerfixedAssetsintegergpsrintegercustomFieldsintegerrecyclingFeesintegerincomeintegerexpensesintegerpayablesintegerregistersintegerreceivablesintegererrornull | stringrequiredcreatedAtstringrequireddate-timeappliedAtnull | stringrequireddate-timeundoneAtnull | stringrequireddate-timeundoobjectremovedobjectrequiredcontactintegerdimensionintegerinvoiceintegeritemintegerwarehouseintegerassetintegerstock_documentintegersales_documentintegerimported_documentintegergpsr_recordintegerrecycling_feeintegercustom_fieldintegerreceived_invoiceintegercash_book_entryintegerbook_balance_openingintegerreversedEntriesintegerrequiredkeptAccountsintegerrequiredkeptDimensionsintegerrequiredType opening balances for a mid-year switch and get a dry-run report. Changes nothing until the import is applied.
/v1/imports/opening-balancesType opening balances for a mid-year switch and get a dry-run report. Changes nothing until the import is applied.
MCP tool: create-typed-opening-balances
Request body
openingDatestringrequiredYYYY-MM-DDlinesobject[]requiredaccountNumberstringrequiredaccountNamestringmax 200 charsdebitHalerintegermin 0max 9007199254740991default 0creditHalerintegermin 0max 9007199254740991default 0Response · 201
idstringrequiredsourcestringrequiredkindstringrequiredfilenamenull | stringrequiredstatusstringrequiredreportobjectrequiredformatstringsectionsobjectrequiredcontactsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredbankobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredvouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredordersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredoffersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredstock_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstockobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredaccountsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpostingsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requireddimensionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredprice_listsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredjournalobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredinvoicesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredopening_balancesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredfixed_assetsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredenquiriesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproductionsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredsale_vouchersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredstock_transfersobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredinternal_documentsobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredproduct_dataobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredmoneyobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesany[]requiredwarningsany[]requiredincomeobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsstring[]requiredexpensesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsany[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredpayablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredreceivablesobjectskipintegerrequiredlabelnull | stringrequiredtotalintegerrequiredcreateintegerrequirederrorsstring[]requiredupdateintegerrequiredsamplesobject[]requiredwarningsany[]requiredwarningsstring[]sourceIconull | stringapplicationnull | stringunsupportedobjectclaimintegerbalanceItemsintegerbalancedbooleandebitHalerintegercreditHalerintegeropeningDatenull | stringdateunknownColumnsstring[]taxBaseSoFarHalerintegerresultnull | objectrequiredlinesintegerjournalintegeritemsintegeroffersintegerordersintegerpricesintegeraccountsintegerarchivedintegercontactsintegerinvoicesintegerpostingsintegervouchersintegerenquiriesintegermovementsintegerdimensionsintegerpriceListsintegerwarehousesintegerproductionsintegerbankAccountsintegersaleVouchersintegerbankMovementsintegercashRegistersintegerstockDocumentsintegerstockTransfersintegercontactsUpdatedintegerfixedAssetsintegergpsrintegercustomFieldsintegerrecyclingFeesintegerincomeintegerexpensesintegerpayablesintegerregistersintegerreceivablesintegererrornull | stringrequiredcreatedAtstringrequireddate-timeappliedAtnull | stringrequireddate-timeundoneAtnull | stringrequireddate-timeundoobjectremovedobjectrequiredcontactintegerdimensionintegerinvoiceintegeritemintegerwarehouseintegerassetintegerstock_documentintegersales_documentintegerimported_documentintegergpsr_recordintegerrecycling_feeintegercustom_fieldintegerreceived_invoiceintegercash_book_entryintegerbook_balance_openingintegerreversedEntriesintegerrequiredkeptAccountsintegerrequiredkeptDimensionsintegerrequiredGet the e-mail address that puts received attachments into this queue
/v1/inbox/addressGet the e-mail address that puts received attachments into this queue
MCP tool: get-inbox-address
Response · 200
addressnull | stringrequiredenabledbooleanrequiredaiEnabledbooleanReplace the company address with a new one, for when the old one leaked. Mail to the old address stops being accepted.
/v1/inbox/address/rotateReplace the company address with a new one, for when the old one leaked. Mail to the old address stops being accepted.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: rotate-inbox-address
Response · 200
addressnull | stringrequiredenabledbooleanrequiredaiEnabledbooleanList received documents in the queue. By default those not finished yet.
/v1/inbox/documentsList received documents in the queue. By default those not finished yet.
MCP tool: list-inbox-documents
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991status"new" | "done" | "discarded"Response · 200
dataobject[]requiredobject"inbox_document"requiredidstringrequiredfilenamestringrequiredsourcestringrequiredsendernull | stringrequiredsubjectnull | stringrequiredstatusstringrequiredfileIdstringrequiredextractionSourcenull | stringrequiredextractionnull | objectrequiredibanstring | nulldueDatenull | stringdatebankCodenull | stringcurrencynull | stringnetHalerinteger | nullrequiredvatHalerinteger | nullrequiredvatLinesobject[]requiredvatRateintegerrequirednetHalerintegerrequiredvatHalerinteger | nullrequiredissueDatenull | stringrequireddatetotalHalerinteger | nullrequiredsupplierDicnull | stringsupplierIconull | stringdocumentTypeinteger | nullpayableHalerinteger | nullsupplierCityanysupplierNamenull | stringrequiredtaxPointDatenull | stringdateaccountNumbernull | stringdocumentNumbernull | stringrequiredsupplierStreetanyvariableSymbolnull | stringsupplierPostalCodeanyisInvoicebooleanextractionErrornull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredrequestIdnull | stringrequiredhasCompanionbooleanrequiredcreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredAdd a received document (PDF, image, or ISDOC, base64, up to 25 MB) to the queue. Values are read from it automatically.
/v1/inbox/documentsAdd a received document (PDF, image, or ISDOC, base64, up to 25 MB) to the queue. Values are read from it automatically.
MCP tool: upload-inbox-document
Request body
requestIdstringmax 64 charsfilenamestringrequiredmax 200 charscontentTypestringmax 100 charsfileBase64stringrequiredmax 62914560 charsResponse · 201
idstringrequiredfilenamestringrequiredsourcestringrequiredsendernull | stringrequiredsubjectnull | stringrequiredstatusstringrequiredfileIdstringrequiredextractionSourcenull | stringrequiredextractionnull | objectrequiredibanstring | nulldueDatenull | stringdatebankCodenull | stringcurrencynull | stringnetHalerinteger | nullrequiredvatHalerinteger | nullrequiredvatLinesobject[]requiredvatRateintegerrequirednetHalerintegerrequiredvatHalerinteger | nullrequiredissueDatenull | stringrequireddatetotalHalerinteger | nullrequiredsupplierDicnull | stringsupplierIconull | stringdocumentTypeinteger | nullpayableHalerinteger | nullsupplierCityanysupplierNamenull | stringrequiredtaxPointDatenull | stringdateaccountNumbernull | stringdocumentNumbernull | stringrequiredsupplierStreetanyvariableSymbolnull | stringsupplierPostalCodeanyisInvoicebooleanextractionErrornull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredrequestIdnull | stringrequiredhasCompanionbooleanrequiredcreatedAtstringrequireddate-timeGet a received document with the values read from it
/v1/inbox/documents/{id}Get a received document with the values read from it
MCP tool: get-inbox-document
Path parameters
idstringrequiredResponse · 200
idstringrequiredfilenamestringrequiredsourcestringrequiredsendernull | stringrequiredsubjectnull | stringrequiredstatusstringrequiredfileIdstringrequiredextractionSourcenull | stringrequiredextractionnull | objectrequiredibanstring | nulldueDatenull | stringdatebankCodenull | stringcurrencynull | stringnetHalerinteger | nullrequiredvatHalerinteger | nullrequiredvatLinesobject[]requiredvatRateintegerrequirednetHalerintegerrequiredvatHalerinteger | nullrequiredissueDatenull | stringrequireddatetotalHalerinteger | nullrequiredsupplierDicnull | stringsupplierIconull | stringdocumentTypeinteger | nullpayableHalerinteger | nullsupplierCityanysupplierNamenull | stringrequiredtaxPointDatenull | stringdateaccountNumbernull | stringdocumentNumbernull | stringrequiredsupplierStreetanyvariableSymbolnull | stringsupplierPostalCodeanyisInvoicebooleanextractionErrornull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredrequestIdnull | stringrequiredhasCompanionbooleanrequiredcreatedAtstringrequireddate-timeCorrect the values read from a received document before creating the invoice
/v1/inbox/documents/{id}Correct the values read from a received document before creating the invoice
MCP tool: update-inbox-document
Path parameters
idstringrequiredRequest body
supplierNamestring | nullsupplierIcostring | nullsupplierDicstring | nulldocumentNumberstring | nullvariableSymbolstring | nullissueDatestring | nulltaxPointDatestring | nulldueDatestring | nullcurrencystring | nullnetHalerinteger | nullvatHalerinteger | nulltotalHalerinteger | nullaccountNumberstring | nullbankCodestring | nullibanstring | nullResponse · 200
idstringrequiredfilenamestringrequiredsourcestringrequiredsendernull | stringrequiredsubjectnull | stringrequiredstatusstringrequiredfileIdstringrequiredextractionSourcenull | stringrequiredextractionnull | objectrequiredibanstring | nulldueDatenull | stringdatebankCodenull | stringcurrencynull | stringnetHalerinteger | nullrequiredvatHalerinteger | nullrequiredvatLinesobject[]requiredvatRateintegerrequirednetHalerintegerrequiredvatHalerinteger | nullrequiredissueDatenull | stringrequireddatetotalHalerinteger | nullrequiredsupplierDicnull | stringsupplierIconull | stringdocumentTypeinteger | nullpayableHalerinteger | nullsupplierCityanysupplierNamenull | stringrequiredtaxPointDatenull | stringdateaccountNumbernull | stringdocumentNumbernull | stringrequiredsupplierStreetanyvariableSymbolnull | stringsupplierPostalCodeanyisInvoicebooleanextractionErrornull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredrequestIdnull | stringrequiredhasCompanionbooleanrequiredcreatedAtstringrequireddate-timeTake a document out of the queue without creating anything. The file is kept.
/v1/inbox/documents/{id}/discardTake a document out of the queue without creating anything. The file is kept.
MCP tool: discard-inbox-document
Path parameters
idstringrequiredResponse · 200
idstringrequiredfilenamestringrequiredsourcestringrequiredsendernull | stringrequiredsubjectnull | stringrequiredstatusstringrequiredfileIdstringrequiredextractionSourcenull | stringrequiredextractionnull | objectrequiredibanstring | nulldueDatenull | stringdatebankCodenull | stringcurrencynull | stringnetHalerinteger | nullrequiredvatHalerinteger | nullrequiredvatLinesobject[]requiredvatRateintegerrequirednetHalerintegerrequiredvatHalerinteger | nullrequiredissueDatenull | stringrequireddatetotalHalerinteger | nullrequiredsupplierDicnull | stringsupplierIconull | stringdocumentTypeinteger | nullpayableHalerinteger | nullsupplierCityanysupplierNamenull | stringrequiredtaxPointDatenull | stringdateaccountNumbernull | stringdocumentNumbernull | stringrequiredsupplierStreetanyvariableSymbolnull | stringsupplierPostalCodeanyisInvoicebooleanextractionErrornull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredrequestIdnull | stringrequiredhasCompanionbooleanrequiredcreatedAtstringrequireddate-timeRead the values from a received document again
/v1/inbox/documents/{id}/extractRead the values from a received document again
MCP tool: extract-inbox-document
Path parameters
idstringrequiredResponse · 200
idstringrequiredfilenamestringrequiredsourcestringrequiredsendernull | stringrequiredsubjectnull | stringrequiredstatusstringrequiredfileIdstringrequiredextractionSourcenull | stringrequiredextractionnull | objectrequiredibanstring | nulldueDatenull | stringdatebankCodenull | stringcurrencynull | stringnetHalerinteger | nullrequiredvatHalerinteger | nullrequiredvatLinesobject[]requiredvatRateintegerrequirednetHalerintegerrequiredvatHalerinteger | nullrequiredissueDatenull | stringrequireddatetotalHalerinteger | nullrequiredsupplierDicnull | stringsupplierIconull | stringdocumentTypeinteger | nullpayableHalerinteger | nullsupplierCityanysupplierNamenull | stringrequiredtaxPointDatenull | stringdateaccountNumbernull | stringdocumentNumbernull | stringrequiredsupplierStreetanyvariableSymbolnull | stringsupplierPostalCodeanyisInvoicebooleanextractionErrornull | stringrequiredreceivedInvoiceIdnull | stringrequiredsupplierAdvanceIdnull | stringrequiredrequestIdnull | stringrequiredhasCompanionbooleanrequiredcreatedAtstringrequireddate-timeDownload the attachment of a received document
/v1/inbox/documents/{id}/fileDownload the attachment of a received document
MCP tool: get-inbox-document-file
Path parameters
idstringrequiredResponse · 200
Returns a application/octet-stream file.
Create a received invoice from a document in the queue and attach the file. Posts to the books unless record is false.
/v1/inbox/documents/{id}/received-invoiceCreate a received invoice from a document in the queue and attach the file. Posts to the books unless record is false.. Recording posts to the books. Confirm the supplier, number, dates and amounts with the user first.
MCP tool: create-received-invoice-from-inbox
Path parameters
idstringrequiredRequest body
recordbooleandefault trueconfirmDuplicatebooleanResponse · 201
idstringrequiredreceivedInvoiceIdnull | stringtotalHalerinteger | nullrequireddifferenceHalerintegerrequiredsupplierAdvanceIdnull | stringCreate an advance to a supplier from a document in the queue, such as a supplier's zálohová faktura read from ISDOC, and attach the file. Posts nothing until it is paid.
/v1/inbox/documents/{id}/supplier-advanceCreate an advance to a supplier from a document in the queue, such as a supplier's zálohová faktura read from ISDOC, and attach the file. Posts nothing until it is paid.. A zálohová faktura is not a tax document: no VAT is claimed from it. The amounts become the lines of the advance; its payment and the supplier's tax document follow on the advance.
MCP tool: create-supplier-advance-from-inbox
Path parameters
idstringrequiredRequest body
recordbooleandefault trueconfirmDuplicatebooleanadvanceAccount"151" | "152" | "153" | "314" | "051" | "052"Response · 201
idstringrequiredreceivedInvoiceIdnull | stringtotalHalerinteger | nullrequireddifferenceHalerintegerrequiredsupplierAdvanceIdnull | stringSee who may send documents to the company address
/v1/inbox/email-settingsSee who may send documents to the company address
MCP tool: get-inbound-email-settings
Response · 200
modestringrequiredallowListstring[]requiredSet who may send documents to the company address: anyone, or only listed addresses and @domains. The company's own people are always allowed.
/v1/inbox/email-settingsSet who may send documents to the company address: anyone, or only listed addresses and @domains. The company's own people are always allowed.
MCP tool: update-inbound-email-settings
Request body
mode"any" | "allow_list"requiredallowListstring[]default []Response · 200
modestringrequiredallowListstring[]requiredList what arrived at the company address, including mail that was refused or held no documents
/v1/inbox/emailsList what arrived at the company address, including mail that was refused or held no documents
MCP tool: list-inbound-emails
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"inbound_email"requiredidstringrequiredsendernull | stringrequiredsubjectnull | stringrequiredstatusstringrequiredreceivedCountintegerrequiredduplicateCountintegerrequiredskippedobject[]requiredreasonnull | stringrequiredfilenamenull | stringrequireddocumentIdsstring[]requiredcreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredCount what is waiting to be finished: received documents in the queue, drafts, unmatched bank movements, overdue invoices
/v1/inbox/summaryCount what is waiting to be finished: received documents in the queue, drafts, unmatched bank movements, overdue invoices
MCP tool: get-inbox-summary
Response · 200
documentsintegerrequireddraftsintegerrequiredmovementsintegerrequiredoverdueintegerrequiredtotalintegerrequiredOne to-do list: documents to finish, drafts, overdue invoices, and upcoming tax deadlines, each with where to go next
/v1/inbox/todoOne to-do list: documents to finish, drafts, overdue invoices, and upcoming tax deadlines, each with where to go next
MCP tool: list-inbox-todo
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredkindstringrequiredidstringrequiredtitlenull | stringrequiredsubtitlestringamountHalerinteger | nullcurrencynull | stringdatenull | stringrequireddatepathnull | stringrequiredsubtitleEnstringdirectionstringdeadlinestringtitleEnstringselfAssessbooleanoverduebooleanapprovalIdstringtotalintegerhasMorebooleanrequiredList invitations nobody has accepted yet
/v1/invitationsList invitations nobody has accepted yet
MCP tool: list-invitations
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataany[]requiredtotalintegerhasMorebooleanrequiredCancel an invitation so its link stops working
/v1/invitations/{id}Cancel an invitation so its link stops working
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: revoke-invitation
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredSend an invitation again with a new link and a fresh expiry
/v1/invitations/{id}/resendSend an invitation again with a new link and a fresh expiry
MCP tool: resend-invitation
Path parameters
idstringrequiredResponse · 200
idstringrequiredemailnull | stringrequiredrolestringrequiredaccessRoleIdnull | stringexpiresAtstringrequireddate-timeexpiredbooleanrequiredcreatedAtstringrequireddate-timetokenstringList the mailboxes read into K vyřízení, with when each was last read and any problem. Passwords are never returned
/v1/mailboxesList the mailboxes read into K vyřízení, with when each was last read and any problem. Passwords are never returned
MCP tool: list-mailboxes
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"mailbox"requiredidstringrequiredprovidernull | stringrequiredemailnull | stringrequiredlabelstring | nullrequiredhostnull | stringrequiredportinteger | nullrequiredsecuritynull | stringrequiredusernamenull | stringrequiredfoldernull | stringrequiredstatusstringrequirederrorCodenull | stringrequiredlastSyncAtnull | stringrequireddate-timereadFromstringrequireddatecreatedAtstringrequireddate-timefoldersstring[]keepMessagesbooleansmtpHostnull | stringsmtpPortinteger | nullsmtpSecuritynull | stringsmtpUsernamestring | nullsendingReadybooleantotalintegerhasMorebooleanrequiredConnect a mailbox over IMAP with a password: tests the login first, stores the password encrypted, and from then on reads new attachments into K vyřízení. Nothing on the mail server changes
/v1/mailboxesConnect a mailbox over IMAP with a password: tests the login first, stores the password encrypted, and from then on reads new attachments into K vyřízení. Nothing on the mail server changes. Only public servers on the standard ports. The company’s sender rules from the inbound e-mail settings apply. Reads back 30 days on the first run unless readFrom says otherwise.
MCP tool: connect-mailbox
Request body
emailstringrequiredemaillabelstring | nullhoststringrequiredmin 3 charsmax 253 charsportintegermin 1max 65535security"tls" | "starttls"usernamestringmax 200 charspasswordstringrequiredmax 500 charsreadFromstringYYYY-MM-DDResponse · 201
idstringrequiredprovidernull | stringrequiredemailnull | stringrequiredlabelstring | nullrequiredhostnull | stringrequiredportinteger | nullrequiredsecuritynull | stringrequiredusernamenull | stringrequiredfoldernull | stringrequiredstatusstringrequirederrorCodenull | stringrequiredlastSyncAtnull | stringrequireddate-timereadFromstringrequireddatecreatedAtstringrequireddate-timefoldersstring[]keepMessagesbooleansmtpHostnull | stringsmtpPortinteger | nullsmtpSecuritynull | stringsmtpUsernamestring | nullsendingReadybooleanRename a mailbox, pause it, give it a new password, choose which server folders are read, whether message text is kept, and its outgoing SMTP server. A new password is tested first
/v1/mailboxes/{id}Rename a mailbox, pause it, give it a new password, choose which server folders are read, whether message text is kept, and its outgoing SMTP server. A new password is tested first
MCP tool: update-mailbox
Path parameters
idstringrequiredRequest body
labelstring | nullpasswordstringmax 500 charsactivebooleanfoldersstring[]keepMessagesbooleansmtpHoststring | nullsmtpPortinteger | nullsmtpSecurity"tls" | "starttls" | nullsmtpUsernamestring | nullResponse · 200
idstringrequiredprovidernull | stringrequiredemailnull | stringrequiredlabelstring | nullrequiredhostnull | stringrequiredportinteger | nullrequiredsecuritynull | stringrequiredusernamenull | stringrequiredfoldernull | stringrequiredstatusstringrequirederrorCodenull | stringrequiredlastSyncAtnull | stringrequireddate-timereadFromstringrequireddatecreatedAtstringrequireddate-timefoldersstring[]keepMessagesbooleansmtpHostnull | stringsmtpPortinteger | nullsmtpSecuritynull | stringsmtpUsernamestring | nullsendingReadybooleanDisconnect a mailbox and forget its password or token. Documents already in K vyřízení stay, and nothing on the mail server changes
/v1/mailboxes/{id}Disconnect a mailbox and forget its password or token. Documents already in K vyřízení stay, and nothing on the mail server changes
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: remove-mailbox
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList the folders on the mail server of a mailbox, to choose which are read. Asks the server, and changes nothing on it
/v1/mailboxes/{id}/foldersList the folders on the mail server of a mailbox, to choose which are read. Asks the server, and changes nothing on it
MCP tool: list-mailbox-folders
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredpathnull | stringrequirednamenull | stringrequiredspecialUsestringrequiredtotalintegerhasMorebooleanrequiredRead a mailbox now instead of waiting for the next run. Says how many documents came, were refused, or were already there
/v1/mailboxes/{id}/syncRead a mailbox now instead of waiting for the next run. Says how many documents came, were refused, or were already there
MCP tool: sync-mailbox
Path parameters
idstringrequiredResponse · 200
idstringrequiredstatusstringrequirederrorCodenull | stringreceivedintegerrequiredrejectedintegerrequiredduplicatesintegerrequiredskippedintegerrequiredremaininginteger | nullrequiredunreadableFoldersstring[]Suggest the IMAP server for an e-mail address. A suggestion only: connecting proves it
/v1/mailboxes/detectSuggest the IMAP server for an e-mail address. A suggestion only: connecting proves it
MCP tool: detect-mailbox-server
Request body
emailstringrequiredemailResponse · 200
emailnull | stringrequiredhostnull | stringrequiredportinteger | nullrequiredsecuritynull | stringrequiredusernamenull | stringrequiredknownbooleanrequiredsuggestedProviderstringrequiredsmtpHostnull | stringsmtpPortinteger | nullsmtpSecuritynull | stringList the mail of connected mailboxes, newest first: status unprocessed or done, direction in or out, one mailbox, or a search in sender, subject and text
/v1/mailboxes/messagesList the mail of connected mailboxes, newest first: status unprocessed or done, direction in or out, one mailbox, or a search in sender, subject and text
MCP tool: list-mailbox-messages
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"unprocessed" | "done"direction"in" | "out"mailboxIdstringResponse · 200
dataobject[]requiredobject"mailbox_message"requiredidstringrequiredmailboxIdnull | stringrequiredmailboxEmailstringrequiredfoldernull | stringrequireddirectionstringrequiredstatusstringrequiredfromAddressnull | stringrequiredfromNamenull | stringrequiredtostring[]requiredccstring[]requiredsubjectnull | stringrequiredsentAtnull | stringrequireddate-timepreviewstringrequiredsuspiciousbooleanrequiredattachmentsobject[]requiredfilenamenull | stringrequireddocumentIdnull | stringrequiredreplyToIdnull | stringrequireddoneAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetextstringreplyTostring | nullmessageIdnull | stringtotalintegerhasMorebooleanrequiredWrite a new message from a connected mailbox, through its own SMTP server. It really goes out. Off until the operator switches sending on
/v1/mailboxes/messagesWrite a new message from a connected mailbox, through its own SMTP server. It really goes out. Off until the operator switches sending on. Attachments in fileBase64, up to 25 MB together. The copy is kept here under direction=out. It is not added to the Sent folder on the mail server.
MCP tool: send-mailbox-message
Request body
mailboxIdstringrequiredtostring[]requiredccstring[]subjectstringrequiredmax 300 charstextstringrequiredmax 200000 charsattachmentsobject[]filenamestringrequiredmax 255 charscontentTypestringrequiredmax 120 charsfileBase64stringrequiredResponse · 201
idstringrequiredmailboxIdnull | stringrequiredmailboxEmailstringrequiredfoldernull | stringrequireddirectionstringrequiredstatusstringrequiredfromAddressnull | stringrequiredfromNamenull | stringrequiredtostring[]requiredccstring[]requiredsubjectnull | stringrequiredsentAtnull | stringrequireddate-timepreviewstringrequiredsuspiciousbooleanrequiredattachmentsobject[]requiredfilenamenull | stringrequireddocumentIdnull | stringrequiredreplyToIdnull | stringrequireddoneAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetextstringreplyTostring | nullmessageIdnull | stringRead one message with its text. The text is plain, never HTML, and an attachment that reached K vyřízení names its document
/v1/mailboxes/messages/{id}Read one message with its text. The text is plain, never HTML, and an attachment that reached K vyřízení names its document
MCP tool: get-mailbox-message
Path parameters
idstringrequiredResponse · 200
idstringrequiredmailboxIdnull | stringrequiredmailboxEmailstringrequiredfoldernull | stringrequireddirectionstringrequiredstatusstringrequiredfromAddressnull | stringrequiredfromNamenull | stringrequiredtostring[]requiredccstring[]requiredsubjectnull | stringrequiredsentAtnull | stringrequireddate-timepreviewstringrequiredsuspiciousbooleanrequiredattachmentsobject[]requiredfilenamenull | stringrequireddocumentIdnull | stringrequiredreplyToIdnull | stringrequireddoneAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetextstringreplyTostring | nullmessageIdnull | stringMove a message between Unprocessed and Done. This happens here only: nothing changes on the mail server
/v1/mailboxes/messages/{id}Move a message between Unprocessed and Done. This happens here only: nothing changes on the mail server
MCP tool: update-mailbox-message
Path parameters
idstringrequiredRequest body
status"unprocessed" | "done"requiredResponse · 200
idstringrequiredmailboxIdnull | stringrequiredmailboxEmailstringrequiredfoldernull | stringrequireddirectionstringrequiredstatusstringrequiredfromAddressnull | stringrequiredfromNamenull | stringrequiredtostring[]requiredccstring[]requiredsubjectnull | stringrequiredsentAtnull | stringrequireddate-timepreviewstringrequiredsuspiciousbooleanrequiredattachmentsobject[]requiredfilenamenull | stringrequireddocumentIdnull | stringrequiredreplyToIdnull | stringrequireddoneAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetextstringreplyTostring | nullmessageIdnull | stringDelete a message from here. It stays on the mail server, and documents already in K vyřízení stay too. It does not come back, because reading has moved past it
/v1/mailboxes/messages/{id}Delete a message from here. It stays on the mail server, and documents already in K vyřízení stay too. It does not come back, because reading has moved past it
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-mailbox-message
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredForward a message with the attachments held in K vyřízení. An attachment that did not reach it was not kept, so it does not go along. It really goes out
/v1/mailboxes/messages/{id}/forwardForward a message with the attachments held in K vyřízení. An attachment that did not reach it was not kept, so it does not go along. It really goes out
MCP tool: forward-mailbox-message
Path parameters
idstringrequiredRequest body
tostring[]requiredccstring[]textstringmax 200000 charsattachmentsobject[]filenamestringrequiredmax 255 charscontentTypestringrequiredmax 120 charsfileBase64stringrequiredResponse · 201
idstringrequiredmailboxIdnull | stringrequiredmailboxEmailstringrequiredfoldernull | stringrequireddirectionstringrequiredstatusstringrequiredfromAddressnull | stringrequiredfromNamenull | stringrequiredtostring[]requiredccstring[]requiredsubjectnull | stringrequiredsentAtnull | stringrequireddate-timepreviewstringrequiredsuspiciousbooleanrequiredattachmentsobject[]requiredfilenamenull | stringrequireddocumentIdnull | stringrequiredreplyToIdnull | stringrequireddoneAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetextstringreplyTostring | nullmessageIdnull | stringReply to a message from the mailbox it came to, quoting it and keeping the thread, and move it to Done. replyAll adds the others. It really goes out
/v1/mailboxes/messages/{id}/replyReply to a message from the mailbox it came to, quoting it and keeping the thread, and move it to Done. replyAll adds the others. It really goes out
MCP tool: reply-to-mailbox-message
Path parameters
idstringrequiredRequest body
replyAllbooleantextstringrequiredmax 200000 charsattachmentsobject[]filenamestringrequiredmax 255 charscontentTypestringrequiredmax 120 charsfileBase64stringrequiredResponse · 201
idstringrequiredmailboxIdnull | stringrequiredmailboxEmailstringrequiredfoldernull | stringrequireddirectionstringrequiredstatusstringrequiredfromAddressnull | stringrequiredfromNamenull | stringrequiredtostring[]requiredccstring[]requiredsubjectnull | stringrequiredsentAtnull | stringrequireddate-timepreviewstringrequiredsuspiciousbooleanrequiredattachmentsobject[]requiredfilenamenull | stringrequireddocumentIdnull | stringrequiredreplyToIdnull | stringrequireddoneAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetextstringreplyTostring | nullmessageIdnull | stringWhich kinds of mailbox can be connected here. IMAP always; Gmail and Microsoft 365 when the operator has registered an app
/v1/mailboxes/providersWhich kinds of mailbox can be connected here. IMAP always; Gmail and Microsoft 365 when the operator has registered an app
MCP tool: get-mailbox-providers
Response · 200
imapbooleanrequiredgmailbooleanrequiredmicrosoft365booleanrequiredsendingbooleanList the people with access to this company and their roles
/v1/membersList the people with access to this company and their roles
MCP tool: list-members
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"membership"requiredidstringrequiredrolestringrequireduserIdnull | stringrequiredworkspaceIdstringrequiredemailnull | stringnamenull | stringtotpEnabledbooleanlastUsedAtnull | stringdate-timejoinedAtstringdate-timeisCurrentUserbooleanrequiredaccessRoleIdnull | stringaccessRoleNamestringaccessnull | objectagendasobjectrequiredpayrollstringcontactsstringsalesstringpurchasesstringbankstringcashstringledgerstringtaxstringinventorystringassetsstringtravelstringagendasstringreportsstringinboxstringadministrationstringscopesobjectrequiredwarehousesarray | nullrequiredregistersarray | nullrequiredaccountsarray | nullrequiredseriesarray | nullrequiredcentersarray | nulltotalintegerhasMorebooleanrequiredInvite someone by e-mail. Sends a real e-mail; confirm the address and role with the user first.
/v1/membersInvite someone by e-mail. Sends a real e-mail; confirm the address and role with the user first.
MCP tool: invite-member
Request body
emailstringrequiredemailrole"owner" | "accountant" | "invoicing" | "warehouse" | "readonly" | "custom"requiredaccessRoleIdstringResponse · 201
idstringrequiredemailnull | stringrequiredrolestringrequiredaccessRoleIdnull | stringexpiresAtstringrequireddate-timeexpiredbooleanrequiredcreatedAtstringrequireddate-timetokenstringChange what someone may do in this company. The last owner cannot be demoted.
/v1/members/{id}Change what someone may do in this company. The last owner cannot be demoted.
MCP tool: update-member-role
Path parameters
idstringrequiredRequest body
role"owner" | "accountant" | "invoicing" | "warehouse" | "readonly" | "custom"requiredaccessRoleIdstringResponse · 200
idstringrequiredrolestringrequireduserIdnull | stringrequiredworkspaceIdstringrequiredemailnull | stringnamenull | stringtotpEnabledbooleanlastUsedAtnull | stringdate-timejoinedAtstringdate-timeisCurrentUserbooleanrequiredaccessRoleIdnull | stringaccessRoleNamestringaccessnull | objectagendasobjectrequiredpayrollstringcontactsstringsalesstringpurchasesstringbankstringcashstringledgerstringtaxstringinventorystringassetsstringtravelstringagendasstringreportsstringinboxstringadministrationstringscopesobjectrequiredwarehousesarray | nullrequiredregistersarray | nullrequiredaccountsarray | nullrequiredseriesarray | nullrequiredcentersarray | nullRemove someone from this company, or leave it yourself. Their API keys here are revoked. The last owner cannot be removed.
/v1/members/{id}Remove someone from this company, or leave it yourself. Their API keys here are revoked. The last owner cannot be removed.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: remove-member
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredWhat one person may do in this company: a fixed role written out as rights, or a custom role with its parent applied
/v1/members/{id}/accessWhat one person may do in this company: a fixed role written out as rights, or a custom role with its parent applied
MCP tool: get-member-access
Path parameters
idstringrequiredResponse · 200
rolenull | objectrequiredidstringrequirednamenull | stringrequiredfixedRolenull | stringrequiredparentnull | objectrequiredidstringrequirednamenull | stringrequiredagendasobject[]requiredkeystringrequiredlevelstringrequiredinheritedbooleanrequiredscopesobjectrequiredwarehousesarray | nullrequiredidstringrequirednamenull | stringrequiredregistersanyrequiredaccountsanyrequiredseriesanyrequiredcentersanyrequireddeniedobjectrequiredformatsstring[]requiredreportsobject[]requiredkeystringrequiredcsstringrequiredenstringrequiredfixedOnlystring[]requiredmembersstring[]requiredGet the membership and role of whoever is calling, and for a custom role the agendas and limits it has
/v1/members/meGet the membership and role of whoever is calling, and for a custom role the agendas and limits it has
MCP tool: get-current-member
Response · 200
idstringrequiredrolestringrequireduserIdnull | stringrequiredworkspaceIdstringrequiredemailnull | stringnamenull | stringtotpEnabledbooleanlastUsedAtnull | stringdate-timejoinedAtstringdate-timeisCurrentUserbooleanrequiredaccessRoleIdnull | stringaccessRoleNamestringaccessnull | objectagendasobjectrequiredpayrollstringcontactsstringsalesstringpurchasesstringbankstringcashstringledgerstringtaxstringinventorystringassetsstringtravelstringagendasstringreportsstringinboxstringadministrationstringscopesobjectrequiredwarehousesarray | nullrequiredregistersarray | nullrequiredaccountsarray | nullrequiredseriesarray | nullrequiredcentersarray | nullList notifications for this company, newest first: tax and payroll deadlines coming up, overdue invoices, failed e-mails and webhooks, finished imports
/v1/notificationsList notifications for this company, newest first: tax and payroll deadlines coming up, overdue invoices, failed e-mails and webhooks, finished imports
MCP tool: list-notifications
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991unread"true" | "false"Response · 200
dataobject[]requiredobject"notification"requiredidstringrequiredkindstringrequiredseveritystringrequiredparamsobjectrequiredcountintegeroldestDaysintegeramountHalerinteger | nulloverDeadlineintegerdaysLeftintegernotAfterstringdateperiodstringlinkbooleanwhatstringlabelnull | stringstatusstringcredentialstringfilenamenull | stringautoMatchedintegersubjectnull | stringrecipientstringresultnull | objectcontactsintegerrequiredcontactsUpdatedintegerrequiredduestringunknownintegerkeystringdatestringdatelabelCsstringlabelEnstringcontactNamenull | stringdueOnnull | stringdatesentintegerfailedintegerskippedintegerpathnull | stringrequiredtitleCsstringrequiredtitleEnstringrequiredbodyCsnull | stringrequiredbodyEnnull | stringrequiredreadbooleanrequiredreadAtnull | stringrequireddate-timecreatedAtstringrequireddate-timetotalintegerhasMorebooleanrequiredFind contacts and documents (invoices, received invoices, proformas, advances to suppliers, credit notes, delivery notes) by name, number, IČO, DIČ or variable symbol, and by any custom field marked as searchable
/v1/searchFind contacts and documents (invoices, received invoices, proformas, advances to suppliers, credit notes, delivery notes) by name, number, IČO, DIČ or variable symbol, and by any custom field marked as searchable
MCP tool: search
Query parameters
qstringrequiredmax 100 charslimitintegermin 1max 50Response · 200
dataobject[]requiredidstringrequiredobject"contact" | "credit_note" | "delivery_note" | "invoice" | "item" | "proforma" | "received_invoice" | "sales_document" | "supplier_advance"requiredtitlenull | stringrequiredsubtitlestringrequiredpathnull | stringrequiredtotalintegerrequiredhasMorebooleanrequiredSend a failed delivery again
/v1/webhook-deliveries/{id}/retrySend a failed delivery again
MCP tool: retry-webhook-delivery
Path parameters
idstringrequiredResponse · 200
idstringrequiredendpointIdstringrequiredeventIdstringrequiredeventTypestringrequiredstatusstringrequiredattemptsintegerrequirednextAttemptAtnull | stringrequireddate-timeresponseStatusinteger | nullrequiredresponseBodynull | stringrequireddurationMsinteger | nullrequirederrornull | stringrequiredisTestbooleanrequiredpayloadanyrequiredcreatedAtstringrequireddate-timedeliveredAtnull | stringrequireddate-timeList the event types a webhook can subscribe to. Payloads are in the `webhooks` section of /openapi.json
/v1/webhook-eventsList the event types a webhook can subscribe to. Payloads are in the `webhooks` section of /openapi.json
MCP tool: list-webhook-events
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"webhook_event"requiredidstringrequiredmodulestringrequiredsummarynull | stringrequiredtotalintegerhasMorebooleanrequiredList webhook endpoints
/v1/webhooksList webhook endpoints
MCP tool: list-webhook-endpoints
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"webhook_endpoint"requiredidstringrequiredurlstringrequireddescriptionnull | stringrequiredeventsstring[]requiredenabledbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timesecretstringtotalintegerhasMorebooleanrequiredCreate a webhook endpoint. The signing secret is returned once.
/v1/webhooksCreate a webhook endpoint. The signing secret is returned once.
MCP tool: create-webhook-endpoint
Request body
urlstringrequiredmax 2000 charsuridescriptionstring | nulleventsstring[]default ["*"]Response · 201
idstringrequiredurlstringrequireddescriptionnull | stringrequiredeventsstring[]requiredenabledbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timesecretstringGet a webhook endpoint
/v1/webhooks/{id}Get a webhook endpoint
MCP tool: get-webhook-endpoint
Path parameters
idstringrequiredResponse · 200
idstringrequiredurlstringrequireddescriptionnull | stringrequiredeventsstring[]requiredenabledbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timesecretstringUpdate a webhook endpoint: URL, events, or pause it
/v1/webhooks/{id}Update a webhook endpoint: URL, events, or pause it
MCP tool: update-webhook-endpoint
Path parameters
idstringrequiredRequest body
urlstringmax 2000 charsuridescriptionstring | nulleventsstring[]enabledbooleanResponse · 200
idstringrequiredurlstringrequireddescriptionnull | stringrequiredeventsstring[]requiredenabledbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timesecretstringDelete a webhook endpoint and its delivery log
/v1/webhooks/{id}Delete a webhook endpoint and its delivery log
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-webhook-endpoint
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList delivery attempts of a webhook endpoint, newest first
/v1/webhooks/{id}/deliveriesList delivery attempts of a webhook endpoint, newest first
MCP tool: list-webhook-deliveries
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"pending" | "success" | "failed"Response · 200
dataobject[]requiredobject"webhook_delivery"requiredidstringrequiredendpointIdstringrequiredeventIdstringrequiredeventTypestringrequiredstatusstringrequiredattemptsintegerrequirednextAttemptAtnull | stringrequireddate-timeresponseStatusinteger | nullrequiredresponseBodynull | stringrequireddurationMsinteger | nullrequirederrornull | stringrequiredisTestbooleanrequiredpayloadanyrequiredcreatedAtstringrequireddate-timedeliveredAtnull | stringrequireddate-timetotalintegerhasMorebooleanrequiredReplace the signing secret. The new secret is returned once; the old one stops working immediately.
/v1/webhooks/{id}/rotate-secretReplace the signing secret. The new secret is returned once; the old one stops working immediately.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: rotate-webhook-secret
Path parameters
idstringrequiredResponse · 200
idstringrequiredurlstringrequireddescriptionnull | stringrequiredeventsstring[]requiredenabledbooleanrequiredcreatedAtstringrequireddate-timeupdatedAtstringrequireddate-timesecretstringSend a signed test event to this endpoint now and return the result. Test events are not retried.
/v1/webhooks/{id}/testSend a signed test event to this endpoint now and return the result. Test events are not retried.
MCP tool: test-webhook-endpoint
Path parameters
idstringrequiredResponse · 200
idstringrequiredendpointIdstringrequiredeventIdstringrequiredeventTypestringrequiredstatusstringrequiredattemptsintegerrequirednextAttemptAtnull | stringrequireddate-timeresponseStatusinteger | nullrequiredresponseBodynull | stringrequireddurationMsinteger | nullrequirederrornull | stringrequiredisTestbooleanrequiredpayloadanyrequiredcreatedAtstringrequireddate-timedeliveredAtnull | stringrequireddate-time