Import a complete credit note
curl --request POST \
--url https://api.leanpay.fr/v1/public/credit-notes/complete \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"reference": "<string>",
"client": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"amount": 1,
"issueDate": "2023-12-25",
"currency": "<string>",
"externalId": "<string>",
"dueDate": "2023-12-25",
"defaultCurrencyAmount": 1,
"paybacks": [
{
"date": "2023-12-25",
"amount": 1,
"externalId": "<string>"
}
],
"invoiceLinks": [
{
"date": "2023-12-25",
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"amount": 1,
"externalId": "<string>"
}
]
}
'import requests
url = "https://api.leanpay.fr/v1/public/credit-notes/complete"
payload = {
"reference": "<string>",
"client": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
"amount": 1,
"issueDate": "2023-12-25",
"currency": "<string>",
"externalId": "<string>",
"dueDate": "2023-12-25",
"defaultCurrencyAmount": 1,
"paybacks": [
{
"date": "2023-12-25",
"amount": 1,
"externalId": "<string>"
}
],
"invoiceLinks": [
{
"date": "2023-12-25",
"invoice": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
"amount": 1,
"externalId": "<string>"
}
]
}
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({
reference: '<string>',
client: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
amount: 1,
issueDate: '2023-12-25',
currency: '<string>',
externalId: '<string>',
dueDate: '2023-12-25',
defaultCurrencyAmount: 1,
paybacks: [{date: '2023-12-25', amount: 1, externalId: '<string>'}],
invoiceLinks: [
{
date: '2023-12-25',
invoice: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
amount: 1,
externalId: '<string>'
}
]
})
};
fetch('https://api.leanpay.fr/v1/public/credit-notes/complete', 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/credit-notes/complete",
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([
'reference' => '<string>',
'client' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'amount' => 1,
'issueDate' => '2023-12-25',
'currency' => '<string>',
'externalId' => '<string>',
'dueDate' => '2023-12-25',
'defaultCurrencyAmount' => 1,
'paybacks' => [
[
'date' => '2023-12-25',
'amount' => 1,
'externalId' => '<string>'
]
],
'invoiceLinks' => [
[
'date' => '2023-12-25',
'invoice' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'amount' => 1,
'externalId' => '<string>'
]
]
]),
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/credit-notes/complete"
payload := strings.NewReader("{\n \"reference\": \"<string>\",\n \"client\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"defaultCurrencyAmount\": 1,\n \"paybacks\": [\n {\n \"date\": \"2023-12-25\",\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ],\n \"invoiceLinks\": [\n {\n \"date\": \"2023-12-25\",\n \"invoice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ]\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/credit-notes/complete")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"<string>\",\n \"client\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"defaultCurrencyAmount\": 1,\n \"paybacks\": [\n {\n \"date\": \"2023-12-25\",\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ],\n \"invoiceLinks\": [\n {\n \"date\": \"2023-12-25\",\n \"invoice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.leanpay.fr/v1/public/credit-notes/complete")
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 \"reference\": \"<string>\",\n \"client\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"defaultCurrencyAmount\": 1,\n \"paybacks\": [\n {\n \"date\": \"2023-12-25\",\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ],\n \"invoiceLinks\": [\n {\n \"date\": \"2023-12-25\",\n \"invoice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ]\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,
"paybackAmount": 123,
"deductedAmount": 123,
"issueDate": "2023-11-07T05:31:56Z",
"paybacks": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 1,
"defaultCurrencyAmount": 1,
"externalId": "<string>"
}
],
"invoiceLinks": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 1,
"defaultCurrencyAmount": 1,
"externalId": "<string>",
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}credit-notes
Import a complete credit note
POST
/
credit-notes
/
complete
Import a complete credit note
curl --request POST \
--url https://api.leanpay.fr/v1/public/credit-notes/complete \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"reference": "<string>",
"client": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"amount": 1,
"issueDate": "2023-12-25",
"currency": "<string>",
"externalId": "<string>",
"dueDate": "2023-12-25",
"defaultCurrencyAmount": 1,
"paybacks": [
{
"date": "2023-12-25",
"amount": 1,
"externalId": "<string>"
}
],
"invoiceLinks": [
{
"date": "2023-12-25",
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"amount": 1,
"externalId": "<string>"
}
]
}
'import requests
url = "https://api.leanpay.fr/v1/public/credit-notes/complete"
payload = {
"reference": "<string>",
"client": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
"amount": 1,
"issueDate": "2023-12-25",
"currency": "<string>",
"externalId": "<string>",
"dueDate": "2023-12-25",
"defaultCurrencyAmount": 1,
"paybacks": [
{
"date": "2023-12-25",
"amount": 1,
"externalId": "<string>"
}
],
"invoiceLinks": [
{
"date": "2023-12-25",
"invoice": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
"amount": 1,
"externalId": "<string>"
}
]
}
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({
reference: '<string>',
client: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
amount: 1,
issueDate: '2023-12-25',
currency: '<string>',
externalId: '<string>',
dueDate: '2023-12-25',
defaultCurrencyAmount: 1,
paybacks: [{date: '2023-12-25', amount: 1, externalId: '<string>'}],
invoiceLinks: [
{
date: '2023-12-25',
invoice: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
amount: 1,
externalId: '<string>'
}
]
})
};
fetch('https://api.leanpay.fr/v1/public/credit-notes/complete', 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/credit-notes/complete",
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([
'reference' => '<string>',
'client' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'amount' => 1,
'issueDate' => '2023-12-25',
'currency' => '<string>',
'externalId' => '<string>',
'dueDate' => '2023-12-25',
'defaultCurrencyAmount' => 1,
'paybacks' => [
[
'date' => '2023-12-25',
'amount' => 1,
'externalId' => '<string>'
]
],
'invoiceLinks' => [
[
'date' => '2023-12-25',
'invoice' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'amount' => 1,
'externalId' => '<string>'
]
]
]),
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/credit-notes/complete"
payload := strings.NewReader("{\n \"reference\": \"<string>\",\n \"client\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"defaultCurrencyAmount\": 1,\n \"paybacks\": [\n {\n \"date\": \"2023-12-25\",\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ],\n \"invoiceLinks\": [\n {\n \"date\": \"2023-12-25\",\n \"invoice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ]\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/credit-notes/complete")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"<string>\",\n \"client\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"defaultCurrencyAmount\": 1,\n \"paybacks\": [\n {\n \"date\": \"2023-12-25\",\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ],\n \"invoiceLinks\": [\n {\n \"date\": \"2023-12-25\",\n \"invoice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.leanpay.fr/v1/public/credit-notes/complete")
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 \"reference\": \"<string>\",\n \"client\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"issueDate\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"defaultCurrencyAmount\": 1,\n \"paybacks\": [\n {\n \"date\": \"2023-12-25\",\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ],\n \"invoiceLinks\": [\n {\n \"date\": \"2023-12-25\",\n \"invoice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"amount\": 1,\n \"externalId\": \"<string>\"\n }\n ]\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,
"paybackAmount": 123,
"deductedAmount": 123,
"issueDate": "2023-11-07T05:31:56Z",
"paybacks": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 1,
"defaultCurrencyAmount": 1,
"externalId": "<string>"
}
],
"invoiceLinks": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 1,
"defaultCurrencyAmount": 1,
"externalId": "<string>",
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Authorizations
Body
application/json
Complete credit note object to import
Maximum string length:
80- Option 1
- Option 2
Show child attributes
Show child attributes
Required range:
x >= 0Maximum string length:
80Required range:
x >= 0- Option 1
- Option 2
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Returns the imported credit note
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Credit note status
Available options:
available, deducted, disputed, recovery ⌘I
