Advances to suppliers
Operations in the Advances to suppliers group.
- GET/v1/supplier-advance-tax-documents
- PATCH/v1/supplier-advance-tax-documents/{id}
- POST/v1/supplier-advance-tax-documents/{id}/storno
- GET/v1/supplier-advances
- POST/v1/supplier-advances
- GET/v1/supplier-advances/{id}
- PATCH/v1/supplier-advances/{id}
- POST/v1/supplier-advances/{id}/cancel
- POST/v1/supplier-advances/{id}/payments
- DEL/v1/supplier-advances/{id}/payments/{paymentId}
- POST/v1/supplier-advances/{id}/reclassify
- POST/v1/supplier-advances/{id}/record
- POST/v1/supplier-advances/{id}/refund
- POST/v1/supplier-advances/{id}/settle
- POST/v1/supplier-advances/{id}/tax-documents
List suppliers' tax documents for paid advances, including corrections and stornos
/v1/supplier-advance-tax-documentsList suppliers' tax documents for paid advances, including corrections and stornos
MCP tool: list-supplier-advance-tax-documents
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDResponse · 200
dataobject[]requiredobject"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtotalintegerhasMorebooleanrequiredFill in the supplier's number on a tax document, usually a correction booked before the document arrived
/v1/supplier-advance-tax-documents/{id}Fill in the supplier's number on a tax document, usually a correction booked before the document arrived
MCP tool: update-supplier-advance-tax-document
Path parameters
idstringrequiredRequest body
supplierDocumentNumberstringrequiredmax 64 charsResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredCancel a supplier's tax document for a paid advance, or a self-assessment, with a reversing document
/v1/supplier-advance-tax-documents/{id}/stornoCancel a supplier's tax document for a paid advance, or a self-assessment, with a reversing document. Legal effect: reverses the deduction in the period you learn of it. Refused once a final invoice has deducted it or a refund has corrected it. A self-assessment asks why (`reason`): a `mistake` is reversed in the original period, and the answer's `stornoCorrection` says whether that period needs an additional return and a follow-up control statement; a `refund` or a `cancelled` supply is corrected on `occurredOn`, today when left out. A refund that brings money back is better entered as a refund of the advance.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: storno-supplier-advance-tax-document
Path parameters
idstringrequiredRequest body
reason"mistake" | "refund" | "cancelled"occurredOnstringYYYY-MM-DDResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredList zálohové faktury from suppliers: advances to pay or paid. `from` and `to` filter on the issue date; `unpaid=true` keeps those still to pay
/v1/supplier-advancesList zálohové faktury from suppliers: advances to pay or paid. `from` and `to` filter on the issue date; `unpaid=true` keeps those still to pay
MCP tool: list-supplier-advances
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatusstringcontactIdstringdueFromstringdueTostringqstringmax 200 charsunpaid"true" | "false"customFieldKeystringcustomFieldValuestringmax 2000 charsResponse · 200
dataobject[]requiredobject"supplier_advance"requiredidstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredtotalintegerhasMorebooleanrequiredRecord a supplier's zálohová faktura. It is not a tax document: nothing is posted and no VAT is claimed until it is paid and the supplier's tax document arrives
/v1/supplier-advancesRecord a supplier's zálohová faktura. It is not a tax document: nothing is posted and no VAT is claimed until it is paid and the supplier's tax document arrives. Answers 409 when the supplier document number is already recorded. `record: false` keeps a draft.
MCP tool: create-supplier-advance
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 | nulladvanceAccount"151" | "152" | "153" | "314" | "051" | "052"taxRecordsKind"expense" | "long_term_asset" | "related_party"contactIdstringcontactNamestringmax 160 charscontactIcostringmax 16 charscontactDicstringmax 16 charsseriesIdstringsupplierDocumentNumberstringrequiredmax 64 charsvariableSymbolstring | nullconstantSymbolstring | nullissueDatestringrequiredYYYY-MM-DDdueDatestringYYYY-MM-DDcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"theirAccountNumberstring | nulltheirBankCodestring | nulltheirIbanstring | nullnotePublicstring | nullnoteInternalstring | nullrecordbooleanconfirmDuplicatebooleanlinesobject[]requiredpurchaseHalerintegermin 0max 9007199254740991exemptPercentnumbermin 0max 100purchaseLineIdstring | nulldescriptionstringrequiredmax 240 charsquantitynumberrequiredunitstringmax 16 charsunitPriceHalerintegerrequiredmin -9007199254740991max 9007199254740991vatRate0 | 10 | 12 | 15 | 21requireditemIdstringwarehouseIdstringlotsobject[]itemIdstringlotIdstringcodestringmax 64 charsquantitynumberexpiryDatestring | nullserialNumbersstring[]orderLineIdstringaccountNumberstring | nullroundingMode"auto" | "crown" | "none"Response · 201
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredGet an advance to a supplier with lines, payments, and the supplier's tax documents
/v1/supplier-advances/{id}Get an advance to a supplier with lines, payments, and the supplier's tax documents
MCP tool: get-supplier-advance
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredChange an advance to a supplier. Lines, currency, VAT mode, and supplier only while it is a draft
/v1/supplier-advances/{id}Change an advance to a supplier. Lines, currency, VAT mode, and supplier only while it is a draft
MCP tool: update-supplier-advance
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 | nulladvanceAccount"151" | "152" | "153" | "314" | "051" | "052"taxRecordsKind"expense" | "long_term_asset" | "related_party"contactIdstringseriesIdstringsupplierDocumentNumberstringmax 64 charsvariableSymbolstring | nullconstantSymbolstring | nullissueDatestringYYYY-MM-DDdueDatestring | nullcurrencystring3 charspaymentMethod"transfer" | "cash" | "proforma" | "card" | "cod"theirAccountNumberstring | nulltheirBankCodestring | nulltheirIbanstring | nullnotePublicstring | nullnoteInternalstring | nullconfirmDuplicatebooleanlinesobject[]purchaseHalerintegermin 0max 9007199254740991exemptPercentnumbermin 0max 100purchaseLineIdstring | nulldescriptionstringrequiredmax 240 charsquantitynumberrequiredunitstringmax 16 charsunitPriceHalerintegerrequiredmin -9007199254740991max 9007199254740991vatRate0 | 10 | 12 | 15 | 21requireditemIdstringwarehouseIdstringlotsobject[]itemIdstringlotIdstringcodestringmax 64 charsquantitynumberexpiryDatestring | nullserialNumbersstring[]orderLineIdstringaccountNumberstring | nullrecordbooleanroundingMode"auto" | "crown" | "none"Response · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredCancel an advance to a supplier that has no payments
/v1/supplier-advances/{id}/cancelCancel an advance to a supplier that has no payments
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: cancel-supplier-advance
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredRecord a payment of an advance to a supplier: MD 314 or the account it sits on / D 221, or an expense in the cash book
/v1/supplier-advances/{id}/paymentsRecord a payment of an advance to a supplier: MD 314 or the account it sits on / D 221, or an expense in the cash book. 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. A later statement line takes the transfer over.
MCP tool: add-supplier-advance-payment
Path parameters
idstringrequiredRequest body
amountHalerintegerrequiredmax 9007199254740991paidOnstringrequiredYYYY-MM-DDmethod"transfer" | "cash" | "card" | "other"inPersonbooleannotestring | nullregisterIdstringbankAccountIdstringmoneyAmountHalerintegermax 9007199254740991allowNegativebooleaneetPrepaidLoadHalerintegermin 0max 9007199254740991eetPrepaidUseHalerintegermin 0max 9007199254740991eetVoucherIdstringeetMandateIdstringeetOwnSalebooleanpaidAtstringdate-timeexchangeRatenumberResponse · 201
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredRemove a payment or refund of an advance to a supplier and reverse its posting
/v1/supplier-advances/{id}/payments/{paymentId}Remove a payment or refund of an advance to a supplier and reverse its posting. Refused while a tax document stands on the payment or the advance is settled. Removing a refund also cancels its corrective tax document.
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: remove-supplier-advance-payment
Path parameters
idstringrequiredpaymentIdstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredMove an advance to a supplier to another account: 314, 051, 052, 151, 152, or 153. Posts MD new / D old for what it holds
/v1/supplier-advances/{id}/reclassifyMove an advance to a supplier to another account: 314, 051, 052, 151, 152, or 153. Posts MD new / D old for what it holds. Legal effect: posts to the books. Double-entry only. Refused while a tax document stands on the advance and once it is settled: at the final invoice it clears by itself, MD 042 / D 052 and so on.
MCP tool: reclassify-supplier-advance
Path parameters
idstringrequiredRequest body
advanceAccount"151" | "152" | "153" | "314" | "051" | "052"requireddatestringYYYY-MM-DDResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredRecord a draft advance to a supplier: it gets its number and can be paid
/v1/supplier-advances/{id}/recordRecord a draft advance to a supplier: it gets its number and can be paid
MCP tool: record-supplier-advance
Path parameters
idstringrequiredResponse · 200
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredRecord money a supplier paid back on an advance. Whatever part was taxed takes the supplier's corrective tax document (§ 74 ZDPH)
/v1/supplier-advances/{id}/refundRecord money a supplier paid back on an advance. Whatever part was taxed takes the supplier's corrective tax document (§ 74 ZDPH). amountHaler defaults to everything paid. Refused once the advance is settled into an invoice. `supplierDocumentNumber` can follow later through update-supplier-advance-tax-document.
MCP tool: refund-supplier-advance
Path parameters
idstringrequiredRequest body
amountHalerintegermax 9007199254740991refundedOnstringrequiredYYYY-MM-DDmethod"transfer" | "cash" | "card" | "other"reasonstringrequiredmax 240 charsnotestring | nullexchangeRatenumbersupplierDocumentNumberstringmax 64 charsreceivedOnstringYYYY-MM-DDregisterIdstringbankAccountIdstringmoneyAmountHalerintegermax 9007199254740991allowNegativebooleaneetPrepaidLoadHalerintegermin 0max 9007199254740991eetPrepaidUseHalerintegermin 0max 9007199254740991eetVoucherIdstringeetMandateIdstringeetOwnSalebooleanpaidAtstringdate-timeResponse · 201
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequiredRecord the supplier's final invoice for an advance and deduct the advance from it. Lines default to the advance's. To deduct several, use `supplierAdvanceIds` on create-received-invoice
/v1/supplier-advances/{id}/settleRecord the supplier's final invoice for an advance and deduct the advance from it. Lines default to the advance's. To deduct several, use `supplierAdvanceIds` on create-received-invoice. Legal effect: posts costs and VAT and clears the advance against 321: MD 518 / D 314, or MD 042 / D 052 when the advance sits on an account of what it pays for and the line names no account of its own. Storno of the invoice hands the advance back.
MCP tool: settle-supplier-advance
Path parameters
idstringrequiredRequest body
supplierDocumentNumberstringrequiredmax 64 charsissueDatestringrequiredYYYY-MM-DDtaxPointDatestringrequiredYYYY-MM-DDreceivedOnstringYYYY-MM-DDdueDatestringYYYY-MM-DDexchangeRatenumberconfirmDuplicatebooleanlinesobject[]purchaseHalerintegermin 0max 9007199254740991exemptPercentnumbermin 0max 100purchaseLineIdstring | nulldescriptionstringrequiredmax 240 charsquantitynumberrequiredunitstringmax 16 charsunitPriceHalerintegerrequiredmin -9007199254740991max 9007199254740991vatRate0 | 10 | 12 | 15 | 21requireditemIdstringwarehouseIdstringlotsobject[]itemIdstringlotIdstringcodestringmax 64 charsquantitynumberexpiryDatestring | nullserialNumbersstring[]orderLineIdstringaccountNumberstring | 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[]requiredRecord the supplier's tax document for a paid advance: MD 343 / D 314 for the VAT, into the VAT register and control statement of its period. For a service from the EU or a third country it records the customer's self-assessment of the payment instead. VAT payers only
/v1/supplier-advances/{id}/tax-documentsRecord the supplier's tax document for a paid advance: MD 343 / D 314 for the VAT, into the VAT register and control statement of its period. For a service from the EU or a third country it records the customer's self-assessment of the payment instead. VAT payers only. Without `lines` the VAT is taken out of the part paid and not yet taxed, at the advance's rates. `receivedOn` decides the first period the deduction may be claimed in (§ 73 odst. 2 ZDPH). In modes eu_services and third_country_services the tax is due on the day of the payment (§ 24 odst. 3, § 108 odst. 3 ZDPH): `vatRate` (default 21) goes on the payment as the base, `supplierDocumentNumber` is optional, and tax and deduction land in the same period with nothing in the books. Do not record it if the supply is not yet known with enough certainty (§ 24 odst. 3, second sentence): the final invoice then carries the tax.
MCP tool: create-supplier-advance-tax-document
Path parameters
idstringrequiredRequest body
supplierDocumentNumberstringmax 64 charspaymentIdstringvatRate21 | 12issueDatestringYYYY-MM-DDtaxPointDatestringYYYY-MM-DDreceivedOnstringYYYY-MM-DDexchangeRatenumberamountHalerintegermax 9007199254740991linesobject[]vatRatenumberrequiredmin 0max 30netHalerintegerrequiredmin -9007199254740991max 9007199254740991vatHalerintegerrequiredmin -9007199254740991max 9007199254740991descriptionstringmax 400 charsResponse · 201
idstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredvariableSymbolnull | stringrequiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredissueDatestringrequireddatedueDatenull | stringrequireddatecurrencystringrequiredtotalHalerintegerrequiredpaidHalerintegerrequiredstatusstringrequiredoverduebooleanrequiredcustomFieldsobjectstavba_zalohystringvatModestringexchangeRateintegertemplateIdstring | nullcenterIdstring | nullactivityIdstring | nullprojectIdstring | nullseriesIdnull | stringconstantSymbolstring | nullpaymentMethodstringtheirAccountNumbernull | stringtheirBankCodenull | stringtheirIbanstring | nullnotePublicstring | nullnoteInternalnull | stringnetHalerintegervatHalerintegertaxedHalerintegeradvanceAccountstringselfAssessablebooleanreceivedInvoiceIdnull | stringcontactIconull | stringcontactDicnull | stringcontactVatPayerTypenull | stringbillToStreetstring | nullbillToCitystring | nullbillToPostalCodestring | nullbillToCountrynull | stringshipToNamestring | nullshipToStreetstring | nullshipToCitystring | nullshipToPostalCodestring | nullshipToCountrystring | nullcontactEmailnull | stringlinesobject[]object"supplier_advance_line"requiredidstringrequireddescriptionstringrequiredquantityintegerrequiredunitstringrequiredunitPriceHalerintegerrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredaccountNumberstring | nullrequiredlineKindstringrequiredsourceIdstring | nullrequireditemIdstring | nullrequiredwarehouseIdstring | nullrequiredlotsany[]requiredorderLineIdstring | nullrequiredvatLinesobject[]object"supplier_advance_vat_line"requiredidstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredpaymentsobject[]object"supplier_advance_payment"requiredidstringrequiredamountHalerintegerrequiredpaidOnstringrequireddatemethodstringrequirednotenull | stringrequiredexchangeRatenumberrequiredtaxDocumentsobject[]object"supplier_advance_tax_document"requiredidstringrequiredsupplierAdvanceIdstringrequirednumbernull | stringrequiredsupplierDocumentNumbernull | stringrequiredcontactNamenull | stringrequiredcontactDicnull | stringrequiredstatusstringrequiredissueDatestringrequireddatetaxPointDatestringrequireddatereceivedOnnull | stringrequireddatecurrencystringrequiredexchangeRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredreasonnull | stringrequiredcorrectsNumbernull | stringrequiredselfAssessedbooleanrequiredpaymentIdnull | stringrequiredreceivedInvoiceIdnull | stringrequiredstornoOfIdnull | stringrequiredlinesobject[]requiredobject"supplier_advance_tax_document_line"requiredidstringrequireddescriptionstringrequiredvatRateintegerrequirednetHalerintegerrequiredvatHalerintegerrequiredtotalHalerintegerrequiredtaxRecordsKindstringbankMovementobjectidstringrequiredbankAccountIdstringrequiredrefundobjectamountHalerinteger | nullrequiredpaymentIdnull | stringrequiredcorrectionIdnull | stringrequiredcorrectionNumbernull | stringrequiredstornoCorrectionobjectreasonnull | stringrequireddatestringrequireddateperiodstringrequiredadditionalReturnbooleanrequiredfollowUpStatementbooleanrequired