Monite API changelog

Stay up to date with the latest features, improvements, and breaking changes in the current version of Monite API.

November 22, 2024

Accounting integration improvements

October 31, 2024

General

Simplified bank account setup for African entities:

  • African entities can now add bank accounts with any currency.
  • Apart from currency and country, their bank accounts can include any other data fields or combinations thereof.

Accounts Payable

  • Discounts in payables. Use the discount field to specify a flat discount amount for a payable.

  • New process_id query parameter in GET /approval_policies lets you find a policy that triggered a specific approval process.

  • New webhooks related to approval policies:

    • approval_policy_process.created - triggered when an approval policy is initiated for a payable,
    • approval_policy_process.execution_error - triggered when an error occurs during the execution of an approval policy,
    • payable.multiple_approval_policies_matched - triggered when a payable matches more than one approval policy. Neither policy will be executed.

October 29, 2024

Accounts Receivable

  • Support for user-defined document numbers. In the non-compliant mode, entities can now directly specify document numbers (such as INV/2024/017) for created invoices, quotes, and credit notes instead of using auto-generated document numbers. This can be useful if the entity needs the the numbering format that is not covered by Monite’s built-in customization options.

October 23, 2024

Payments

New fields in payment intent objects:

  • payer.name
  • payer.bank_accounts[].routing_number
  • recipient.bank_accounts[].routing_number

October 21, 2024

Accounts Payable

  • Payable improvement:
  • Approval policy improvements:
    • Now you can define optional start and end dates for approval policies to accommodate seasonal changes, holidays, temporary changes in the organizational structure, and so on.
    • New connector Currency was added to the trigger parameter in MoniteScript. This connector is used to convert the amount of a payable based on a currency exchange rate. This allows you to create trigger conditions for payable amounts with different currencies.

Accounts Receivable

  • Line items of issued and overdue invoices can be updated if an entity uses the non-compliant mode.

October 4, 2024

Accounts Payable

  • Payable improvements:

    • Deleting payables. Payables in any status can now be deleted by using the new DELETE /payables/{payable_id} endpoint. Entity users need the payable.delete permission to be able to delete payables. Successful deletion of a payable triggers the payable.deleted webhook.

    • Improved search. We’ve improved search and filter parameters in GET /payables and GET /payables/analytics:

      • New search_text parameter lets you perform partial, case-insensitive search across multiple text fields of a payable at the same time. Currently it searches in counterpart names and document numbers (document_id).
      • Added the counterpart_name__contains and counterpart_name__icontains for searching by partial counterpart name in the case-sensitive and case-insensitive modes, respectively.

    • Payables have a new read-only field created_by_role_id that indicates the role of the entity user who created this payable.

    • Projects and tags can now be updated for payables in any status.

  • Purchase order improvements:

    • The entity_vat_id_id field is now optional in purchase orders and can also be unset (that is, changed to null).
    • Updated PDF templates for purchase orders. Added the “Supplier” block and updated some labels for improved clarity.

  • Approval policy improvement:

    • Projects can now be used in approval policy conditions. For this, the invoice.project_id attribute must be added to the trigger object. See an example.

Accounting integration improvements

We’ve added new endpoints to list invoices and payables (bills) that exist in the entity’s connected accounting system without pulling those documents into Monite. Monite partners can use these endpoints to implement custom document comparison and synchronization logic.

September 30, 2024

Accounts receivable document history

Monite now keeps a record of all changes made to each invoice, quote, and credit notes, from document creation to the final status. This provides entities with an overview of how a document has evolved over time. For example, entity users can see the following:

  • all revisions made to an individual invoice, quote, or credit note before it was sent to the client,
  • who made a change and when,
  • when a particular status transition occurred (for example, when a quote was signed),
  • payments made towards an invoice,
  • emails sent to the clients and the recipient email addresses,
  • and more.

To access a document’s history, use the following endpoints:

For more information, see Document history.

September 4, 2024

General

  • Projects. Users can now aggregate and track payables and receivables under the same work scope as a project via the new /projects endpoints. See more.
    • New create, read, update, and delete permissions for the project object.
    • New webhooks for the created, deleted, and updated events of projects.
    • Payables and receivables can be filtered by project via the new project_id query parameter in the GET /payables and GET /receivables endpoints.

Accounts Payable

  • Payable analytics. Use the new GET /payables/analytics endpoint to get the total number and sum total amount of all existing payables, along with the breakdown per payable status. Results can be narrowed down to a specific time period, counterpart, or other search filters. See more.
  • Find and filter payables by tags. The GET /payables endpoint has a new query parameter tag_ids to find payables that have any of the specified tags.

Accounts Receivable

We’ve added a few improvements to paid invoices:

  • Paid invoices can now be sent via email.
  • Added a new entity setting generate_paid_invoice_pdf. If it is set to true, the PDF version of paid invoices will indicate that the invoice is already paid. The PDF file gets regenerated at the moment when an invoice becomes paid. It is not issued as a separate document and the original PDF invoice is no longer available.
  • Added a new email template receivables_paid_invoice that is used when sending paid invoices. It is similar to the receivables_invoice template used for unpaid invoices but does not include the Pay invoice link.

