Skip to main content
POST
/
credit-notes
/
batch
Import credit notes (max 100)
curl --request POST \
  --url https://api.leanpay.fr/v1/public/credit-notes/batch \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "creditNotes": [
    {
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reference": "<string>",
      "amount": 1,
      "netAmount": 1,
      "issueDate": "2023-12-25",
      "dueDate": "2023-12-25",
      "externalId": "<string>"
    }
  ]
}
'
{
  "data": [
    {
      "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>"
          }
        }
      ],
      "status": "available",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Body

application/json

Credit notes objects to import

creditNotes
object[]
Maximum array length: 100

Response

Returns the imported credit notes

data
object[]