Collect payables
Learn how to collect an incoming invoice to start the payable flow.
There are several ways to collect payables into Monite:
When a payable is created from a PDF, PNG, or JPEG file, Monite’s OCR service automatically extracts the invoice information from the file and a new payable is created with the extracted data fields accordingly. The file property of the payable contains the file metadata and the link to access the original source file.
Monite OCR uses top-notch Optical Character Recognition (OCR) algorithms to pull text from payables.
ocr_finished is triggered once the OCR has finished processing the file and storing the extracted data into a payable.payable.ocr_status reflects the current status of the OCR process of a payable. Its possible values are processing, error, and success.While this is not an exhaustive list, Monite OCR guarantees tested coverage for the following languages:
If you already have the invoice data (amount in minor units, currency, vendor information, and other details) stored somewhere as individual attributes, you can create a payable with these attributes by calling POST /payables.
You can provide the base64-encoded contents of the original invoice file in the field base64_encoded_file:
Notes:
file_name field is optional. If omitted, it defaults to "default_file_name".suggested_payment_term, this object can be omitted from the request body.subtotal and total_amount of the payable are automatically calculated based on the values of the line items, therefore, they are read-only and appear only in the response schema. This feature can be disabled in the partner’s settings by calling PATCH /settings passing the field enable_line_items as false (the default value is true). Once enable_line_items is disabled, the fields amount, subtotal, tax, and tax_amount of the payable object become editable during its creation and update, as they will no longer be calculated/re-calculated based on line items.enforce_approval_policy_id. When set, this policy will be applied when the payable is submitted for approval, regardless of trigger conditions.The successful response returns the id assigned to this payable, along with the information passed in the request. You can use this id in other API calls to update the data of this payable or trigger status transitions:
If the values of the fields payment_terms.final_term and issued_at are provided in the payable, the due_date will be automatically calculated based on issued_at plus the number of days defined by payment_terms.final_term.number_of_days.
For example, if issued_at equals to 2023-06-15 and payment_terms.term_final.number_of_days equals to 10, the due_date will be automatically set to 2023-06-25.
In any other case, the due_date supplied by the user is stored in the payable. The payment_terms and issued_at fields have priority in the calculation of the due_date, even if thedue_date is supplied by the user.
The automatic calculation of the due_date happens when the payable is parsed by the OCR, created with data, or updated.
Once the payable is created, Monite automatically fills the payable’s field suggested_payment_term with a suggestion for the payment date and corresponding discount, if available, based on its payment terms (represented by the field payment_terms). When the payable’s issued_at or payment_terms fields are updated, the value for the suggested_payment_term is recalculated.
It is possible to choose the payment term (term_1, term_2, or term_final) to be suggested as default by setting the field payment_priority in the entity’s settings to one of these values:
working_capital: Selects the term with the latest possible payment target.
bottom_line: Selects the term with the highest discount.
balanced: Selects the intermediate term, that is, a balance between duration and drawn discount.
The suggested_payment_term will be calculated based on the field issued_at added by the term_X.number_of_days. Note that this suggestion does not affect the invoice’s due date, which remains the same.
To update the payment_priority of in the entity’s settings, call PATCH /entities/{entity_id}/settings, passing the new payment_priority in the body:
When a related credit note transitions from the status approve_in_progress to approved, the associated payable undergoes automatic recalculation. This ensures that the payable reflects the updated amounts and maintains consistency across related records.
The amount_with_credit_notes of the payable is recalculated using the total_amount of the credit note. After the recalculation is complete, the status of the related credit note is updated to applied.
You can attach an invoice file to an existing payable, in any status, by calling POST /payables/{payable_id}/attach_file:
The provided file is then returned in the file field on the payable object.
Notes:
You can configure the system to avoid the creation of duplicated payable based on the information obtained by the OCR.
To enable this feature, send a PATCH request to the /settings endpoint, setting the payable.allow_cancel_duplicates_automatically field to true:
This way, once the counterpart is successfully auto-linked and the OCR identifies the invoice number inside the payable, the system verifies if there is any invoice with an identical counterpart ID (counterpart_id field) and invoice number (document_id field) for the given entity. If a payable with this information is found, i.e. the payable already exists, the system automatically sends the newly created payable to the canceled status.
To ensure the automatic cancellation of duplicated payables, it is imperative to have the auto-linking feature enabled.
You can upload invoices in the PDF, PNG, or JPG format to Monite by calling POST /payables/upload_from_file. The maximum file size is 20 MB:
In return, you receive back the 201 Created response with id and other parameters:
You will also receive a webhook indicating that this payable resource has been created:
Note that at this stage the payable resource is incomplete and waiting for the results of the OCR service, which automatically scans the details from the uploaded invoice and maps the information from the invoice to the corresponding data field in the system.
When the OCR scanning is finished (this might take up to 5-7 minutes), you will receive the payable.ocr_finished webhook event:
Now, you can call GET /payables/{payable_id} to retrieve the results of the OCR scanning:
The other_extracted_data field in the response contains individual text labels and values extracted by OCR.
You can use this data to review and double-check the recognized text, but keep in mind that the structure of this object can change or even be null depending on the OCR results and various types of invoices:
Some comments about the line_items field:
unit: This can be any string that describes the units involved. It can be “m”, “h”, “items”, or anything else. It does not affect any numerical values.quantity: The number of items in float format, for example, 0.25 or 10.0. The quantity is used to calculate the total amount and subtotal of the line item and the overall payable.unit_price: The price per unit expressed in minor unit of currency. This value influences the total amount and subtotal of the line item and the overall invoice.description: The description of the line item.total_excl_vat: The total amount before taxes that equals to quantity * unit_price. It is also measured in minor units and its value is used to calculate the total amount of the line item and the overall invoice.vat_percentage: The taxes as a percentage, expressed in minor units, for example, 1900 represents 19%. This value influences the total amount of the line item and the overall invoice ( = subtotal + applying taxes).Each entity has a dedicated mailbox in Monite to which the payables can be sent. The entity or entity user can send invoices as attachments in PDF, PNG, or JPEG format to this mailbox (the maximum file size is 20 MB).
The Monite OCR service scans the information inside each email’s attachments. Then, Monite automatically creates a draft payable invoice for each occurrence found. The email of the sender of these files is saved in the field sender of the invoice.
To find the mailbox assigned to a specific entity, call GET /v1/mailboxes:
The successful response contains information about the mailbox:
By default, the automatically created mailboxes belong to the Monite domain (the web address that comes after @ in an email address), but the partners can set up their own email domain for better convenience.
In Germany, payables e-invoices can be sent via email in the ZUGFeRD format to the entity’s dedicated mailbox. Monite automatically detects if the email contains payables e-invoices by analyzing the attached files and creates the related payable objects in the system.
Uploaded payables that are already paid can be automatically recognized as such for automatic payment approval. Once the payable is recognized as paid, its status will be changed to paid or partially paid according to the this rule:
amount_paid is greater or equal to the amount_to_pay, the payable status is automatically changed to the paid status.amount_paid is greater than 0 and the value of the amount_paid is greater or equals to the amount_to_pay, the payable status is automatically changed to the partially_paid status.To enable this behavior, set the field skip_approval_for_paid_invoice to true in the partner settings:
The skip_approval_for_paid_invoice default value is false.
Every time a payable is created or updated, Monite automatically tries to link this payable to its corresponding purchase order, which is already created in the system. The conditions for the purchase order autolinking to be performed are:
Once the corresponding purchase order is found, its ID is added to the payable.purchase_order_id field. If more than one applicable purchase order is found, the most recently created is selected.
The automatic matching is enabled by default. To disable this behavior, call PATCH /entities/{entity_id}/settings, passing the field allow_purchase_order_autolinking as false in the body.
The payable can also be manually matched by calling PATCH /payables/{payable_id}, passing the purchase_order_id in the body.
The matching is performed considering these tolerance rules:
Payables that do not meet the exact or tolerance match criteria require a manual review. This process includes: