Received invoices
Operations in the Received invoices group.
- GET/v1/received-invoices
- POST/v1/received-invoices
- GET/v1/received-invoices/{id}
- PATCH/v1/received-invoices/{id}
- POST/v1/received-invoices/{id}/attach
- GET/v1/received-invoices/{id}/attachment
- GET/v1/received-invoices/{id}/settlements
- POST/v1/received-invoices/{id}/settlements
- POST/v1/received-invoices/{id}/storno
- GET/v1/received-invoices/duplicate-check
List received invoices (faktury přijaté). `from` and `to` filter on the issue date; `unpaid=true` keeps those still to pay
/v1/received-invoicesList received invoices (faktury přijaté). `from` and `to` filter on the issue date; `unpaid=true` keeps those still to pay
MCP tool: list-received-invoices
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatusstringcontactIdstringdueFromstringdueTostringqstringmax 200 charsunpaid"true" | "false"customFieldKeystringcustomFieldValuestringmax 2000 charsResponse · 200
dataobject[]requiredobject"received_invoice"requiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdnull | stringcenterIdstring | nullactivityIdstring | nullprojectIdnull | stringseriesIdnull | stringconstantSymbolstring | nullreceivedOnnull | stringdatetaxPointDatestringdatepaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbannull | stringnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegerstornoOfIdnull | stringduplicateOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"received_invoice_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requiredlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"received_invoice_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredsettlementsobject[]object"received_invoice_settlement"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredsupplierAdvancesobject[]idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredassetany[]retentionsany[]duplicateobjectexistingIdstringrequiredbankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredimportedobjectuuidstringrequireddocumentTypeinteger | nullrequiredwarningsstring[]requiredtotalintegerhasMorebooleanrequiredRecord a received invoice
/v1/received-invoicesRecord a received invoice. Legal effect: posts to the books, and to the VAT evidence when the supplier is a VAT payer. Answers 409 when the supplier document number is already recorded. To record one from a PDF or a photo, use record-received-invoice-from-file.
MCP tool: create-received-invoice
Request 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 charsseriesIdstringsupplierDocumentNumberstringrequiredmax 64 charsvariableSymbolstring | nullconstantSymbolstring | nullreceivedOnstringYYYY-MM-DDissueDatestringrequiredYYYY-MM-DDtaxPointDatestringrequiredYYYY-MM-DDdueDatestringYYYY-MM-DDcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"theirAccountNumberstring | nulltheirBankCodestring | nulltheirIbanstring | nullnotePublicstring | nullnoteInternalstring | nullrecordbooleanconfirmDuplicatebooleansupplierAdvanceIdsstring[]linesobject[]requiredpurchaseHalerintegermin 0max 9007199254740991exemptPercentnumbermin 0max 100purchaseLineIdstring | nulldescriptionstringrequiredmax 240 charsquantitynumberrequiredunitstringmax 16 charsunitPriceHalerintegerrequiredmin -9007199254740991max 9007199254740991vatRate0 | 10 | 12 | 15 | 21requireditemIdstringwarehouseIdstringlotsobject[]itemIdstringlotIdstringcodestringmax 64 charsquantitynumberexpiryDatestring | nullserialNumbersstring[]orderLineIdstringrecyclingFeeIdstring | nullrecyclingPerUnitHalerintegermin 0max 9007199254740991recyclingTextstringmax 120 charsrecyclingUnit"ks" | "kg"recyclingCoefficientnumbermin 0max 1000000accountNumberstring | nullroundingMode"auto" | "crown" | "none"Response · 201
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdnull | stringcenterIdstring | nullactivityIdstring | nullprojectIdnull | stringseriesIdnull | stringconstantSymbolstring | nullreceivedOnnull | stringdatetaxPointDatestringdatepaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbannull | stringnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegerstornoOfIdnull | stringduplicateOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"received_invoice_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requiredlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"received_invoice_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredsettlementsobject[]object"received_invoice_settlement"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredsupplierAdvancesobject[]idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredassetany[]retentionsany[]duplicateobjectexistingIdstringrequiredbankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredimportedobjectuuidstringrequireddocumentTypeinteger | nullrequiredwarningsstring[]requiredGet a received invoice with lines, VAT recap, settlements, and the amount still to pay
/v1/received-invoices/{id}Get a received invoice with lines, VAT recap, settlements, and the amount still to pay
MCP tool: get-received-invoice
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdnull | stringcenterIdstring | nullactivityIdstring | nullprojectIdnull | stringseriesIdnull | stringconstantSymbolstring | nullreceivedOnnull | stringdatetaxPointDatestringdatepaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbannull | stringnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegerstornoOfIdnull | stringduplicateOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"received_invoice_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requiredlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"received_invoice_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredsettlementsobject[]object"received_invoice_settlement"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredsupplierAdvancesobject[]idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredassetany[]retentionsany[]duplicateobjectexistingIdstringrequiredbankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredimportedobjectuuidstringrequireddocumentTypeinteger | nullrequiredwarningsstring[]requiredChange a received invoice
/v1/received-invoices/{id}Change a received invoice
MCP tool: update-received-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 | nullcontactIdstringseriesIdstringsupplierDocumentNumberstringmax 64 charsvariableSymbolstring | nullconstantSymbolstring | nullreceivedOnstring | nullissueDatestringYYYY-MM-DDtaxPointDatestringYYYY-MM-DDdueDatestring | nullcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"theirAccountNumberstring | nulltheirBankCodestring | nulltheirIbanstring | nullnotePublicstring | nullnoteInternalstring | nullconfirmDuplicatebooleansupplierAdvanceIdsstring[]linesobject[]purchaseHalerintegermin 0max 9007199254740991exemptPercentnumbermin 0max 100purchaseLineIdstring | nulldescriptionstringrequiredmax 240 charsquantitynumberrequiredunitstringmax 16 charsunitPriceHalerintegerrequiredmin -9007199254740991max 9007199254740991vatRate0 | 10 | 12 | 15 | 21requireditemIdstringwarehouseIdstringlotsobject[]itemIdstringlotIdstringcodestringmax 64 charsquantitynumberexpiryDatestring | nullserialNumbersstring[]orderLineIdstringrecyclingFeeIdstring | nullrecyclingPerUnitHalerintegermin 0max 9007199254740991recyclingTextstringmax 120 charsrecyclingUnit"ks" | "kg"recyclingCoefficientnumbermin 0max 1000000accountNumberstring | nullrecordbooleanroundingMode"auto" | "crown" | "none"Response · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdnull | stringcenterIdstring | nullactivityIdstring | nullprojectIdnull | stringseriesIdnull | stringconstantSymbolstring | nullreceivedOnnull | stringdatetaxPointDatestringdatepaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbannull | stringnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegerstornoOfIdnull | stringduplicateOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"received_invoice_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requiredlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"received_invoice_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredsettlementsobject[]object"received_invoice_settlement"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredsupplierAdvancesobject[]idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredassetany[]retentionsany[]duplicateobjectexistingIdstringrequiredbankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredimportedobjectuuidstringrequireddocumentTypeinteger | nullrequiredwarningsstring[]requiredAttach the scan or PDF of a received invoice
/v1/received-invoices/{id}/attachAttach the scan or PDF of a received invoice
MCP tool: attach-received-invoice
Path parameters
idstringrequiredRequest body
fileIdstringfileBase64stringfilenamestringmax 200 charscontentTypestringmax 120 charsResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdnull | stringcenterIdstring | nullactivityIdstring | nullprojectIdnull | stringseriesIdnull | stringconstantSymbolstring | nullreceivedOnnull | stringdatetaxPointDatestringdatepaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbannull | stringnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegerstornoOfIdnull | stringduplicateOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"received_invoice_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requiredlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"received_invoice_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredsettlementsobject[]object"received_invoice_settlement"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredsupplierAdvancesobject[]idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredassetany[]retentionsany[]duplicateobjectexistingIdstringrequiredbankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredimportedobjectuuidstringrequireddocumentTypeinteger | nullrequiredwarningsstring[]requiredDownload the attached scan or PDF
/v1/received-invoices/{id}/attachmentDownload the attached scan or PDF
MCP tool: get-received-invoice-attachment
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
List the payments of a received invoice
/v1/received-invoices/{id}/settlementsList the payments of a received invoice
MCP tool: list-received-invoice-settlements
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"received_invoice_settlement"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredtotalintegerhasMorebooleanrequiredRecord a payment of a received 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/received-invoices/{id}/settlementsRecord a payment of a received 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. A cash expense that would take the register below zero is refused unless allowNegative is true.
MCP tool: add-received-invoice-settlement
Path parameters
idstringrequiredRequest body
amountHalerintegerrequiredmax 9007199254740991paidOnstringrequiredYYYY-MM-DDmethod"transfer" | "cash" | "card" | "other"inPersonbooleannotestring | nullregisterIdstringbankAccountIdstringmoneyAmountHalerintegermax 9007199254740991allowNegativebooleaneetPrepaidLoadHalerintegermin 0max 9007199254740991eetPrepaidUseHalerintegermin 0max 9007199254740991eetVoucherIdstringeetMandateIdstringeetOwnSalebooleanpaidAtstringdate-timeResponse · 201
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdnull | stringcenterIdstring | nullactivityIdstring | nullprojectIdnull | stringseriesIdnull | stringconstantSymbolstring | nullreceivedOnnull | stringdatetaxPointDatestringdatepaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbannull | stringnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegerstornoOfIdnull | stringduplicateOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"received_invoice_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requiredlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"received_invoice_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredsettlementsobject[]object"received_invoice_settlement"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredsupplierAdvancesobject[]idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredassetany[]retentionsany[]duplicateobjectexistingIdstringrequiredbankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredimportedobjectuuidstringrequireddocumentTypeinteger | nullrequiredwarningsstring[]requiredCancel a received invoice with a reversing document
/v1/received-invoices/{id}/stornoCancel a received invoice with a reversing document. Legal effect: reverses the bookings and the VAT evidence. Confirm with the user first.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: storno-received-invoice
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredfileIdnull | stringrequiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdnull | stringcenterIdstring | nullactivityIdstring | nullprojectIdnull | stringseriesIdnull | stringconstantSymbolstring | nullreceivedOnnull | stringdatetaxPointDatestringdatepaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbannull | stringnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegerstornoOfIdnull | stringduplicateOfIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetnull | stringbillToCitynull | stringbillToPostalCodenull | stringbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"received_invoice_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumbernull | stringrequiredlineKindstringrequiredsourceIdnull | stringrequireditemIdnull | stringrequiredwarehouseIdnull | stringrequiredlotsobject[]requiredlotIdstring | nullrequiredcodenull | stringrequiredquantityintegerrequiredexpiryDatestring | nullrequiredorderLineIdnull | stringrequiredrecyclingnull | objecttextstringrequiredunitstringrequiredfeeIdnull | stringrequiredrateHalerintegerrequiredtotalHalerintegerrequiredweightMilliintegerperUnitHalerintegerrequiredcoefficientMilliintegerrequiredtypedbooleanvatLinesobject[]object"received_invoice_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredsettlementsobject[]object"received_invoice_settlement"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredsupplierAdvancesobject[]idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredpostingobjectregimestringrequiredeventstringrequiredjournalLinesobject[]accountnull | stringrequiredsidestringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredbalancedbooleancashJournalobject[]accountnull | stringrequiredamountHalerinteger | nullrequireddocumentIdnull | stringrequiredreceivablesBookany[]payablesBookobject[]documentIdnull | stringrequiredamountHalerinteger | nullrequiredstatusstringrequiredassetany[]retentionsany[]duplicateobjectexistingIdstringrequiredbankMovementobjectidstringrequiredbankAccountIdstringrequiredcashDocumentobjectidstringrequirednumbernull | stringrequiredwarningsany[]requiredimportedobjectuuidstringrequireddocumentTypeinteger | nullrequiredwarningsstring[]requiredCheck whether this supplier document number is already recorded. Call before create-received-invoice
/v1/received-invoices/duplicate-checkCheck whether this supplier document number is already recorded. Call before create-received-invoice
MCP tool: duplicate-check-received-invoice
Query parameters
contactIdstringsupplierDocumentNumberstringResponse · 200
duplicatebooleanrequiredexistingIdstring