Proformas
Operations in the Proformas group.
List proforma invoices (zálohové faktury). `from` and `to` filter on the issue date
/v1/proformasList proforma invoices (zálohové faktury). `from` and `to` filter on the issue date
MCP tool: list-proformas
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatusstringcontactIdstringdueFromstringdueTostringqstringmax 200 charsunpaid"true" | "false"customFieldKeystringcustomFieldValuestringmax 2000 charsResponse · 200
dataobject[]requiredobject"proforma"requiredidstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredkindstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringcurrencystringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalstring | nullnetHalerintegervatHalerintegercontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringsellerNamenull | stringlinesobject[]object"proforma_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdstringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerrequiredperUnitHalerintegerrequiredcoefficientMilliintegerrequiredvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"proforma_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nulltaxDocumentsobject[]object"advance_tax_document"requiredidstringrequirednumbernull | stringrequiredstatusstringrequiredissueDatenull | stringrequireddatenetHalerintegerrequiredvatHalerinteger | nullrequiredtotalHalerinteger | nullrequiredinvoiceIdnull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredskippedbooleanjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookany[]assetany[]carrierIdstring | nullbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredtotalintegerhasMorebooleanrequiredCreate a proforma invoice. It is not a tax document
/v1/proformasCreate a proforma invoice. It is not a tax document
MCP tool: create-proforma
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 charsseriesIdstringkind"advance" | "proforma"issueDatestringrequiredYYYY-MM-DDdueDatestringYYYY-MM-DDcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"language"cs" | "en" | "sk" | "de" | "fr" | "pl"notePublicstring | nullnoteInternalstring | nullissuebooleanlinesobject[]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 | stringrequiredkindstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringcurrencystringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalstring | nullnetHalerintegervatHalerintegercontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringsellerNamenull | stringlinesobject[]object"proforma_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdstringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerrequiredperUnitHalerintegerrequiredcoefficientMilliintegerrequiredvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"proforma_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nulltaxDocumentsobject[]object"advance_tax_document"requiredidstringrequirednumbernull | stringrequiredstatusstringrequiredissueDatenull | stringrequireddatenetHalerintegerrequiredvatHalerinteger | nullrequiredtotalHalerinteger | nullrequiredinvoiceIdnull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredskippedbooleanjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookany[]assetany[]carrierIdstring | nullbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredGet a proforma invoice with lines and payments
/v1/proformas/{id}Get a proforma invoice with lines and payments
MCP tool: get-proforma
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredkindstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringcurrencystringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalstring | nullnetHalerintegervatHalerintegercontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringsellerNamenull | stringlinesobject[]object"proforma_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdstringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerrequiredperUnitHalerintegerrequiredcoefficientMilliintegerrequiredvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"proforma_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nulltaxDocumentsobject[]object"advance_tax_document"requiredidstringrequirednumbernull | stringrequiredstatusstringrequiredissueDatenull | stringrequireddatenetHalerintegerrequiredvatHalerinteger | nullrequiredtotalHalerinteger | nullrequiredinvoiceIdnull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredskippedbooleanjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookany[]assetany[]carrierIdstring | nullbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredChange a draft proforma invoice
/v1/proformas/{id}Change a draft proforma invoice
MCP tool: update-proforma
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 | nullcontactIdstringseriesIdstringkind"advance" | "proforma"issueDatestringYYYY-MM-DDdueDatestring | nullcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"language"cs" | "en" | "sk" | "de" | "fr" | "pl"notePublicstring | nullnoteInternalstring | 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 | stringrequiredkindstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringcurrencystringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalstring | nullnetHalerintegervatHalerintegercontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringsellerNamenull | stringlinesobject[]object"proforma_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdstringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerrequiredperUnitHalerintegerrequiredcoefficientMilliintegerrequiredvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"proforma_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nulltaxDocumentsobject[]object"advance_tax_document"requiredidstringrequirednumbernull | stringrequiredstatusstringrequiredissueDatenull | stringrequireddatenetHalerintegerrequiredvatHalerinteger | nullrequiredtotalHalerinteger | nullrequiredinvoiceIdnull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredskippedbooleanjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookany[]assetany[]carrierIdstring | nullbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredCancel a proforma invoice
/v1/proformas/{id}/cancelCancel a proforma invoice
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: cancel-proforma
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredkindstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringcurrencystringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalstring | nullnetHalerintegervatHalerintegercontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringsellerNamenull | stringlinesobject[]object"proforma_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdstringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerrequiredperUnitHalerintegerrequiredcoefficientMilliintegerrequiredvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"proforma_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nulltaxDocumentsobject[]object"advance_tax_document"requiredidstringrequirednumbernull | stringrequiredstatusstringrequiredissueDatenull | stringrequireddatenetHalerintegerrequiredvatHalerinteger | nullrequiredtotalHalerinteger | nullrequiredinvoiceIdnull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredskippedbooleanjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookany[]assetany[]carrierIdstring | nullbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredCreate a new draft proforma invoice from an existing one
/v1/proformas/{id}/copyCreate a new draft proforma invoice from an existing one
MCP tool: copy-proforma
Path parameters
idstringrequiredResponse · 201
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredkindstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringcurrencystringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalstring | nullnetHalerintegervatHalerintegercontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringsellerNamenull | stringlinesobject[]object"proforma_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdstringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerrequiredperUnitHalerintegerrequiredcoefficientMilliintegerrequiredvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"proforma_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nulltaxDocumentsobject[]object"advance_tax_document"requiredidstringrequirednumbernull | stringrequiredstatusstringrequiredissueDatenull | stringrequireddatenetHalerintegerrequiredvatHalerinteger | nullrequiredtotalHalerinteger | nullrequiredinvoiceIdnull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredskippedbooleanjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookany[]assetany[]carrierIdstring | nullbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredIssue a draft proforma invoice: it gets its number and can be sent
/v1/proformas/{id}/issueIssue a draft proforma invoice: it gets its number and can be sent
MCP tool: issue-proforma
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredkindstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringcurrencystringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalstring | nullnetHalerintegervatHalerintegercontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringsellerNamenull | stringlinesobject[]object"proforma_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdstringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerrequiredperUnitHalerintegerrequiredcoefficientMilliintegerrequiredvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"proforma_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nulltaxDocumentsobject[]object"advance_tax_document"requiredidstringrequirednumbernull | stringrequiredstatusstringrequiredissueDatenull | stringrequireddatenetHalerintegerrequiredvatHalerinteger | nullrequiredtotalHalerinteger | nullrequiredinvoiceIdnull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredskippedbooleanjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookany[]assetany[]carrierIdstring | nullbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredRecord an advance payment of a proforma invoice
/v1/proformas/{id}/paymentsRecord an advance payment of a proforma invoice. Legal effect: posts to the books. Cash goes through a cash document of a register and a transfer through a bank account; with several name registerId or bankAccountId. For a VAT payer, `createTaxDocument: true` also issues the tax document for the received advance.
MCP tool: add-proforma-payment
Path parameters
idstringrequiredRequest body
amountHalerintegerrequiredmax 9007199254740991paidOnstringrequiredYYYY-MM-DDmethod"transfer" | "cash" | "card" | "other"inPersonbooleannotestring | nullregisterIdstringbankAccountIdstringmoneyAmountHalerintegermax 9007199254740991allowNegativebooleaneetPrepaidLoadHalerintegermin 0max 9007199254740991eetPrepaidUseHalerintegermin 0max 9007199254740991eetVoucherIdstringeetMandateIdstringeetOwnSalebooleanpaidAtstringdate-timecreateTaxDocumentbooleanResponse · 201
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredkindstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringcurrencystringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalstring | nullnetHalerintegervatHalerintegercontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringsellerNamenull | stringlinesobject[]object"proforma_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdstringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerrequiredperUnitHalerintegerrequiredcoefficientMilliintegerrequiredvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"proforma_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nulltaxDocumentsobject[]object"advance_tax_document"requiredidstringrequirednumbernull | stringrequiredstatusstringrequiredissueDatenull | stringrequireddatenetHalerintegerrequiredvatHalerinteger | nullrequiredtotalHalerinteger | nullrequiredinvoiceIdnull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredskippedbooleanjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookany[]assetany[]carrierIdstring | nullbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredRemove an advance payment recorded on a proforma invoice
/v1/proformas/{id}/payments/{paymentId}Remove an advance payment recorded on a proforma invoice. Legal effect: reverses what the payment posted to the books.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: remove-proforma-payment
Path parameters
idstringrequiredpaymentIdstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredvariableSymbolnull | stringrequiredkindstringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatetotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringcurrencystringourAccountNumbernull | stringourBankCodenull | stringourIbannull | stringpaymentMethodstringlanguagestringnotePublicstring | nullnoteInternalstring | nullnetHalerintegervatHalerintegercontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringsellerNamenull | stringlinesobject[]object"proforma_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsany[]requiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdstringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerrequiredperUnitHalerintegerrequiredcoefficientMilliintegerrequiredvatLinesobject[]object"invoice_vat_line"requiredidstringrequiredvatRatenumberrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"proforma_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredlinksobject[]object"document_link"requiredidstringrequiredfromKindstringrequiredfromIdstringrequiredtoKindstringrequiredtoIdstringrequiredkindstringrequiredamountHalerinteger | nulltaxDocumentsobject[]object"advance_tax_document"requiredidstringrequirednumbernull | stringrequiredstatusstringrequiredissueDatenull | stringrequireddatenetHalerintegerrequiredvatHalerinteger | nullrequiredtotalHalerinteger | nullrequiredinvoiceIdnull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredskippedbooleanjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookany[]assetany[]carrierIdstring | nullbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredDownload the proforma invoice as a PDF
/v1/proformas/{id}/pdfDownload the proforma invoice as a PDF
MCP tool: get-proforma-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
Create the final invoice from a proforma invoice, and issue it unless `issue` is false
/v1/proformas/{id}/settleCreate the final invoice from a proforma invoice, and issue it unless `issue` is false. Legal effect: this assigns the final document number, creates a tax document, and posts to the books. Confirm with the user first.
MCP tool: settle-proforma
Path parameters
idstringrequiredRequest body
issueDatestringYYYY-MM-DDtaxPointDatestringYYYY-MM-DDissuebooleanResponse · 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[]required