Other

  • Added the last_updated_at field to the responses from the /mailbox_domains endpoints.

August 29, 2024

General

August 23, 2024

Accounts Receivable

  • Tags for receivables. Invoices, quotes, and credit notes can now have tags (labels) assigned to them. You can also find and filter these documents by tags by using the tag_ids__in query parameter of the GET /receivables endpoint.

  • Invoice payment date. Invoice responses include the new paid_at field that indicates the date and time when the invoice was fully paid. When using accounts receivable together with Monite payment rails, the paid_at timestamp is filled in automatically when counterparts pay invoices. If you use external payment rails, the paid_at timestamp is taken from the corresponding field provided in the POST /payment_records or POST /receivables/{invoice_id}/mark_as_paid request.

    • Added a new optional request field paid_at to POST /receivables/{invoice_id}/mark_as_paid. If omitted, it defaults to the date and time of the request.

  • Previously, recurring invoice schedules could only be extended. Now they can also be shortened - as long as the new end date is still a future date.

August 21, 2024

Accounts Receivable

  • New entity setting vat_mode controls whether new invoices and quotes use VAT-exclusive pricing (default) or VAT-inclusive pricing. This can be overridden on the document level by providing the vat_mode field when creating invoices and quotes.

August 15, 2024

General

  • Tags for counterparts. Counterparts can now have tags (labels) assigned to them. You can also find and filter counterparts by tags by using the tag_ids__in query parameter of the GET /counterparts endpoint.

Accounts Receivable

  • Support for VAT-inclusive prices. Use the vat_mode field of invoices and quotes to specify whether product prices include or exclude VAT. In case of VAT-inclusive pricing, Monite will calculate the taxable base price by subtracting the VAT rate from the product price.

    Line item data in API responses includes both VAT-inclusive and VAT-exclusive prices calculated based on the original product price and the chosen vat_mode:

    • line_items[].product.price - price before VAT
    • line_items[].product.price_after_vat - price with VAT

    Note: after an invoice or quote is created, its vat_mode cannot be changed, event in draft documents.

  • Multi-branding enhancements. We’ve expanded the ability to change entity branding information (email, logo, phone, and website) for accounts receivable documents:

    • Branding information can now be changed not only for invoices, but also for quotes and credit notes.
    • Previously, entity branding information could be changed only for existing documents via PATCH /receivables/{receivable_id}. Now you can also specify this information directly during document creation - by providing the entity object in the POST /receivables request.

August 7, 2024

Payments

  • Search and filter payment intents. Use the new GET /payment_intents endpoint to get a list of all payment intents created for an entity. Optionally, you can provide the object_id query parameter to find intents associated with a specific accounts payable or accounts receivable invoice: GET /payment_intents?object_id=INVOICE_ID.

    Among other things, this lets you:

July 31, 2024

Accounts Receivable

  • Create invoices and quotes with inline products. Entities can now specify the product details for line items—name, price, and other attributes—directly in the request payload without having to create a product catalog in advance. This is useful for one-off invoices or if the entity’s product catalog is maintained outside of the Monite platform. Invoices and quotes can also use a mix of inline and catalog products if needed.

  • Digital quote signing. Entities can now require that their customers (counterparts) provide a signature when accepting quotes. If the quote field signature_required is true, the counterpart’s representative needs to provide their name, email address, and signature image to accept the quote.

    After the quote is accepted, its PDF file is updated to display the customer signature.

    Entity setting quote_signature_required controls the signature requirement for newly created quotes. This can be changed at the quote level via the signature_required field.

Accounts Payable

  • New query parameter id__in in GET /tags to bulk fetch multiple tags by their IDs.

July 17, 2024

Accounts Payable

Accounts Receivable

  • New response fields — file_language and original_file_language — in quotes, invoices, and credit notes. These fields indicate the counterpart’s and entity’s language for the PDF, respectively.

Accounting integration

  • Removed the /accounting_sync_rules endpoints that were used to customize invoice and payable statuses to push to an accounting system.
  • New endpoints for accounting integration:
    • The /accounting_synced_records endpoints to retrieve or push records of synchronizations between Monite’s database and the entity’s accounting system.
    • The /accounting_tax_rates to get tax rate from the accounting system.

July 3, 2024

General

  • New supported country codes:
    • BL - Saint Barthélemy
    • BQ - Caribbean Netherlands
    • CW - Curaçao
    • MF - Saint Martin (French part)
    • SX - Sint Maarten (Dutch part)
  • Entity field address.state is now required for US entities that wish to use Monite payment rails.

Accounts Payable

  • Payable OCR auto-tagging. Entities have a new setting payables_ocr_auto_tagging to specify the tags that will be automatically assigned to new payables created via OCR. For details, see Tags auto-assignment.
  • New paid_at field was added to the payable responses. It contains the date and time when the payable was moved to the paid status.

