Credit notes
Operations in the Credit notes group.
List credit notes (dobropisy). `from` and `to` filter on the issue date
/v1/credit-notesList credit notes (dobropisy). `from` and `to` filter on the issue date
MCP tool: list-credit-notes
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatusstringcontactIdstringdueFromstringdueTostringqstringmax 200 charsunpaid"true" | "false"customFieldKeystringcustomFieldValuestringmax 2000 charsResponse · 200
dataobject[]requiredcustomFieldsobjectvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullobject"credit_note"requiredidstringrequirednumbernull | 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[]bankMovementobjectidstringrequiredbankAccountIdstringrequiredtotalintegerhasMorebooleanrequiredCreate a draft credit note. Line prices are negative. Prefer create-credit-note-from-invoice when there is an invoice
/v1/credit-notesCreate a draft credit note. Line prices are negative. Prefer create-credit-note-from-invoice when there is an invoice
MCP tool: create-credit-note
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 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[]bankMovementobjectidstringrequiredbankAccountIdstringrequiredGet a credit note with lines, VAT recap, and payments
/v1/credit-notes/{id}Get a credit note with lines, VAT recap, and payments
MCP tool: get-credit-note
Path parameters
idstringrequiredResponse · 200
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[]bankMovementobjectidstringrequiredbankAccountIdstringrequiredChange a draft credit note
/v1/credit-notes/{id}Change a draft credit note
MCP tool: update-credit-note
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 | nullcontactIdstringseriesIdstringoriginalInvoiceNumberstring | nullreasonstring | nullissueDatestringYYYY-MM-DDtaxPointDatestringYYYY-MM-DDkhDphDatestring | nulldueDatestring | nullcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"language"cs" | "en" | "sk" | "de" | "fr" | "pl"notePublicstring | nullnoteInternalstring | nulllinesobject[]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 · 200
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[]bankMovementobjectidstringrequiredbankAccountIdstringrequiredCreate a new draft credit note from an existing one
/v1/credit-notes/{id}/copyCreate a new draft credit note from an existing one
MCP tool: copy-credit-note
Path parameters
idstringrequiredResponse · 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 credit note
/v1/credit-notes/{id}/issueIssue a draft credit note. Legal effect: this assigns the final document number, creates a tax document, and posts to the books. Confirm with the user first.
MCP tool: issue-credit-note
Path parameters
idstringrequiredRequest body
reasonstringmax 500 charsResponse · 200
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[]bankMovementobjectidstringrequiredbankAccountIdstringrequiredRecord a refund paid against a credit note
/v1/credit-notes/{id}/paymentsRecord a refund paid against a credit note. 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. In another currency than the document, moneyAmountHaler says what moved on the account.
MCP tool: add-credit-note-payment
Path parameters
idstringrequiredRequest body
amountHalerintegerrequiredmax 9007199254740991paidOnstringrequiredYYYY-MM-DDmethod"transfer" | "cash" | "card" | "other"inPersonbooleannotestring | nullregisterIdstringbankAccountIdstringmoneyAmountHalerintegermax 9007199254740991allowNegativebooleaneetPrepaidLoadHalerintegermin 0max 9007199254740991eetPrepaidUseHalerintegermin 0max 9007199254740991eetVoucherIdstringeetMandateIdstringeetOwnSalebooleanpaidAtstringdate-timeResponse · 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[]bankMovementobjectidstringrequiredbankAccountIdstringrequiredDownload the credit note as a PDF
/v1/credit-notes/{id}/pdfDownload the credit note as a PDF
MCP tool: get-credit-note-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
Cancel an issued credit note with a reversing document
/v1/credit-notes/{id}/stornoCancel an issued credit note with a reversing document. Legal effect: reverses the tax document and the bookings. Confirm with the user first.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: storno-credit-note
Path parameters
idstringrequiredResponse · 200
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[]bankMovementobjectidstringrequiredbankAccountIdstringrequired