Skip to main content
POST
/
consumers
/
{consumer_id}
/
accounting
/
journal
Create journal
curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/journal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "<string>",
  "name": "<string>",
  "journal_type": "customer_invoice",
  "counterpart_account": "<string>"
}'
{
  "id": "<string>",
  "code": "<string>",
  "name": "<string>",
  "journal_type": "customer_invoice",
  "counterpart_account": "<string>",
  "next_document_numbers": [
    {
      "bookyear_name": "<string>",
      "next_document_number": "<string>",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25"
    }
  ],
  "iban": "<string>",
  "currency": "<string>",
  "other_currencies_allowed": true
}

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
​
code
string
required

Short code or identifier of the journal (e.g., 'BNK', 'INV').

Minimum length: 2
​
name
string
required

Name or label of the journal as it appears in the accounting system.

Minimum length: 1
​
journal_type
enum<string>
required

Type of journal.

Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund,
bank,
cash,
miscellaneous_operation
​
counterpart_account
string | null

When journal is of type bank or cash, this is account number of the counterpart account used for the journal.

Response

Successful Response

​
id
string
required
​
name
string
required
​
journal_type
enum<string>
required
Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund,
financial_operation,
miscellaneous_operation,
unknown
​
code
string | null
​
counterpart_account
string | null

When journal is of type bank or cash, this is account number of the counterpart account used for the journal.

​
next_document_numbers
NextDocumentNumber · object[] | null
​
iban
string | null

When the journal is of type bank, IBAN of the bank account linked to the journal

​
currency
string | null

Currency of the journal (e.g., EUR). If empty, the journal follows the currency of the accounting folder.

​
other_currencies_allowed
boolean | null
default:true

Indicates if the journal allows other currencies. If it doesn't allow other currencies an exchange rate must be provided for Chift to convert the amounts to the journal currency. This only applicable if the journal currency is the same as the accounting folder currency.