Issued invoices
Operations in the Issued invoices group.
- GET/v1/invoices
- POST/v1/invoices
- GET/v1/invoices/{id}
- PATCH/v1/invoices/{id}
- POST/v1/invoices/{id}/copy
- POST/v1/invoices/{id}/credit-notes
- POST/v1/invoices/{id}/issue
- GET/v1/invoices/{id}/payments
- POST/v1/invoices/{id}/payments
- DEL/v1/invoices/{id}/payments/{paymentId}
- GET/v1/invoices/{id}/pdf
- POST/v1/invoices/{id}/storno
List issued invoices (faktury vydané). `from` and `to` filter on the issue date; `unpaid=true` keeps those with an open balance
/v1/invoicesList issued invoices (faktury vydané). `from` and `to` filter on the issue date; `unpaid=true` keeps those with an open balance
MCP tool: list-invoices
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatusstringcontactIdstringdueFromstringdueTostringqstringmax 200 charsunpaid"true" | "false"customFieldKeystringcustomFieldValuestringmax 2000 charsResponse · 200
dataobject[]requiredobject"invoice"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredtotalintegerhasMorebooleanrequiredCreate an invoice, as a draft unless `issue` is true
/v1/invoicesCreate an invoice, as a draft unless `issue` is true. Pass contactId from list-contacts, or contactName for a one-off customer. Prices are per unit before VAT, in haléře. Legal effect: with `issue: true` this assigns the final document number, creates a tax document, and posts to the books. Confirm with the user first.
MCP tool: create-invoice
Request body
carrierIdstring | nullvatMode"domestic" | "reverse_charge" | "eu_goods" | "eu_services" | "third_country_goods" | "third_country_services" | "oss" | "eu_triangular" | "eu_new_vehicle" | "goods_installation_networks" | "eu_registration" | "eu_sme" | "group_internal" | "margin_used_goods" | "margin_art" | "margin_collectibles" | "margin_travel" | "exempt" | "none"exchangeRatenumbertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullcontactIdstringcontactNamestringmax 160 charscontactIcostringmax 16 charscontactDicstringmax 16 charsseriesIdstringissueDatestringrequiredYYYY-MM-DDtaxPointDatestringrequiredYYYY-MM-DDdueDatestringYYYY-MM-DDcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"language"cs" | "en" | "sk" | "de" | "fr" | "pl"notePublicstring | nullnoteInternalstring | nullconstantSymbolstring | nullourAccountNumberstring | nullourBankCodestring | nullourIbanstring | nullissuebooleanoverrideDeliveryNotesbooleandeliveryNoteIdsstring[]overrideCreditLimitbooleanproformaIdsstring[]clientDocumentIdstringmin 8 charsmax 64 charsofflineobjectsoldAtstringrequireddate-timenumberstringrequiredmax 40 charslistPricesobject[]itemIdstringrequiredpriceHalerintegerrequiredmin -9007199254740991max 9007199254740991quantitynumberrequiredlinesobject[]requiredpurchaseHalerintegermin 0max 9007199254740991exemptPercentnumbermin 0max 100purchaseLineIdstring | nulldescriptionstringmax 240 charsquantitynumberrequiredunitstringmax 16 charsunitPriceHalerintegermin -9007199254740991max 9007199254740991vatRatenumbermin 0max 30itemIdstringwarehouseIdstringlotsobject[]itemIdstringlotIdstringcodestringmax 64 charsquantitynumberexpiryDatestring | nullserialNumbersstring[]orderLineIdstringrecyclingFeeIdstring | nullrecyclingPerUnitHalerintegermin 0max 9007199254740991recyclingTextstringmax 120 charsrecyclingUnit"ks" | "kg"recyclingCoefficientnumbermin 0max 1000000accountNumberstring | nullroundingMode"auto" | "crown" | "none"Response · 201
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredGet an invoice with lines, VAT recap, payments, and the amount still owed
/v1/invoices/{id}Get an invoice with lines, VAT recap, payments, and the amount still owed
MCP tool: get-invoice
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredChange a draft invoice. An issued invoice cannot be changed: storno it or create a credit note
/v1/invoices/{id}Change a draft invoice. An issued invoice cannot be changed: storno it or create a credit note
MCP tool: update-invoice
Path parameters
idstringrequiredRequest body
carrierIdstring | nullvatMode"domestic" | "reverse_charge" | "eu_goods" | "eu_services" | "third_country_goods" | "third_country_services" | "oss" | "eu_triangular" | "eu_new_vehicle" | "goods_installation_networks" | "eu_registration" | "eu_sme" | "group_internal" | "margin_used_goods" | "margin_art" | "margin_collectibles" | "margin_travel" | "exempt" | "none"exchangeRatenumbertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullcontactIdstringseriesIdstringissueDatestringYYYY-MM-DDtaxPointDatestringYYYY-MM-DDdueDatestring | nullcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"language"cs" | "en" | "sk" | "de" | "fr" | "pl"notePublicstring | nullnoteInternalstring | nullconstantSymbolstring | nullourAccountNumberstring | nullourBankCodestring | nullourIbanstring | nulllinesobject[]purchaseHalerintegermin 0max 9007199254740991exemptPercentnumbermin 0max 100purchaseLineIdstring | nulldescriptionstringmax 240 charsquantitynumberrequiredunitstringmax 16 charsunitPriceHalerintegermin -9007199254740991max 9007199254740991vatRatenumbermin 0max 30itemIdstringwarehouseIdstringlotsobject[]itemIdstringlotIdstringcodestringmax 64 charsquantitynumberexpiryDatestring | nullserialNumbersstring[]orderLineIdstringrecyclingFeeIdstring | nullrecyclingPerUnitHalerintegermin 0max 9007199254740991recyclingTextstringmax 120 charsrecyclingUnit"ks" | "kg"recyclingCoefficientnumbermin 0max 1000000accountNumberstring | nullroundingMode"auto" | "crown" | "none"Response · 200
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredCreate a new draft invoice from an existing one
/v1/invoices/{id}/copyCreate a new draft invoice from an existing one
MCP tool: copy-invoice
Path parameters
idstringrequiredResponse · 201
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredCreate a draft credit note (dobropis) for an issued invoice. Line prices are negative
/v1/invoices/{id}/credit-notesCreate a draft credit note (dobropis) for an issued invoice. Line prices are negative
MCP tool: create-credit-note-from-invoice
Path parameters
idstringrequiredRequest body
vatMode"domestic" | "reverse_charge" | "eu_goods" | "eu_services" | "third_country_goods" | "third_country_services" | "oss" | "eu_triangular" | "eu_new_vehicle" | "goods_installation_networks" | "eu_registration" | "eu_sme" | "group_internal" | "margin_used_goods" | "margin_art" | "margin_collectibles" | "margin_travel" | "exempt" | "none"exchangeRatenumbertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullcontactIdstringcontactNamestringmax 160 charscontactIcostringmax 16 charscontactDicstringmax 16 charsseriesIdstringinvoiceIdstringoriginalInvoiceNumberstring | nullreasonstringmax 500 charsissueDatestringrequiredYYYY-MM-DDtaxPointDatestringrequiredYYYY-MM-DDkhDphDatestring | nulldueDatestringYYYY-MM-DDcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"language"cs" | "en" | "sk" | "de" | "fr" | "pl"notePublicstring | nullnoteInternalstring | nullissuebooleanlinesobject[]purchaseHalerintegermin 0max 9007199254740991exemptPercentnumbermin 0max 100purchaseLineIdstring | nulldescriptionstringrequiredmax 240 charsquantitynumberrequiredunitstringmax 16 charsunitPriceHalerintegerrequiredmin -9007199254740991max 9007199254740991vatRatenumberrequiredmin 0max 30itemIdstringwarehouseIdstringlotsobject[]itemIdstringlotIdstringcodestringmax 64 charsquantitynumberexpiryDatestring | nullserialNumbersstring[]orderLineIdstringrecyclingFeeIdstring | nullrecyclingPerUnitHalerintegermin 0max 9007199254740991recyclingTextstringmax 120 charsrecyclingUnit"ks" | "kg"recyclingCoefficientnumbermin 0max 1000000accountNumberstring | nullroundingMode"auto" | "crown" | "none"Response · 201
customFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredoriginalInvoiceNumbernull | stringrequiredseriesIdnull | stringreasonnull | stringtaxPointDatestringdatekhDphDatenull | stringdatecurrencystringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegerstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"credit_note_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdstring | nullrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanpaymentsobject[]object"credit_note_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalany[]receivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]bankMovementobjectidstringrequiredbankAccountIdstringrequiredIssue a draft invoice
/v1/invoices/{id}/issueIssue a draft invoice. Legal effect: this assigns the final document number, creates a tax document, and posts to the books. Confirm with the user first. Refused with uninvoiced_delivery_note when a line would move stock while the customer has issued, not yet invoiced delivery notes for the item: name them in deliveryNoteIds to bill them, or set overrideDeliveryNotes if this is a further sale.
MCP tool: issue-invoice
Path parameters
idstringrequiredRequest body
overrideReservationsbooleanoverrideDeliveryNotesbooleandeliveryNoteIdsstring[]overrideCreditLimitbooleanResponse · 200
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredList the payments of an invoice
/v1/invoices/{id}/paymentsList the payments of an invoice
MCP tool: list-invoice-payments
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredtotalintegerhasMorebooleanrequiredRecord a payment of an invoice. Cash goes through a cash document of a register, a transfer through a bank account, and a later statement line takes it over
/v1/invoices/{id}/paymentsRecord a payment of an invoice. Cash goes through a cash document of a register, a transfer through a bank account, and a later statement line takes it over. Legal effect: posts to the books. With several registers or accounts name registerId or bankAccountId. In another currency than the document, moneyAmountHaler says what moved on the account.
MCP tool: add-invoice-payment
Path parameters
idstringrequiredRequest body
amountHalerintegerrequiredmax 9007199254740991paidOnstringrequiredYYYY-MM-DDmethod"transfer" | "cash" | "card" | "other"inPersonbooleannotestring | nullregisterIdstringbankAccountIdstringmoneyAmountHalerintegermax 9007199254740991allowNegativebooleaneetPrepaidLoadHalerintegermin 0max 9007199254740991eetPrepaidUseHalerintegermin 0max 9007199254740991eetVoucherIdstringeetMandateIdstringeetOwnSalebooleanpaidAtstringdate-timeResponse · 201
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredRemove a payment from an invoice and reverse its posting
/v1/invoices/{id}/payments/{paymentId}Remove a payment from an invoice and reverse its posting
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-invoice-payment
Path parameters
idstringrequiredpaymentIdstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredDownload the invoice as a PDF
/v1/invoices/{id}/pdfDownload the invoice as a PDF
MCP tool: get-invoice-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
Cancel an issued invoice with a reversing document
/v1/invoices/{id}/stornoCancel an issued invoice with a reversing document. Legal effect: reverses the tax document and the bookings. Fails when the invoice has payments or its period is closed. Confirm with the user first.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: storno-invoice
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectzakazka_zakaznikastringpocetintegerkampanstringvatModestringexchangeRatenumbertemplateIdnull | stringcenterIdnull | stringactivityIdnull | stringprojectIdnull | stringseriesIdnull | stringconstantSymbolnull | stringtaxPointDatestringdatepaymentMethodstringlanguagestringnotePublicnull | stringnoteInternalnull | stringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringsellerNamenull | stringsellerIconull | stringsellerDicnull | stringreminderOnDuebooleanreminderWeekAfterbooleanreminder14DaysAfterbooleanreminderMonthAfterbooleannetHalerintegervatHalerintegerroundingHalerintegerrecurringIdnull | stringstornoOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetnull | stringshipToCitynull | stringshipToPostalCodenull | stringshipToCountrynull | stringcontactEmailnull | stringlinesobject[]object"invoice_line"requiredidstringrequireddescriptionstringrequiredquantitynumberrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requireditemIdnull | stringlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"invoice_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nullpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredpayablesBookany[]assetany[]retentionsobject[]idstringrequiredamountHalerinteger | nullrequireddueDatenull | stringrequireddatenotestring | nullrequiredlongTermbooleanrequiredcarrierIdnull | stringcreditWarningobjectlevelstringrequiredexposureHalerintegerrequiredafterHalerintegerrequiredwarnHalerinteger | nullrequiredblockHalerintegerrequiredavailableHalerintegerrequiredoriginalanybankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]required