Show invoice or credit note
One invoice or credit note with its lines - and, if asked, its PDF or XRechnung XML.
manitu_account_financialdocument_get on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Returns one invoice or credit note of the manitu customer account, by its type and the number printed on it (from manitu_account_financialdocument_list, or as the customer quotes it): everything the list shows, plus its lines (what was billed, quantity, period, VAT rate, net prices in cent). Leave file_format out to answer questions about it - the lines say what is on the document. Ask for file_format pdf or xml only when the customer needs the file itself; it comes base64-encoded and is long. The customer finds the PDF in the customer panel as well.
Arguments
typestringrequiredinvoice or credit_note - as the list answers it.
numberinteger | stringrequiredThe number printed on the document, digits only, e.g. 1634488 - a prefix like "G" or "R" is ignored. From manitu_account_financialdocument_list or as the customer quotes it; never guess one.
file_formatstringpdf, or xml (XRechnung / Factur-X) - the file as well, base64. Left out: no file.
Result structuredContent, checked against the schema
financial_documentobjectrequiredfinancial_document.typestringrequiredAn invoice, or a credit note (money manitu owes the customer).
financial_document.subtypestring | nullrequiredinvoice for an invoice; for a credit note credit (a credit note) or invoiceamendment (a corrected invoice).
financial_document.numberstringrequiredThe number printed on it - what the customer quotes; together with type what manitu_account_financialdocument_get takes.
financial_document.reasonstring | nullrequiredWhy a credit note was issued; null for an invoice.
financial_document.issued_onstring | nullrequiredThe date of the document.
financial_document.due_onstring | nullrequiredWhen an invoice is due; null for a credit note.
financial_document.currencystring | nullrequirede.g. "EUR".
financial_document.total_net_centinteger | nullrequiredThe total without VAT, in cent - 10000 is 100.00.
financial_document.total_vat_centinteger | nullrequiredThe VAT, in cent.
financial_document.total_gross_centinteger | nullrequiredThe total including VAT, in cent.
financial_document.payment_statusstring | nullrequiredWhether it is paid - by the customer (invoice) or paid out by manitu (credit note).
financial_document.amount_paid_centinteger | nullrequiredPaid so far, in cent - by the customer (invoice) or by manitu (credit note).
financial_document.amount_due_centinteger | nullrequiredStill open, in cent: total_gross_cent minus amount_paid_cent.
financial_document.is_unpaid_duebooleanrequiredAn invoice not paid whose due date has come - what needs the customer's attention. Always false for a credit note.
financial_document.line_listarray of objectrequiredThe lines of the document, net, in its order.
financial_document.line_list[].namestring | nullrequiredfinancial_document.line_list[].descriptionstring | nullrequiredfinancial_document.line_list[].quantitynumber | nullrequiredfinancial_document.line_list[].service_period_start_onstring | nullrequiredThe period the line is for, first day.
financial_document.line_list[].service_period_end_onstring | nullrequiredThe period the line is for, last day (inclusive).
financial_document.line_list[].vat_rate_percentnumber | nullrequirede.g. 19.
financial_document.line_list[].unit_price_net_centinteger | nullrequiredThe price of one unit without VAT, in cent.
financial_document.line_list[].total_net_centinteger | nullrequiredquantity x unit price, without VAT, in cent.
fileobject | nullrequiredThe file asked for in file_format; null if none was asked for.
file.filenamestringrequiredfile.content_typestringrequiredfile.data_base64stringrequiredAuthentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
typestringrequiredinvoice or credit_note - as the list answers it.
numberinteger | stringrequiredThe number printed on the document, digits only, e.g. 1634488 - a prefix like "G" or "R" is ignored. From manitu_account_financialdocument_list or as the customer quotes it; never guess one.
file_formatstringpdf, or xml (XRechnung / Factur-X) - the file as well, base64. Left out: no file.
Response in data; the rest of the body as on every call
financial_documentobjectrequiredfinancial_document.typestringrequiredAn invoice, or a credit note (money manitu owes the customer).
financial_document.subtypestring | nullrequiredinvoice for an invoice; for a credit note credit (a credit note) or invoiceamendment (a corrected invoice).
financial_document.numberstringrequiredThe number printed on it - what the customer quotes; together with type what manitu_account_financialdocument_get takes.
financial_document.reasonstring | nullrequiredWhy a credit note was issued; null for an invoice.
financial_document.issued_onstring | nullrequiredThe date of the document.
financial_document.due_onstring | nullrequiredWhen an invoice is due; null for a credit note.
financial_document.currencystring | nullrequirede.g. "EUR".
financial_document.total_net_centinteger | nullrequiredThe total without VAT, in cent - 10000 is 100.00.
financial_document.total_vat_centinteger | nullrequiredThe VAT, in cent.
financial_document.total_gross_centinteger | nullrequiredThe total including VAT, in cent.
financial_document.payment_statusstring | nullrequiredWhether it is paid - by the customer (invoice) or paid out by manitu (credit note).
financial_document.amount_paid_centinteger | nullrequiredPaid so far, in cent - by the customer (invoice) or by manitu (credit note).
financial_document.amount_due_centinteger | nullrequiredStill open, in cent: total_gross_cent minus amount_paid_cent.
financial_document.is_unpaid_duebooleanrequiredAn invoice not paid whose due date has come - what needs the customer's attention. Always false for a credit note.
financial_document.line_listarray of objectrequiredThe lines of the document, net, in its order.
financial_document.line_list[].namestring | nullrequiredfinancial_document.line_list[].descriptionstring | nullrequiredfinancial_document.line_list[].quantitynumber | nullrequiredfinancial_document.line_list[].service_period_start_onstring | nullrequiredThe period the line is for, first day.
financial_document.line_list[].service_period_end_onstring | nullrequiredThe period the line is for, last day (inclusive).
financial_document.line_list[].vat_rate_percentnumber | nullrequirede.g. 19.
financial_document.line_list[].unit_price_net_centinteger | nullrequiredThe price of one unit without VAT, in cent.
financial_document.line_list[].total_net_centinteger | nullrequiredquantity x unit price, without VAT, in cent.
fileobject | nullrequiredThe file asked for in file_format; null if none was asked for.
file.filenamestringrequiredfile.content_typestringrequiredfile.data_base64stringrequiredStatuses
200Success.400The request does not match the declared input schema.401No credential was presented, or it was not recognised.403The credential is not permitted to use this operation.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.