curl --request POST \
--url https://thirdparty.qonto.com/v2/reminders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_id": "5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11",
"send_to": [
"accounting@acme.com"
],
"rules": [
{
"email_title": "Reminder: invoice due in 7 days",
"offset_days": 7,
"email_body": "Your invoice is due in 7 days."
}
],
"copy_to_self": false
}
'import requests
url = "https://thirdparty.qonto.com/v2/reminders"
payload = {
"client_id": "5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11",
"send_to": ["accounting@acme.com"],
"rules": [
{
"email_title": "Reminder: invoice due in 7 days",
"offset_days": 7,
"email_body": "Your invoice is due in 7 days."
}
],
"copy_to_self": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
client_id: '5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11',
send_to: ['accounting@acme.com'],
rules: [
{
email_title: 'Reminder: invoice due in 7 days',
offset_days: 7,
email_body: 'Your invoice is due in 7 days.'
}
],
copy_to_self: false
})
};
fetch('https://thirdparty.qonto.com/v2/reminders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://thirdparty.qonto.com/v2/reminders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client_id' => '5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11',
'send_to' => [
'accounting@acme.com'
],
'rules' => [
[
'email_title' => 'Reminder: invoice due in 7 days',
'offset_days' => 7,
'email_body' => 'Your invoice is due in 7 days.'
]
],
'copy_to_self' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://thirdparty.qonto.com/v2/reminders"
payload := strings.NewReader("{\n \"client_id\": \"5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11\",\n \"send_to\": [\n \"accounting@acme.com\"\n ],\n \"rules\": [\n {\n \"email_title\": \"Reminder: invoice due in 7 days\",\n \"offset_days\": 7,\n \"email_body\": \"Your invoice is due in 7 days.\"\n }\n ],\n \"copy_to_self\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://thirdparty.qonto.com/v2/reminders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11\",\n \"send_to\": [\n \"accounting@acme.com\"\n ],\n \"rules\": [\n {\n \"email_title\": \"Reminder: invoice due in 7 days\",\n \"offset_days\": 7,\n \"email_body\": \"Your invoice is due in 7 days.\"\n }\n ],\n \"copy_to_self\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://thirdparty.qonto.com/v2/reminders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11\",\n \"send_to\": [\n \"accounting@acme.com\"\n ],\n \"rules\": [\n {\n \"email_title\": \"Reminder: invoice due in 7 days\",\n \"offset_days\": 7,\n \"email_body\": \"Your invoice is due in 7 days.\"\n }\n ],\n \"copy_to_self\": false\n}"
response = http.request(request)
puts response.read_body{
"reminder": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"send_to": [
"jsmith@example.com"
],
"copy_to_self": true,
"rules": [
{
"email_title": "<string>",
"offset_days": 500,
"email_body": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Configure payment reminders for a client
OAuth scope: client_invoice.write
Configures the automated payment reminders Qonto sends for a client’s unpaid invoices. Every rule is anchored on the invoice due date.
A client holds at most one reminder configuration. Calling this endpoint again for the same client replaces the existing one: send_to, copy_to_self and the entire rules array are overwritten, and the previous rules are discarded. Read the current configuration first if you only mean to change part of it.
Price plans: this endpoint requires the Invoice Automation add-on. Removing the add-on deletes the reminder configuration of every client in the organization, and it cannot be recovered — it has to be created again.
A 404 response means the reminder could not be read back for your organization after being written.
curl --request POST \
--url https://thirdparty.qonto.com/v2/reminders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_id": "5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11",
"send_to": [
"accounting@acme.com"
],
"rules": [
{
"email_title": "Reminder: invoice due in 7 days",
"offset_days": 7,
"email_body": "Your invoice is due in 7 days."
}
],
"copy_to_self": false
}
'import requests
url = "https://thirdparty.qonto.com/v2/reminders"
payload = {
"client_id": "5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11",
"send_to": ["accounting@acme.com"],
"rules": [
{
"email_title": "Reminder: invoice due in 7 days",
"offset_days": 7,
"email_body": "Your invoice is due in 7 days."
}
],
"copy_to_self": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
client_id: '5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11',
send_to: ['accounting@acme.com'],
rules: [
{
email_title: 'Reminder: invoice due in 7 days',
offset_days: 7,
email_body: 'Your invoice is due in 7 days.'
}
],
copy_to_self: false
})
};
fetch('https://thirdparty.qonto.com/v2/reminders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://thirdparty.qonto.com/v2/reminders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client_id' => '5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11',
'send_to' => [
'accounting@acme.com'
],
'rules' => [
[
'email_title' => 'Reminder: invoice due in 7 days',
'offset_days' => 7,
'email_body' => 'Your invoice is due in 7 days.'
]
],
'copy_to_self' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://thirdparty.qonto.com/v2/reminders"
payload := strings.NewReader("{\n \"client_id\": \"5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11\",\n \"send_to\": [\n \"accounting@acme.com\"\n ],\n \"rules\": [\n {\n \"email_title\": \"Reminder: invoice due in 7 days\",\n \"offset_days\": 7,\n \"email_body\": \"Your invoice is due in 7 days.\"\n }\n ],\n \"copy_to_self\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://thirdparty.qonto.com/v2/reminders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11\",\n \"send_to\": [\n \"accounting@acme.com\"\n ],\n \"rules\": [\n {\n \"email_title\": \"Reminder: invoice due in 7 days\",\n \"offset_days\": 7,\n \"email_body\": \"Your invoice is due in 7 days.\"\n }\n ],\n \"copy_to_self\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://thirdparty.qonto.com/v2/reminders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11\",\n \"send_to\": [\n \"accounting@acme.com\"\n ],\n \"rules\": [\n {\n \"email_title\": \"Reminder: invoice due in 7 days\",\n \"offset_days\": 7,\n \"email_body\": \"Your invoice is due in 7 days.\"\n }\n ],\n \"copy_to_self\": false\n}"
response = http.request(request)
puts response.read_body{
"reminder": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"send_to": [
"jsmith@example.com"
],
"copy_to_self": true,
"rules": [
{
"email_title": "<string>",
"offset_days": 500,
"email_body": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.
Headers
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Body
offset_days is required when operator is before or after. Ignored when operator is on.
The client the reminders are configured for.
"5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11"
The email addresses the reminders are sent to.
1["accounting@acme.com"]
The reminder schedule. Between 1 and 5 rules, each anchored on the invoice due date.
1 - 5 elementsShow child attributes
Show child attributes
Whether a copy of each reminder is also sent to your organization's contact email.
Response
Returns the reminder configuration created or replaced.
Show child attributes
Show child attributes
Was this page helpful?