Skip to main content
POST
/
consumers
/
{consumer_id}
/
accounting
/
invoices
/
payments
Create an invoice payment
curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/invoices/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2023-12-25",
  "payment_method_id": "<string>",
  "currency": "<string>",
  "items": [
    {
      "invoice_id": "<string>",
      "amount": 123
    }
  ],
  "currency_exchange_rate": 1,
  "reference": "<string>",
  "number": "<string>"
}
'
{
  "message": "Error while trying to perform your request",
  "status": "error"
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
folder_id
string | null

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

Body

application/json
​
date
string<date>
required

The date of the payment

​
payment_method_id
string
required

Technical ID of the payment method in the accounting system.

​
currency
string
required

Payment currency

​
items
AccountingInvoicePaymentItemIn · object[]
required

Payment's repartition

​
currency_exchange_rate
number | null
default:1

Exchange rate applicable at the payment date. Required when the currency is different from the system's currency.

​
reference
string | null

External reference of the payment.

​
number
string | null

Unique Payment number (if managed by the software).

Response

Successful Response