Accounts Receivable

  • Invoicing across multiple brands. Entities that have multiple brands can specify the business email, logo, phone, and website to be displayed on each invoice, if these values need to be different from the entity’s defaults. The data can be provided in the invoice.entity object in the invoice update request, for example:

    PATCH /receivables/{invoice_id}
    {
      "invoice": {
        "entity": {
          "website": "https://example.com",
          "logo": "https://example.com/another-logo.png"
        }
      }
    }

  • More flexible reminder configuration. Invoice payment reminders and overdue reminders can now be initially created without any terms, and the terms can be added any time later prior to issuing the invoice.

  • Email localization improvements:

    • The language field in POST /receivables/{receivable_id}/send requests has been deprecated. Instead, use the counterpart’s language field to specify the preferred language for emails and documents that will be sent to that counterpart.
    • Also, if the language parameter is omitted in /send requests, the email language now defaults to the counterpart language instead of English.

  • Partner metadata can now also be updated for non-draft invoices, quotes, and credit notes.

June 19, 2024

  • CC and BCC in receivables email. Added the ability to include a list of email addresses using the recipients field in the payload the /receivables/{receivable_id}/send and /receivables/{receivable_id}/send_test_reminder endpoints. Using this field, entities can include email addresses to which they want to send a copy or a blind copy of the email.
  • Displaying company trade name in documents. Invoices, quotes, and credit notes have the new trade_name field that entities can use to specify their trade name, also known as “doing business as” (DBA) or “operating as” (o/a) name. The assigned trade name will appear alongside the entity’s legal name in PDF invoices, quotes, and credit notes created by the entity.
  • Enhanced sorting of receivables. The GET /receivables endpoint has got additional options for the sort parameter. You can now also sort receivables by the created_at, document_id, due_date, or issue_date values.
  • The measure_unit_id field is no longer required to create products for receivables.
  • New id__in query parameter on the GET /products and GET /receivables endpoints lets you bulk fetch multiple products or receivables by their IDs.

June 5, 2024

  • New name__in query parameter in GET /tags.
  • Payable tags have two new optional fields: category and description.
  • Partner setting payable.enable_line_items has been deprecated.

May 22, 2024

  • Automatic matching of purchase orders with payables. 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. For such cases, the field purchase_order_id was added to the payable object. To configure this behavior, the field allow_purchase_order_autolinking (default value equals to true) was added to the entity settings.
  • Added a new original_file_url field in responses for invoices, quotes, and credit notes that returns the receivables PDF in the entity’s language. The field was also added to the response of the GET /receivables/{receivable_id}/pdf_link endpoint.

May 8, 2024

  • Document number customization. We added the ability to customize the document numbers for all document types. This customization is done directly via entity settings. For more information, see Document number customization.

April 11, 2024

  • Payment intents can now transition to the refunded status from the payout_failed and payout_cancelled statuses.

April 2, 2024

  • Searching payables by invoice number. GET /payables has new optional query parameters to search and filter Accounts Payable invoices (payables) by their invoice number: document_id__contains (case-sensitive “contains”), document_id__icontains (case-insensitive “contains”).
  • Customizing the required fields for payables. You can now control which fields must be filled in a draft payable before it can transition to the new status. The following endpoints were added for this purpose:
  • Testing reminders for a specific invoice. Use the new endpoint POST /receivables/{receivable_id}/send_test_reminder to send test email reminders (payment reminders or overdue reminders) for a specific Accounts Receivable invoice. For more information, see Manually trigger payment reminders.
  • Verifying invoice reminder configuration. The response from POST /receivables/{receivable_id}/verify contains the new warnings.payment_reminders field that indicates issues with payment reminders configured for the specified invoice. Misconfigured reminders do not block the ability to issue the invoice, but can result in reminders not being sent. Users are advised to fix the reminder configuration issues before issuing invoices.
  • GET /vat_rates has a new optional query parameter counterpart_address_id to filter the applicable VAT rates based on the specified counterpart address in case the counterpart has several addresses.
  • Updated the supported country codes:
    • Replaced CS (Serbia and Montenegro) with ME (Montenegro) and RS (Serbia).
    • Added SS (South Sudan)

March 18, 2024

API version 2024-01-31 is now publicly available to all Monite partners to use in beta. To start using this version:

  1. Change the api_version setting in your partner settings (/settings) to 2024-01-31:

    1curl -X PATCH 'https://api.sandbox.monite.com/v1/settings' \
    2     -H 'X-Monite-Version: 2024-01-31' \
    3     -H 'Authorization: Bearer YOURT_PARTNER_TOKEN' \
    4     -H 'Content-Type: application/json' \
    5     -d '{"api_version": "2024-01-31"}'

  2. Change the X-Monite-Version header value in all API calls to 2024-01-31. For example:

    1curl -X GET 'https://api.sandbox.monite.com/v1/entities' \
    2     -H 'X-Monite-Version: 2024-01-31' \
    3     -H 'Authorization: Bearer ACCESS_TOKEN'

For more information, see How to upgrade.