POST
/
consumers
/
{consumer_id}
/
accounting
/
financial-entries
Create a financial entry
curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/financial-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "date": "2023-12-25",
  "journal_id": "<string>",
  "currency": "<string>",
  "currency_exchange_rate": 123,
  "reference": "<string>",
  "number": "<string>",
  "items": [
    {
      "account_type": "customer_account",
      "account": "<string>",
      "amount": 123,
      "description": "<string>"
    }
  ],
  "pdf": "<string>"
}'
{
  "date": "2023-12-25",
  "journal_id": "<string>",
  "currency": "<string>",
  "currency_exchange_rate": 123,
  "reference": "<string>",
  "id": "<string>",
  "number": "<string>",
  "items": [
    {
      "account_type": "customer_account",
      "account": "<string>",
      "amount": 123,
      "description": "<string>",
      "counterpart_account": "<string>"
    }
  ]
}

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.

​
financial_counterpart_account
string | null

Number of ledger account representing bank account in accounting. Required in cases where the connector does not allow direct linking of the ledger account representing the bank account and the journal representing the bank account, making it necessary to specify it here.

Body

application/json
​
date
string<date>
required

Accounting date of the financial entry (format: YYYY-MM-DD). This is the date when the financial entry is recorded in the accounting system.

​
journal_id
string
required

Id of the journal instance in the accounting system in which the financial entry is recorded.

​
currency
string
required

Indicates the currency of the operation (e.g., EUR, USD).

​
items
FinancialEntryLineItem · object[]
required
Minimum length: 1
​
currency_exchange_rate
number | null
default:1

Indicates the exchange rate at the date of the operation. Must be filled in when creating the operation in another currency from the folder's default currency.

​
reference
string | null

Optional reference field that can be used for lettering by storing an external or contextual identifier related to the entry . For example, it can be used to store a reference number, such as the invoice number associated with the payment.

​
number
string | null

Unique 'number' of the financial entry in the accounting software. This is an internal number or identifier assigned to the financial entry. It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details.

​
pdf
string | null

Base 64 string representing the PDF attached to the sale/purchase entry.

Response

Successful Response

​
date
string<date>
required

Accounting date of the financial entry (format: YYYY-MM-DD). This is the date when the financial entry is recorded in the accounting system.

​
journal_id
string
required

Id of the journal instance in the accounting system in which the financial entry is recorded.

​
currency
string
required

Indicates the currency of the operation (e.g., EUR, USD).

​
id
string
required

Unique id of the financial entry instance in the accounting system.

​
number
string
required

Unique 'number' of the financial entry in the accounting software. This is an internal number or identifier assigned to the financial entry. It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details.

​
items
FinancialEntryLineItemOut · object[]
required
​
currency_exchange_rate
number | null
default:1

Indicates the exchange rate at the date of the operation. Must be filled in when creating the operation in another currency from the folder's default currency.

​
reference
string | null

Optional reference field that can be used for lettering by storing an external or contextual identifier related to the entry . For example, it can be used to store a reference number, such as the invoice number associated with the payment.