Contacts
Operations in the Contacts group.
- GET/v1/contact-groups
- POST/v1/contact-groups
- GET/v1/contacts
- POST/v1/contacts
- GET/v1/contacts/{id}
- PATCH/v1/contacts/{id}
- DEL/v1/contacts/{id}
- GET/v1/contacts/{id}/activity
- GET/v1/contacts/{id}/addresses
- POST/v1/contacts/{id}/addresses
- PATCH/v1/contacts/{id}/addresses/{addressId}
- DEL/v1/contacts/{id}/addresses/{addressId}
- GET/v1/contacts/{id}/bank-accounts
- POST/v1/contacts/{id}/bank-accounts
- PATCH/v1/contacts/{id}/bank-accounts/{accountId}
- DEL/v1/contacts/{id}/bank-accounts/{accountId}
- GET/v1/contacts/{id}/credit
- POST/v1/contacts/{id}/groups
- DEL/v1/contacts/{id}/groups/{groupId}
- POST/v1/contacts/{id}/insolvency-check
- POST/v1/contacts/{id}/insolvency-watch
- POST/v1/contacts/{id}/merge
- GET/v1/contacts/{id}/persons
- POST/v1/contacts/{id}/persons
- PATCH/v1/contacts/{id}/persons/{personId}
- DEL/v1/contacts/{id}/persons/{personId}
- POST/v1/contacts/{id}/vat-check
- POST/v1/contacts/{id}/vies
- GET/v1/contacts/export
- POST/v1/contacts/import
- POST/v1/contacts/insolvency-watch
- POST/v1/contacts/lookup/ares
List contact groups
/v1/contact-groupsList contact groups
MCP tool: list-contact-groups
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"contact_group"requiredidstringrequirednamestringrequiredtotalintegerhasMorebooleanrequiredCreate a contact group
/v1/contact-groupsCreate a contact group
MCP tool: create-contact-group
Request body
namestringrequiredmax 80 charsResponse · 201
idstringrequirednamestringrequiredList contacts (customers and suppliers), with what each one owes
/v1/contactsList contacts (customers and suppliers), with what each one owes
MCP tool: list-contacts
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsqstringmax 200 charsrolesstringowing"true" | "false"restricted"true" | "false"groupIdstringcustomFieldKeystringcustomFieldValuestringmax 2000 charsResponse · 200
dataobject[]requiredcustomFieldsobjectoborstringoblaststringregionnull | stringslevaintegersmlouva_odstringdatepoznamka_obchodustringobject"contact"requiredidstringrequiredkindstringrolesstringnamestringnameOnDocumentsstring | nulliconull | stringdicnull | stringvatPayerTypestringemailnull | stringphonenull | stringmobilenull | stringwwwnull | stringnotenull | stringdataBoxIdstring | nullexternalCodenull | stringusualDueDaysinteger | nullsupplierDueDaysinteger | nullpreferredPaymentMethodstring | nullinvoiceLanguagenull | stringdefaultCurrencystringcreditWarnHalerinteger | nullcreditBlockHalerinteger | nullreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleanunreliableVatPayerboolean | nullvatCheckedAtstring | nullviesValidboolean | nullviesCheckedAtstring | nullinsolvencyStatusnull | stringinsolvencyCheckedAtnull | stringdate-timeinsolvencyProceedingsobject[]iconull | stringrequiredurlstringrequirednamestringrequiredstatestringrequiredactivebooleanrequiredsenatestringrequiredendedOnanyrequiredstartedOnstringrequireddatefileNumberstringrequiredgdprRestrictedbooleanmarketingOptOutbooleanowingHalerintegergroupIdsstring[]groupsobject[]object"contact_group"requiredidstringrequirednamestringrequiredcreatedAtnull | stringdate-timeupdatedAtnull | stringdate-timeinsolvencyWatchbooleaninsolvencyChangedAtnull | stringdate-timeaddressesobject[]object"address"requiredidstringrequiredcontactIdnull | stringrequiredtypestringrequirednamestring | nullrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredregionnull | stringrequiredemailstring | nullrequiredphonestring | nullrequiredisDefaultbooleanrequiredbankAccountsobject[]object"bank_account"requiredidstringrequiredcontactIdnull | stringlabelnull | stringaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringrequiredcurrencystringrequiredisDefaultbooleanrequiredpublishedFromRegistrybooleanbicnull | stringbankNamenull | stringbankStreetstring | nullbankCitystring | nullnamestringswiftnull | stringledgerAccountstringisActivebooleanopeningBalanceHalerintegeropeningDatenull | stringdateopeningExchangeRatestring | nullopeningStatestringbankBalanceHalerinteger | nullbankBalanceOnnull | stringdatefioobjectconfiguredbooleanrequiredenabledbooleanrequiredlastSyncedAtnull | stringrequireddate-timelastSyncedOnnull | stringrequireddatelastErrornull | stringrequiredcreatedAtstringdate-timebalanceHalerintegerunmatchedCountintegerbalanceDiffHalerinteger | nullsepaCreditorIdnull | stringpersonsobject[]object"contact_person"requiredidstringrequiredcontactIdstringrequirednamestringrequiredgreetingstring | nullrequiredtitlenull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredmobilestring | nullrequirednotestring | nullrequiredduplicateIcoobjectexistingIdstringrequirednamestringrequiredattachmentsany[]documentsobject[]object"credit_note" | "delivery_note" | "invoice" | "proforma" | "received_invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringdatecurrencynull | stringtotalHalerinteger | nullpaidHalerintegerstatusstringrequiredoverduebooleanfileIdnull | stringrequiredsupplierDocumentNumbernull | stringkindstringoriginalInvoiceNumbernull | stringdeliveryDatestringdatecarrierIdstring | nullmergedFromstringtotalintegerhasMorebooleanrequiredCreate a contact. Call lookup-ares first when you have an IČO, to fill in the official name, address, and DIČ
/v1/contactsCreate a contact. Call lookup-ares first when you have an IČO, to fill in the official name, address, and DIČ
MCP tool: create-contact
Request body
kind"company" | "person"roles"customer" | "supplier" | "both"namestringrequiredmax 160 charsnameOnDocumentsstring | nullicostring | nulldicstring | nullvatPayerType"payer" | "non_payer"emailstring | nullphonestring | nullmobilestring | nullwwwstring | nullnotestring | nulldataBoxIdstring | nullexternalCodestring | nullusualDueDaysinteger | nullsupplierDueDaysinteger | nullpreferredPaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod" | nullinvoiceLanguage"cs" | "en" | "sk" | "de" | "fr" | "pl" | nulldefaultCurrencystring3 charscreditWarnHalerinteger | nullcreditBlockHalerinteger | nullreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleanallowDuplicateIcobooleanResponse · 201
customFieldsobjectoborstringoblaststringregionnull | stringslevaintegersmlouva_odstringdatepoznamka_obchodustringidstringrequiredkindstringrolesstringnamestringnameOnDocumentsstring | nulliconull | stringdicnull | stringvatPayerTypestringemailnull | stringphonenull | stringmobilenull | stringwwwnull | stringnotenull | stringdataBoxIdstring | nullexternalCodenull | stringusualDueDaysinteger | nullsupplierDueDaysinteger | nullpreferredPaymentMethodstring | nullinvoiceLanguagenull | stringdefaultCurrencystringcreditWarnHalerinteger | nullcreditBlockHalerinteger | nullreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleanunreliableVatPayerboolean | nullvatCheckedAtstring | nullviesValidboolean | nullviesCheckedAtstring | nullinsolvencyStatusnull | stringinsolvencyCheckedAtnull | stringdate-timeinsolvencyProceedingsobject[]iconull | stringrequiredurlstringrequirednamestringrequiredstatestringrequiredactivebooleanrequiredsenatestringrequiredendedOnanyrequiredstartedOnstringrequireddatefileNumberstringrequiredgdprRestrictedbooleanmarketingOptOutbooleanowingHalerintegergroupIdsstring[]groupsobject[]object"contact_group"requiredidstringrequirednamestringrequiredcreatedAtnull | stringdate-timeupdatedAtnull | stringdate-timeinsolvencyWatchbooleaninsolvencyChangedAtnull | stringdate-timeaddressesobject[]object"address"requiredidstringrequiredcontactIdnull | stringrequiredtypestringrequirednamestring | nullrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredregionnull | stringrequiredemailstring | nullrequiredphonestring | nullrequiredisDefaultbooleanrequiredbankAccountsobject[]object"bank_account"requiredidstringrequiredcontactIdnull | stringlabelnull | stringaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringrequiredcurrencystringrequiredisDefaultbooleanrequiredpublishedFromRegistrybooleanbicnull | stringbankNamenull | stringbankStreetstring | nullbankCitystring | nullnamestringswiftnull | stringledgerAccountstringisActivebooleanopeningBalanceHalerintegeropeningDatenull | stringdateopeningExchangeRatestring | nullopeningStatestringbankBalanceHalerinteger | nullbankBalanceOnnull | stringdatefioobjectconfiguredbooleanrequiredenabledbooleanrequiredlastSyncedAtnull | stringrequireddate-timelastSyncedOnnull | stringrequireddatelastErrornull | stringrequiredcreatedAtstringdate-timebalanceHalerintegerunmatchedCountintegerbalanceDiffHalerinteger | nullsepaCreditorIdnull | stringpersonsobject[]object"contact_person"requiredidstringrequiredcontactIdstringrequirednamestringrequiredgreetingstring | nullrequiredtitlenull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredmobilestring | nullrequirednotestring | nullrequiredduplicateIcoobjectexistingIdstringrequirednamestringrequiredattachmentsany[]documentsobject[]object"credit_note" | "delivery_note" | "invoice" | "proforma" | "received_invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringdatecurrencynull | stringtotalHalerinteger | nullpaidHalerintegerstatusstringrequiredoverduebooleanfileIdnull | stringrequiredsupplierDocumentNumbernull | stringkindstringoriginalInvoiceNumbernull | stringdeliveryDatestringdatecarrierIdstring | nullmergedFromstringGet a contact with its addresses, bank accounts, persons, and groups
/v1/contacts/{id}Get a contact with its addresses, bank accounts, persons, and groups
MCP tool: get-contact
Path parameters
idstringrequiredResponse · 200
customFieldsobjectoborstringoblaststringregionnull | stringslevaintegersmlouva_odstringdatepoznamka_obchodustringidstringrequiredkindstringrolesstringnamestringnameOnDocumentsstring | nulliconull | stringdicnull | stringvatPayerTypestringemailnull | stringphonenull | stringmobilenull | stringwwwnull | stringnotenull | stringdataBoxIdstring | nullexternalCodenull | stringusualDueDaysinteger | nullsupplierDueDaysinteger | nullpreferredPaymentMethodstring | nullinvoiceLanguagenull | stringdefaultCurrencystringcreditWarnHalerinteger | nullcreditBlockHalerinteger | nullreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleanunreliableVatPayerboolean | nullvatCheckedAtstring | nullviesValidboolean | nullviesCheckedAtstring | nullinsolvencyStatusnull | stringinsolvencyCheckedAtnull | stringdate-timeinsolvencyProceedingsobject[]iconull | stringrequiredurlstringrequirednamestringrequiredstatestringrequiredactivebooleanrequiredsenatestringrequiredendedOnanyrequiredstartedOnstringrequireddatefileNumberstringrequiredgdprRestrictedbooleanmarketingOptOutbooleanowingHalerintegergroupIdsstring[]groupsobject[]object"contact_group"requiredidstringrequirednamestringrequiredcreatedAtnull | stringdate-timeupdatedAtnull | stringdate-timeinsolvencyWatchbooleaninsolvencyChangedAtnull | stringdate-timeaddressesobject[]object"address"requiredidstringrequiredcontactIdnull | stringrequiredtypestringrequirednamestring | nullrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredregionnull | stringrequiredemailstring | nullrequiredphonestring | nullrequiredisDefaultbooleanrequiredbankAccountsobject[]object"bank_account"requiredidstringrequiredcontactIdnull | stringlabelnull | stringaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringrequiredcurrencystringrequiredisDefaultbooleanrequiredpublishedFromRegistrybooleanbicnull | stringbankNamenull | stringbankStreetstring | nullbankCitystring | nullnamestringswiftnull | stringledgerAccountstringisActivebooleanopeningBalanceHalerintegeropeningDatenull | stringdateopeningExchangeRatestring | nullopeningStatestringbankBalanceHalerinteger | nullbankBalanceOnnull | stringdatefioobjectconfiguredbooleanrequiredenabledbooleanrequiredlastSyncedAtnull | stringrequireddate-timelastSyncedOnnull | stringrequireddatelastErrornull | stringrequiredcreatedAtstringdate-timebalanceHalerintegerunmatchedCountintegerbalanceDiffHalerinteger | nullsepaCreditorIdnull | stringpersonsobject[]object"contact_person"requiredidstringrequiredcontactIdstringrequirednamestringrequiredgreetingstring | nullrequiredtitlenull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredmobilestring | nullrequirednotestring | nullrequiredduplicateIcoobjectexistingIdstringrequirednamestringrequiredattachmentsany[]documentsobject[]object"credit_note" | "delivery_note" | "invoice" | "proforma" | "received_invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringdatecurrencynull | stringtotalHalerinteger | nullpaidHalerintegerstatusstringrequiredoverduebooleanfileIdnull | stringrequiredsupplierDocumentNumbernull | stringkindstringoriginalInvoiceNumbernull | stringdeliveryDatestringdatecarrierIdstring | nullmergedFromstringUpdate a contact. Documents already issued keep the details they were issued with
/v1/contacts/{id}Update a contact. Documents already issued keep the details they were issued with
MCP tool: update-contact
Path parameters
idstringrequiredRequest body
kind"company" | "person"roles"customer" | "supplier" | "both"namestringmax 160 charsnameOnDocumentsstring | nullicostring | nulldicstring | nullvatPayerType"payer" | "non_payer"emailstring | nullphonestring | nullmobilestring | nullwwwstring | nullnotestring | nulldataBoxIdstring | nullexternalCodestring | nullusualDueDaysinteger | nullsupplierDueDaysinteger | nullpreferredPaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod" | nullinvoiceLanguage"cs" | "en" | "sk" | "de" | "fr" | "pl" | nulldefaultCurrencystring3 charscreditWarnHalerinteger | nullcreditBlockHalerinteger | nullreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleanallowDuplicateIcobooleanResponse · 200
customFieldsobjectoborstringoblaststringregionnull | stringslevaintegersmlouva_odstringdatepoznamka_obchodustringidstringrequiredkindstringrolesstringnamestringnameOnDocumentsstring | nulliconull | stringdicnull | stringvatPayerTypestringemailnull | stringphonenull | stringmobilenull | stringwwwnull | stringnotenull | stringdataBoxIdstring | nullexternalCodenull | stringusualDueDaysinteger | nullsupplierDueDaysinteger | nullpreferredPaymentMethodstring | nullinvoiceLanguagenull | stringdefaultCurrencystringcreditWarnHalerinteger | nullcreditBlockHalerinteger | nullreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleanunreliableVatPayerboolean | nullvatCheckedAtstring | nullviesValidboolean | nullviesCheckedAtstring | nullinsolvencyStatusnull | stringinsolvencyCheckedAtnull | stringdate-timeinsolvencyProceedingsobject[]iconull | stringrequiredurlstringrequirednamestringrequiredstatestringrequiredactivebooleanrequiredsenatestringrequiredendedOnanyrequiredstartedOnstringrequireddatefileNumberstringrequiredgdprRestrictedbooleanmarketingOptOutbooleanowingHalerintegergroupIdsstring[]groupsobject[]object"contact_group"requiredidstringrequirednamestringrequiredcreatedAtnull | stringdate-timeupdatedAtnull | stringdate-timeinsolvencyWatchbooleaninsolvencyChangedAtnull | stringdate-timeaddressesobject[]object"address"requiredidstringrequiredcontactIdnull | stringrequiredtypestringrequirednamestring | nullrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredregionnull | stringrequiredemailstring | nullrequiredphonestring | nullrequiredisDefaultbooleanrequiredbankAccountsobject[]object"bank_account"requiredidstringrequiredcontactIdnull | stringlabelnull | stringaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringrequiredcurrencystringrequiredisDefaultbooleanrequiredpublishedFromRegistrybooleanbicnull | stringbankNamenull | stringbankStreetstring | nullbankCitystring | nullnamestringswiftnull | stringledgerAccountstringisActivebooleanopeningBalanceHalerintegeropeningDatenull | stringdateopeningExchangeRatestring | nullopeningStatestringbankBalanceHalerinteger | nullbankBalanceOnnull | stringdatefioobjectconfiguredbooleanrequiredenabledbooleanrequiredlastSyncedAtnull | stringrequireddate-timelastSyncedOnnull | stringrequireddatelastErrornull | stringrequiredcreatedAtstringdate-timebalanceHalerintegerunmatchedCountintegerbalanceDiffHalerinteger | nullsepaCreditorIdnull | stringpersonsobject[]object"contact_person"requiredidstringrequiredcontactIdstringrequirednamestringrequiredgreetingstring | nullrequiredtitlenull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredmobilestring | nullrequirednotestring | nullrequiredduplicateIcoobjectexistingIdstringrequirednamestringrequiredattachmentsany[]documentsobject[]object"credit_note" | "delivery_note" | "invoice" | "proforma" | "received_invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringdatecurrencynull | stringtotalHalerinteger | nullpaidHalerintegerstatusstringrequiredoverduebooleanfileIdnull | stringrequiredsupplierDocumentNumbernull | stringkindstringoriginalInvoiceNumbernull | stringdeliveryDatestringdatecarrierIdstring | nullmergedFromstringDelete a contact that no document uses
/v1/contacts/{id}Delete a contact that no document uses
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-contact
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList the documents and events connected to a contact
/v1/contacts/{id}/activityList the documents and events connected to a contact
MCP tool: list-contact-activity
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredtypestringrequiredatstringrequireddate-timecontactIdnull | stringdocumentIdnull | stringnumbernull | stringdocumentTypenull | stringtotalintegerhasMorebooleanrequiredList a contact's addresses
/v1/contacts/{id}/addressesList a contact's addresses
MCP tool: list-contact-addresses
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"address"requiredidstringrequiredcontactIdnull | stringrequiredtypestringrequirednamestring | nullrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredregionnull | stringrequiredemailstring | nullrequiredphonestring | nullrequiredisDefaultbooleanrequiredtotalintegerhasMorebooleanrequiredAdd an address to a contact
/v1/contacts/{id}/addressesAdd an address to a contact
MCP tool: create-contact-address
Path parameters
idstringrequiredRequest body
type"registered" | "delivery"requirednamestring | nullstreetstring | nullcitystring | nullpostalCodestring | nullcountrystringmax 2 charsregionstring | nullemailstring | nullphonestring | nullisDefaultbooleanResponse · 201
idstringrequiredcontactIdnull | stringrequiredtypestringrequirednamestring | nullrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredregionnull | stringrequiredemailstring | nullrequiredphonestring | nullrequiredisDefaultbooleanrequiredUpdate an address of a contact
/v1/contacts/{id}/addresses/{addressId}Update an address of a contact
MCP tool: update-contact-address
Path parameters
idstringrequiredaddressIdstringrequiredRequest body
type"registered" | "delivery"namestring | nullstreetstring | nullcitystring | nullpostalCodestring | nullcountrystringmax 2 charsregionstring | nullemailstring | nullphonestring | nullisDefaultbooleanResponse · 200
idstringrequiredcontactIdnull | stringrequiredtypestringrequirednamestring | nullrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredregionnull | stringrequiredemailstring | nullrequiredphonestring | nullrequiredisDefaultbooleanrequiredRemove an address from a contact
/v1/contacts/{id}/addresses/{addressId}Remove an address from a contact
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-contact-address
Path parameters
idstringrequiredaddressIdstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList a contact's bank accounts
/v1/contacts/{id}/bank-accountsList a contact's bank accounts
MCP tool: list-contact-bank-accounts
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"bank_account"requiredidstringrequiredcontactIdnull | stringlabelnull | stringaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringrequiredcurrencystringrequiredisDefaultbooleanrequiredpublishedFromRegistrybooleanbicnull | stringbankNamenull | stringbankStreetstring | nullbankCitystring | nullnamestringswiftnull | stringledgerAccountstringisActivebooleanopeningBalanceHalerintegeropeningDatenull | stringdateopeningExchangeRatestring | nullopeningStatestringbankBalanceHalerinteger | nullbankBalanceOnnull | stringdatefioobjectconfiguredbooleanrequiredenabledbooleanrequiredlastSyncedAtnull | stringrequireddate-timelastSyncedOnnull | stringrequireddatelastErrornull | stringrequiredcreatedAtstringdate-timebalanceHalerintegerunmatchedCountintegerbalanceDiffHalerinteger | nullsepaCreditorIdnull | stringtotalintegerhasMorebooleanrequiredAdd a bank account to a contact
/v1/contacts/{id}/bank-accountsAdd a bank account to a contact
MCP tool: create-contact-bank-account
Path parameters
idstringrequiredRequest body
labelstring | nullaccountNumberstring | nullbankCodestring | nullibanstring | nullbicstring | nullbankNamestring | nullbankStreetstring | nullbankCitystring | nullcurrencystring3 charsisDefaultbooleanpublishedFromRegistrybooleanResponse · 201
idstringrequiredcontactIdnull | stringlabelnull | stringaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringrequiredcurrencystringrequiredisDefaultbooleanrequiredpublishedFromRegistrybooleanbicnull | stringbankNamenull | stringbankStreetstring | nullbankCitystring | nullnamestringswiftnull | stringledgerAccountstringisActivebooleanopeningBalanceHalerintegeropeningDatenull | stringdateopeningExchangeRatestring | nullopeningStatestringbankBalanceHalerinteger | nullbankBalanceOnnull | stringdatefioobjectconfiguredbooleanrequiredenabledbooleanrequiredlastSyncedAtnull | stringrequireddate-timelastSyncedOnnull | stringrequireddatelastErrornull | stringrequiredcreatedAtstringdate-timebalanceHalerintegerunmatchedCountintegerbalanceDiffHalerinteger | nullsepaCreditorIdnull | stringUpdate a bank account of a contact
/v1/contacts/{id}/bank-accounts/{accountId}Update a bank account of a contact
MCP tool: update-contact-bank-account
Path parameters
idstringrequiredaccountIdstringrequiredRequest body
labelstring | nullaccountNumberstring | nullbankCodestring | nullibanstring | nullbicstring | nullbankNamestring | nullbankStreetstring | nullbankCitystring | nullcurrencystring3 charsisDefaultbooleanpublishedFromRegistrybooleanResponse · 200
idstringrequiredcontactIdnull | stringlabelnull | stringaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringrequiredcurrencystringrequiredisDefaultbooleanrequiredpublishedFromRegistrybooleanbicnull | stringbankNamenull | stringbankStreetstring | nullbankCitystring | nullnamestringswiftnull | stringledgerAccountstringisActivebooleanopeningBalanceHalerintegeropeningDatenull | stringdateopeningExchangeRatestring | nullopeningStatestringbankBalanceHalerinteger | nullbankBalanceOnnull | stringdatefioobjectconfiguredbooleanrequiredenabledbooleanrequiredlastSyncedAtnull | stringrequireddate-timelastSyncedOnnull | stringrequireddatelastErrornull | stringrequiredcreatedAtstringdate-timebalanceHalerintegerunmatchedCountintegerbalanceDiffHalerinteger | nullsepaCreditorIdnull | stringRemove a bank account from a contact
/v1/contacts/{id}/bank-accounts/{accountId}Remove a bank account from a contact
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-contact-bank-account
Path parameters
idstringrequiredaccountIdstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredGet what the contact owes against its credit limits (Kredit info and Kredit max). An optional amount shows what a new document would do
/v1/contacts/{id}/creditGet what the contact owes against its credit limits (Kredit info and Kredit max). An optional amount shows what a new document would do
MCP tool: get-contact-credit
Path parameters
idstringrequiredQuery parameters
documentHalerintegermin 0max 9007199254740991Response · 200
contactIdnull | stringrequiredlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerinteger | nullrequiredavailableHalerinteger | nullrequiredPut a contact in a contact group
/v1/contacts/{id}/groupsPut a contact in a contact group
MCP tool: assign-contact-group
Path parameters
idstringrequiredRequest body
groupIdstringrequiredResponse · 201
idstringrequirednamestringrequiredTake a contact out of a contact group
/v1/contacts/{id}/groups/{groupId}Take a contact out of a contact group
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: unassign-contact-group
Path parameters
idstringrequiredgroupIdstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredCheck the contact by IČO in the Czech insolvency register (ISIR). If the register is down the answer is status unknown, not an error
/v1/contacts/{id}/insolvency-checkCheck the contact by IČO in the Czech insolvency register (ISIR). If the register is down the answer is status unknown, not an error. Status found means a proceeding is running; clear means none is, though finished ones may be listed. Only a contact with an IČO can be checked: the register needs a birth number or date of birth to find a person.
MCP tool: check-contact-insolvency
Path parameters
idstringrequiredResponse · 200
iconull | stringrequiredsourcestringrequiredstatusstringrequiredproceedingsobject[]requiredfileNumberstringrequiredsenatestringrequirednamenull | stringrequirediconull | stringrequiredstatestringrequiredactivebooleanrequiredstartedOnstringrequireddateendedOnanyrequiredurlstringrequiredsyncedAtanyrequiredstalebooleanrequiredcontactIdnull | stringrequiredHave the insolvency register re-read for this contact every day. A change shows in the notifications and as the contact.insolvency_changed webhook
/v1/contacts/{id}/insolvency-watchHave the insolvency register re-read for this contact every day. A change shows in the notifications and as the contact.insolvency_changed webhook. Needs an IČO. A register that is down changes nothing, and the next run asks again.
MCP tool: set-contact-insolvency-watch
Path parameters
idstringrequiredRequest body
watchbooleanrequiredResponse · 200
contactIdnull | stringrequiredwatchbooleanrequiredMerge this contact into another one. Its documents move to the other contact and this one disappears
/v1/contacts/{id}/mergeMerge this contact into another one. Its documents move to the other contact and this one disappears
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: merge-contact
Path parameters
idstringrequiredRequest body
intoIdstringrequiredResponse · 200
customFieldsobjectoborstringoblaststringregionnull | stringslevaintegersmlouva_odstringdatepoznamka_obchodustringidstringrequiredkindstringrolesstringnamestringnameOnDocumentsstring | nulliconull | stringdicnull | stringvatPayerTypestringemailnull | stringphonenull | stringmobilenull | stringwwwnull | stringnotenull | stringdataBoxIdstring | nullexternalCodenull | stringusualDueDaysinteger | nullsupplierDueDaysinteger | nullpreferredPaymentMethodstring | nullinvoiceLanguagenull | stringdefaultCurrencystringcreditWarnHalerinteger | nullcreditBlockHalerinteger | nullreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleanunreliableVatPayerboolean | nullvatCheckedAtstring | nullviesValidboolean | nullviesCheckedAtstring | nullinsolvencyStatusnull | stringinsolvencyCheckedAtnull | stringdate-timeinsolvencyProceedingsobject[]iconull | stringrequiredurlstringrequirednamestringrequiredstatestringrequiredactivebooleanrequiredsenatestringrequiredendedOnanyrequiredstartedOnstringrequireddatefileNumberstringrequiredgdprRestrictedbooleanmarketingOptOutbooleanowingHalerintegergroupIdsstring[]groupsobject[]object"contact_group"requiredidstringrequirednamestringrequiredcreatedAtnull | stringdate-timeupdatedAtnull | stringdate-timeinsolvencyWatchbooleaninsolvencyChangedAtnull | stringdate-timeaddressesobject[]object"address"requiredidstringrequiredcontactIdnull | stringrequiredtypestringrequirednamestring | nullrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequiredregionnull | stringrequiredemailstring | nullrequiredphonestring | nullrequiredisDefaultbooleanrequiredbankAccountsobject[]object"bank_account"requiredidstringrequiredcontactIdnull | stringlabelnull | stringaccountNumbernull | stringrequiredbankCodenull | stringrequiredibannull | stringrequiredcurrencystringrequiredisDefaultbooleanrequiredpublishedFromRegistrybooleanbicnull | stringbankNamenull | stringbankStreetstring | nullbankCitystring | nullnamestringswiftnull | stringledgerAccountstringisActivebooleanopeningBalanceHalerintegeropeningDatenull | stringdateopeningExchangeRatestring | nullopeningStatestringbankBalanceHalerinteger | nullbankBalanceOnnull | stringdatefioobjectconfiguredbooleanrequiredenabledbooleanrequiredlastSyncedAtnull | stringrequireddate-timelastSyncedOnnull | stringrequireddatelastErrornull | stringrequiredcreatedAtstringdate-timebalanceHalerintegerunmatchedCountintegerbalanceDiffHalerinteger | nullsepaCreditorIdnull | stringpersonsobject[]object"contact_person"requiredidstringrequiredcontactIdstringrequirednamestringrequiredgreetingstring | nullrequiredtitlenull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredmobilestring | nullrequirednotestring | nullrequiredduplicateIcoobjectexistingIdstringrequirednamestringrequiredattachmentsany[]documentsobject[]object"credit_note" | "delivery_note" | "invoice" | "proforma" | "received_invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatenull | stringrequireddatedueDatenull | stringdatecurrencynull | stringtotalHalerinteger | nullpaidHalerintegerstatusstringrequiredoverduebooleanfileIdnull | stringrequiredsupplierDocumentNumbernull | stringkindstringoriginalInvoiceNumbernull | stringdeliveryDatestringdatecarrierIdstring | nullmergedFromstringList a contact's people
/v1/contacts/{id}/personsList a contact's people
MCP tool: list-contact-persons
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"contact_person"requiredidstringrequiredcontactIdstringrequirednamestringrequiredgreetingstring | nullrequiredtitlenull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredmobilestring | nullrequirednotestring | nullrequiredtotalintegerhasMorebooleanrequiredAdd a person to a contact
/v1/contacts/{id}/personsAdd a person to a contact
MCP tool: create-contact-person
Path parameters
idstringrequiredRequest body
namestringrequiredmax 160 charsgreetingstring | nulltitlestring | nullemailstring | nullphonestring | nullmobilestring | nullnotestring | nullResponse · 201
idstringrequiredcontactIdstringrequirednamestringrequiredgreetingstring | nullrequiredtitlenull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredmobilestring | nullrequirednotestring | nullrequiredUpdate a person of a contact
/v1/contacts/{id}/persons/{personId}Update a person of a contact
MCP tool: update-contact-person
Path parameters
idstringrequiredpersonIdstringrequiredRequest body
namestringmax 160 charsgreetingstring | nulltitlestring | nullemailstring | nullphonestring | nullmobilestring | nullnotestring | nullResponse · 200
idstringrequiredcontactIdstringrequirednamestringrequiredgreetingstring | nullrequiredtitlenull | stringrequiredemailnull | stringrequiredphonenull | stringrequiredmobilestring | nullrequirednotestring | nullrequiredRemove a person from a contact
/v1/contacts/{id}/persons/{personId}Remove a person from a contact
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-contact-person
Path parameters
idstringrequiredpersonIdstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredCheck the contact in the Czech VAT register: whether it is a reliable payer and which bank accounts it has published
/v1/contacts/{id}/vat-checkCheck the contact in the Czech VAT register: whether it is a reliable payer and which bank accounts it has published
MCP tool: vat-check-contact
Path parameters
idstringrequiredRequest body
applyAccountsbooleanResponse · 200
sourcestringrequiredcheckedAtnull | stringrequireddate-timedicnull | stringrequiredunreliablebooleanrequiredpublishedAccountsobject[]requiredaccountNumbernull | stringrequiredbankCodenull | stringrequiredibanstring | nullrequiredappliedAccountsany[]requiredCheck the contact's EU VAT number in the VIES register
/v1/contacts/{id}/viesCheck the contact's EU VAT number in the VIES register
MCP tool: vies-check-contact
Path parameters
idstringrequiredResponse · 200
sourcestringrequiredcheckedAtnull | stringdate-timevatNumberstringrequiredvalidbooleanrequirednamenull | stringaddressnull | stringwellFormedbooleanDownload all contacts as an XLSX spreadsheet
/v1/contacts/exportDownload all contacts as an XLSX spreadsheet
MCP tool: export-contacts
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDqstringmax 200 charsrolesstringowing"true" | "false"restricted"true" | "false"groupIdstringcustomFieldKeystringcustomFieldValuestringmax 2000 charsResponse · 200
Returns a application/vnd.openxmlformats-officedocument.spreadsheetml.sheet file.
Import contacts from an uploaded spreadsheet file
/v1/contacts/importImport contacts from an uploaded spreadsheet file
MCP tool: import-contacts
Request body
fileBase64stringrowsobject[]Response · 200
countintegerrequiredidsstring[]requiredTurn the daily insolvency re-check on or off for many contacts at once. A contact without an IČO is reported and left as it was
/v1/contacts/insolvency-watchTurn the daily insolvency re-check on or off for many contacts at once. A contact without an IČO is reported and left as it was
MCP tool: set-contacts-insolvency-watch
Request body
idsstring[]requiredwatchbooleanrequiredResponse · 200
resultsobject[]requiredidstringokbooleanrequirederrornull | stringcodenull | stringnumbernull | stringstockDocumentIdnull | stringdocumentIdnull | stringstatusstringcontactNamenull | stringnamenull | stringtostringamountHalerinteger | nullmovementIdnull | stringrowintegerrecognisedbooleanshipmentIdstringtrackingNumbernull | stringtotalintegerrequiredsucceededintegerrequiredfailedintegerrequiredLook up a company in the Czech ARES business register by IČO. Changes nothing
/v1/contacts/lookup/aresLook up a company in the Czech ARES business register by IČO. Changes nothing
MCP tool: lookup-ares
Request body
icostringrequiredmax 16 charsResponse · 200
sourcestringrequirediconull | stringrequireddicnull | stringrequirednamenull | stringrequiredvatPayerTypestringrequiredaddressnull | objectrequiredstreetnull | stringrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrynull | stringrequired