Variables

Overview

Variables are named placeholders in strings that are later replaced with actual values. For example, if you want to add an invoice note addressing the counterpart (customer) personally, you can use the {company_name} variable in the note text and Monite will automatically substitute it with the counterpart name associated with that invoice.

Variables can be used in:

• the memo field of Accounts Receivable documents (invoices, quotes, credit notes),
• email templates
• the email subject and body when sending documents via email by using the following endpoints:
  • POST /receivables/{receivable_id}/send
  • POST /payable_purchase_orders/{purchase_order_id}/send
• text templates,

Specifics of using variables in memo fields

Variables inserted into the memo text of invoices, quotes, or credit notes are immediately substituted with their values. That is, the replacement happens immediately during the document creation (POST) or update (PATCH), rather than later when the document gets issued.

Keep this in mind when repeatedly updating draft documents, as the memo text with earlier substitutions might no longer reflect the current values of the variables.

curl -X PATCH 'https://api.sandbox.monite.com/v1/receivables/4ba6...03178f' \
     -H 'X-Monite-Version: 2023-06-04' \
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -d '{
       "invoice": {
         "memo": "Thanks for doing business with us, {company_name}!"
       }
     }'

{
  "type": "invoice",
  "id": "4ba6c23b-44a6-459f-9211-c45c7d03178f",
  ...
  "memo": "Thanks for doing business with us, Trustwave!"
}

Variable list

A list of available variables is provided below for convenience.

To get the available variable names programmatically, you can call GET /text_templates/variables. In the response, the variables are grouped by their object_type and subtype:

{
    "data": [
        {
            "object_type": "receivable",
            "object_subtype": "quote",
            "variables": [
                {
                    "name": "fulfillment_date",
                    "description": ""
                },
                ...
            ]
        },
        {
            "object_type": "receivable",
            "object_subtype": "invoice",
            "variables": [
                {
                    "name": "amount_due",
                    "description": ""
                },
                ...
            ]
        },
        {
            "object_type": "receivable",
            "object_subtype": "credit_note",
            "variables": [
                {
                    "name": "amount_due",
                    "description": ""
                },
                ...
            ]
        },
        {
            "object_type": "reminder",
            "object_subtype": "discount_reminder",
            "variables": [
                {
                    "name": "amount_due",
                    "description": ""
                },
                ...
            ]
        },
        {
            "object_type": "reminder",
            "object_subtype": "final_reminder",
            "variables": [
                {
                    "name": "amount_due",
                    "description": ""
                },
                ...
            ]
        },
        {
            "object_type": "reminder",
            "object_subtype": "overdue_reminder",
            "variables": [
                {
                    "name": "amount_due",
                    "description": ""
                },
                ...
            ]
        },
        {
            "object_type": "payable",
            "object_subtype": "payables_purchase_order",
            "variables": [
                {
                    "name": "company_email",
                    "description": ""
                },
                ...
            ]
        }
    ]
}

Possible object_type and subtype values are:

Common variables

These variables are defined for all document types:

Additional variables for invoices

In addition to the common variables, outgoing invoices can use these variables:

Additional variables for quotes

In addition to the common variables, quotes can use these variables:

Additional variables for credit notes

In addition to the common variables, credit notes can use these variables:

Additional variables for purchase orders

In addition to the common variables, purchase orders can use these variables:

Additional variables for invoice reminders

Payment reminders

In addition to the common variables, invoice payment reminders can include the following variables in their email subject and body.

📘

In the response from GET /text_templates/variables, these variables are grouped under object_type= "discount_reminder" and "final_reminder".

Overdue reminders

In addition to the common variables, overdue reminders can include the following variables in their email subject and body: