Skip to main content
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"
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.leanpay.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Body

application/json

Invoice object to import

​
clientId
string<uuid>
required
​
reference
string
required
Maximum string length: 80
​
amount
integer
required
Required range: x >= 0
​
netAmount
integer
required
Required range: x >= 0
​
issueDate
string<date>
required
​
dueDate
string<date>
required
​
externalId
string | null
Maximum string length: 80
​
sentDate
string<date>
deprecated

use issueDate instead

Response

Returns the imported invoice

​
id
string<uuid>
​
tenantId
string<uuid>
​
clientId
string<uuid>
​
externalId
string | null
​
reference
string
​
amount
integer
​
remainingAmount
integer
​
paidAmount
integer
​
offsetAmount
integer
​
sentDate
string<date-time>
deprecated

use issueDate instead

​
issueDate
string<date-time>
​
dueDate
string<date-time>
​
status
enum<string>

Invoice status

Available options:
due,
overdue,
paid,
disputed,
offset,
payment_in_progress,
upcoming_payment,
recovery
​
upcomingPaymentDate
string<date-time> | null
​
dueDates
object[]
​
payments
object[]
​
creditNoteLinks
object[]
​
createdAt
string<date-time>
​
updatedAt
string<date-time>