Import an invoice
curl --request POST \
--url https://api.leanpay.fr/v1/public/invoices \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"amount": 1,
"netAmount": 1,
"issueDate": "2023-12-25",
"dueDate": "2023-12-25",
"externalId": "<string>",
"sentDate": "2023-12-25"
}
'import requests
url = "https://api.leanpay.fr/v1/public/invoices"
payload = {
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"amount": 1,
"netAmount": 1,
"issueDate": "2023-12-25",
"dueDate": "2023-12-25",
"externalId": "<string>",
"sentDate": "2023-12-25"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
reference: '<string>',
amount: 1,
netAmount: 1,
issueDate: '2023-12-25',
dueDate: '2023-12-25',
externalId: '<string>',
sentDate: '2023-12-25'
})
};
fetch('https://api.leanpay.fr/v1/public/invoices', 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://api.leanpay.fr/v1/public/invoices",
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([
'clientId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'reference' => '<string>',
'amount' => 1,
'netAmount' => 1,
'issueDate' => '2023-12-25',
'dueDate' => '2023-12-25',
'externalId' => '<string>',
'sentDate' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.leanpay.fr/v1/public/invoices"
payload := strings.NewReader("{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reference\": \"<string>\",\n \"amount\": 1,\n \"netAmount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"sentDate\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.leanpay.fr/v1/public/invoices")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reference\": \"<string>\",\n \"amount\": 1,\n \"netAmount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"sentDate\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.leanpay.fr/v1/public/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reference\": \"<string>\",\n \"amount\": 1,\n \"netAmount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"sentDate\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"reference": "<string>",
"amount": 123,
"remainingAmount": 123,
"paidAmount": 123,
"offsetAmount": 123,
"sentDate": "2023-11-07T05:31:56Z",
"issueDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"upcomingPaymentDate": "2023-11-07T05:31:56Z",
"dueDates": [
{
"dueDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"amount": 1,
"defaultCurrencyAmount": 1
}
],
"payments": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 1,
"defaultCurrencyAmount": 1,
"externalId": "<string>"
}
],
"creditNoteLinks": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 1,
"defaultCurrencyAmount": 1,
"externalId": "<string>",
"creditNote": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}invoices
Import an invoice
POST
/
invoices
Import an invoice
curl --request POST \
--url https://api.leanpay.fr/v1/public/invoices \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"amount": 1,
"netAmount": 1,
"issueDate": "2023-12-25",
"dueDate": "2023-12-25",
"externalId": "<string>",
"sentDate": "2023-12-25"
}
'import requests
url = "https://api.leanpay.fr/v1/public/invoices"
payload = {
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"amount": 1,
"netAmount": 1,
"issueDate": "2023-12-25",
"dueDate": "2023-12-25",
"externalId": "<string>",
"sentDate": "2023-12-25"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
reference: '<string>',
amount: 1,
netAmount: 1,
issueDate: '2023-12-25',
dueDate: '2023-12-25',
externalId: '<string>',
sentDate: '2023-12-25'
})
};
fetch('https://api.leanpay.fr/v1/public/invoices', 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://api.leanpay.fr/v1/public/invoices",
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([
'clientId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'reference' => '<string>',
'amount' => 1,
'netAmount' => 1,
'issueDate' => '2023-12-25',
'dueDate' => '2023-12-25',
'externalId' => '<string>',
'sentDate' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.leanpay.fr/v1/public/invoices"
payload := strings.NewReader("{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reference\": \"<string>\",\n \"amount\": 1,\n \"netAmount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"sentDate\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.leanpay.fr/v1/public/invoices")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reference\": \"<string>\",\n \"amount\": 1,\n \"netAmount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"sentDate\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.leanpay.fr/v1/public/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reference\": \"<string>\",\n \"amount\": 1,\n \"netAmount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"sentDate\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"reference": "<string>",
"amount": 123,
"remainingAmount": 123,
"paidAmount": 123,
"offsetAmount": 123,
"sentDate": "2023-11-07T05:31:56Z",
"issueDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"upcomingPaymentDate": "2023-11-07T05:31:56Z",
"dueDates": [
{
"dueDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"amount": 1,
"defaultCurrencyAmount": 1
}
],
"payments": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 1,
"defaultCurrencyAmount": 1,
"externalId": "<string>"
}
],
"creditNoteLinks": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 1,
"defaultCurrencyAmount": 1,
"externalId": "<string>",
"creditNote": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Authorizations
Body
application/json
Invoice object to import
Maximum string length:
80Required range:
x >= 0Required range:
x >= 0Maximum string length:
80use issueDate instead
Response
Returns the imported invoice
use issueDate instead
Invoice status
Available options:
due, overdue, paid, disputed, offset, payment_in_progress, upcoming_payment, recovery Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
