Invoice payment reminders
Learn how to automatically send payment reminders to customers before the invoice due dates and early discount dates.
Overview
Monite automatically sends payment reminders as emails to entity's customers one day before the invoice due dates and early discount dates. The reminders are sent for all issued unpaid invoices. However, no reminders are sent for overdue invoices.
Reminders come from the [email protected]<entity_name>.monite.com
address (currently not customizable).
Create a payment reminder set
To create a new payment reminder set, call POST /payment_reminders
. The value set for days_before
represents the number of days before the payment due date to send reminder notifications to my counterparts.:
curl -X POST 'https://api.sandbox.monite.com/v1/payment_reminders' \
-H 'X-Monite-Entity-Id: ENTITY_ID' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-d '{
"name": "My payment reminder set",
"term_1_reminder": {
"days_before": 15,
"body": "... HTML content of the reminder email ...",
"subject": "Subject of the reminder email"
},
"term_2_reminder": {
"days_before": 10,
"body": "... HTML content of the reminder email ...",
"subject": "Subject of the reminder email"
},
"term_final_reminder": {
"days_before": 5,
"body": "... HTML content of the reminder ...",
"subject": "Subject of the reminder email"
}
}'
The successful response contains information about the recently created payment reminder set:
{
"name": "My payment reminder set",
"term_1_reminder": {
"days_before": 15,
"body": "... HTML content of the reminder ...",
"subject": "Subject of the reminder email"
},
"term_2_reminder": {
"days_before": 10,
"body": "... HTML content of the reminder ...",
"subject": "Subject of the reminder email"
},
"term_final_reminder": {
"days_before": 5,
"body": "... HTML content of the reminder ...",
"subject": "Subject of the reminder email"
},
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "active",
"created_at": "2022-12-27T13:54:07.131Z",
"updated_at": "2022-12-27T13:54:07.131Z"
}
Enable or disable payment reminders
For specific counterparts
By default, payment reminders are enabled for all counterparts of an entity.
If you want to disable reminders for specific counterparts, such as customers who always pay on time, call PATCH /entities/{entity_id}/settings
and provide in the body the counterpart IDs in the reminder.excluded_counterparts
list:
curl -X PATCH 'https://api.sandbox.monite.com/v1/entities/692b50...609da8/settings' \
-H 'Authorization: Bearer YOUR_PARTNER_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"reminder": {
"excluded_counterpart_ids": [
"6291decf-1801-4145-a746-6270fa473699",
"244574de-51af-42a2-8e0f-14c1f1316356"
]
}
}'
The
excluded_counterparts
list sent in thePATCH /entities/{entity_id}/settings
request replaces the previous list, rather than being appended to it.
To append items to this list, callGET /entities/{entity_id}/settings
to get the currentexcluded_counterparts
list, then modify this list, and send the modified list back.
For all counterparts
To disable reminders for all counterparts of a specific entity, call PATCH /entities/{entity_id}/settings
and change the reminder.enabled
field to false
.
curl -X PATCH 'https://api.sandbox.monite.com/v1/entities/692b50...09da8/settings' \
-H 'Authorization: Bearer YOUR_PARTNER_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"reminder": {
"enabled": false
}
}'
To enable reminders again, change the reminder.enabled
field back to true
.
Updated about 1 month ago