Create Journal Entry

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries \
  --header 'Content-Type: application/json' \
  --data '
{
  "journal_id": "<accounting-journal-id>",
  "number": "JE-2026-0001",
  "currency": "EUR",
  "date": "2026-01-15",
  "items": [
    {
      "debit": 242,
      "credit": 0,
      "account": "<accounting-account-number>",
      "force_general_account": "<accounting-account-number>",
      "prioritise_thirdparty_account": false,
      "description": "Consulting services",
      "analytic_distribution": [],
      "tax_code": "<accounting-tax-code>",
      "tax_info": {
        "tax_code": "<accounting-tax-code>",
        "tax_amount": 42,
        "vat_account": "<accounting-account-number>",
        "reversed_vat_account": "<accounting-account-number>",
        "description": "VAT 21%"
      },
      "account_info": {
        "account_number": "<accounting-account-number>",
        "account_name": "Consulting services"
      }
    }
  ],
  "reference": "JE-REF-0001",
  "due_date": "2026-02-14",
  "currency_exchange_rate": 1,
  "pdf": "<string>",
  "pdf_name": "<string>",
  "posted": true,
  "start_date": "2023-12-25",
  "end_date": "2023-12-25"
}
'

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries"

payload = {
    "journal_id": "<accounting-journal-id>",
    "number": "JE-2026-0001",
    "currency": "EUR",
    "date": "2026-01-15",
    "items": [
        {
            "debit": 242,
            "credit": 0,
            "account": "<accounting-account-number>",
            "force_general_account": "<accounting-account-number>",
            "prioritise_thirdparty_account": False,
            "description": "Consulting services",
            "analytic_distribution": [],
            "tax_code": "<accounting-tax-code>",
            "tax_info": {
                "tax_code": "<accounting-tax-code>",
                "tax_amount": 42,
                "vat_account": "<accounting-account-number>",
                "reversed_vat_account": "<accounting-account-number>",
                "description": "VAT 21%"
            },
            "account_info": {
                "account_number": "<accounting-account-number>",
                "account_name": "Consulting services"
            }
        }
    ],
    "reference": "JE-REF-0001",
    "due_date": "2026-02-14",
    "currency_exchange_rate": 1,
    "pdf": "<string>",
    "pdf_name": "<string>",
    "posted": True,
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    journal_id: '<accounting-journal-id>',
    number: 'JE-2026-0001',
    currency: 'EUR',
    date: '2026-01-15',
    items: [
      {
        debit: 242,
        credit: 0,
        account: '<accounting-account-number>',
        force_general_account: '<accounting-account-number>',
        prioritise_thirdparty_account: false,
        description: 'Consulting services',
        analytic_distribution: [],
        tax_code: '<accounting-tax-code>',
        tax_info: {
          tax_code: '<accounting-tax-code>',
          tax_amount: 42,
          vat_account: '<accounting-account-number>',
          reversed_vat_account: '<accounting-account-number>',
          description: 'VAT 21%'
        },
        account_info: {
          account_number: '<accounting-account-number>',
          account_name: 'Consulting services'
        }
      }
    ],
    reference: 'JE-REF-0001',
    due_date: '2026-02-14',
    currency_exchange_rate: 1,
    pdf: '<string>',
    pdf_name: '<string>',
    posted: true,
    start_date: '2023-12-25',
    end_date: '2023-12-25'
  })
};

fetch('https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'journal_id' => '<accounting-journal-id>',
    'number' => 'JE-2026-0001',
    'currency' => 'EUR',
    'date' => '2026-01-15',
    'items' => [
        [
                'debit' => 242,
                'credit' => 0,
                'account' => '<accounting-account-number>',
                'force_general_account' => '<accounting-account-number>',
                'prioritise_thirdparty_account' => false,
                'description' => 'Consulting services',
                'analytic_distribution' => [
                                
                ],
                'tax_code' => '<accounting-tax-code>',
                'tax_info' => [
                                'tax_code' => '<accounting-tax-code>',
                                'tax_amount' => 42,
                                'vat_account' => '<accounting-account-number>',
                                'reversed_vat_account' => '<accounting-account-number>',
                                'description' => 'VAT 21%'
                ],
                'account_info' => [
                                'account_number' => '<accounting-account-number>',
                                'account_name' => 'Consulting services'
                ]
        ]
    ],
    'reference' => 'JE-REF-0001',
    'due_date' => '2026-02-14',
    'currency_exchange_rate' => 1,
    'pdf' => '<string>',
    'pdf_name' => '<string>',
    'posted' => true,
    'start_date' => '2023-12-25',
    'end_date' => '2023-12-25'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries"

	payload := strings.NewReader("{\n  \"journal_id\": \"<accounting-journal-id>\",\n  \"number\": \"JE-2026-0001\",\n  \"currency\": \"EUR\",\n  \"date\": \"2026-01-15\",\n  \"items\": [\n    {\n      \"debit\": 242,\n      \"credit\": 0,\n      \"account\": \"<accounting-account-number>\",\n      \"force_general_account\": \"<accounting-account-number>\",\n      \"prioritise_thirdparty_account\": false,\n      \"description\": \"Consulting services\",\n      \"analytic_distribution\": [],\n      \"tax_code\": \"<accounting-tax-code>\",\n      \"tax_info\": {\n        \"tax_code\": \"<accounting-tax-code>\",\n        \"tax_amount\": 42,\n        \"vat_account\": \"<accounting-account-number>\",\n        \"reversed_vat_account\": \"<accounting-account-number>\",\n        \"description\": \"VAT 21%\"\n      },\n      \"account_info\": {\n        \"account_number\": \"<accounting-account-number>\",\n        \"account_name\": \"Consulting services\"\n      }\n    }\n  ],\n  \"reference\": \"JE-REF-0001\",\n  \"due_date\": \"2026-02-14\",\n  \"currency_exchange_rate\": 1,\n  \"pdf\": \"<string>\",\n  \"pdf_name\": \"<string>\",\n  \"posted\": true,\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries")
  .header("Content-Type", "application/json")
  .body("{\n  \"journal_id\": \"<accounting-journal-id>\",\n  \"number\": \"JE-2026-0001\",\n  \"currency\": \"EUR\",\n  \"date\": \"2026-01-15\",\n  \"items\": [\n    {\n      \"debit\": 242,\n      \"credit\": 0,\n      \"account\": \"<accounting-account-number>\",\n      \"force_general_account\": \"<accounting-account-number>\",\n      \"prioritise_thirdparty_account\": false,\n      \"description\": \"Consulting services\",\n      \"analytic_distribution\": [],\n      \"tax_code\": \"<accounting-tax-code>\",\n      \"tax_info\": {\n        \"tax_code\": \"<accounting-tax-code>\",\n        \"tax_amount\": 42,\n        \"vat_account\": \"<accounting-account-number>\",\n        \"reversed_vat_account\": \"<accounting-account-number>\",\n        \"description\": \"VAT 21%\"\n      },\n      \"account_info\": {\n        \"account_number\": \"<accounting-account-number>\",\n        \"account_name\": \"Consulting services\"\n      }\n    }\n  ],\n  \"reference\": \"JE-REF-0001\",\n  \"due_date\": \"2026-02-14\",\n  \"currency_exchange_rate\": 1,\n  \"pdf\": \"<string>\",\n  \"pdf_name\": \"<string>\",\n  \"posted\": true,\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"journal_id\": \"<accounting-journal-id>\",\n  \"number\": \"JE-2026-0001\",\n  \"currency\": \"EUR\",\n  \"date\": \"2026-01-15\",\n  \"items\": [\n    {\n      \"debit\": 242,\n      \"credit\": 0,\n      \"account\": \"<accounting-account-number>\",\n      \"force_general_account\": \"<accounting-account-number>\",\n      \"prioritise_thirdparty_account\": false,\n      \"description\": \"Consulting services\",\n      \"analytic_distribution\": [],\n      \"tax_code\": \"<accounting-tax-code>\",\n      \"tax_info\": {\n        \"tax_code\": \"<accounting-tax-code>\",\n        \"tax_amount\": 42,\n        \"vat_account\": \"<accounting-account-number>\",\n        \"reversed_vat_account\": \"<accounting-account-number>\",\n        \"description\": \"VAT 21%\"\n      },\n      \"account_info\": {\n        \"account_number\": \"<accounting-account-number>\",\n        \"account_name\": \"Consulting services\"\n      }\n    }\n  ],\n  \"reference\": \"JE-REF-0001\",\n  \"due_date\": \"2026-02-14\",\n  \"currency_exchange_rate\": 1,\n  \"pdf\": \"<string>\",\n  \"pdf_name\": \"<string>\",\n  \"posted\": true,\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\"\n}"

response = http.request(request)
puts response.read_body

{
  "journal_id": "<accounting-journal-id>",
  "id": "<this-journal-entry-id>",
  "reference": "JE-REF-0001",
  "due_date": "2026-02-14",
  "name": "JE-2026-0001",
  "journal_name": "Bank journal",
  "date": "2026-01-15",
  "posted": false,
  "due_dates": [],
  "attachments_info": {
    "status": "unknown",
    "attachments": []
  },
  "items": []
}

POST

consumers

{consumer_id}

accounting

journal-entries

Create Journal Entry

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries \
  --header 'Content-Type: application/json' \
  --data '
{
  "journal_id": "<accounting-journal-id>",
  "number": "JE-2026-0001",
  "currency": "EUR",
  "date": "2026-01-15",
  "items": [
    {
      "debit": 242,
      "credit": 0,
      "account": "<accounting-account-number>",
      "force_general_account": "<accounting-account-number>",
      "prioritise_thirdparty_account": false,
      "description": "Consulting services",
      "analytic_distribution": [],
      "tax_code": "<accounting-tax-code>",
      "tax_info": {
        "tax_code": "<accounting-tax-code>",
        "tax_amount": 42,
        "vat_account": "<accounting-account-number>",
        "reversed_vat_account": "<accounting-account-number>",
        "description": "VAT 21%"
      },
      "account_info": {
        "account_number": "<accounting-account-number>",
        "account_name": "Consulting services"
      }
    }
  ],
  "reference": "JE-REF-0001",
  "due_date": "2026-02-14",
  "currency_exchange_rate": 1,
  "pdf": "<string>",
  "pdf_name": "<string>",
  "posted": true,
  "start_date": "2023-12-25",
  "end_date": "2023-12-25"
}
'

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries"

payload = {
    "journal_id": "<accounting-journal-id>",
    "number": "JE-2026-0001",
    "currency": "EUR",
    "date": "2026-01-15",
    "items": [
        {
            "debit": 242,
            "credit": 0,
            "account": "<accounting-account-number>",
            "force_general_account": "<accounting-account-number>",
            "prioritise_thirdparty_account": False,
            "description": "Consulting services",
            "analytic_distribution": [],
            "tax_code": "<accounting-tax-code>",
            "tax_info": {
                "tax_code": "<accounting-tax-code>",
                "tax_amount": 42,
                "vat_account": "<accounting-account-number>",
                "reversed_vat_account": "<accounting-account-number>",
                "description": "VAT 21%"
            },
            "account_info": {
                "account_number": "<accounting-account-number>",
                "account_name": "Consulting services"
            }
        }
    ],
    "reference": "JE-REF-0001",
    "due_date": "2026-02-14",
    "currency_exchange_rate": 1,
    "pdf": "<string>",
    "pdf_name": "<string>",
    "posted": True,
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    journal_id: '<accounting-journal-id>',
    number: 'JE-2026-0001',
    currency: 'EUR',
    date: '2026-01-15',
    items: [
      {
        debit: 242,
        credit: 0,
        account: '<accounting-account-number>',
        force_general_account: '<accounting-account-number>',
        prioritise_thirdparty_account: false,
        description: 'Consulting services',
        analytic_distribution: [],
        tax_code: '<accounting-tax-code>',
        tax_info: {
          tax_code: '<accounting-tax-code>',
          tax_amount: 42,
          vat_account: '<accounting-account-number>',
          reversed_vat_account: '<accounting-account-number>',
          description: 'VAT 21%'
        },
        account_info: {
          account_number: '<accounting-account-number>',
          account_name: 'Consulting services'
        }
      }
    ],
    reference: 'JE-REF-0001',
    due_date: '2026-02-14',
    currency_exchange_rate: 1,
    pdf: '<string>',
    pdf_name: '<string>',
    posted: true,
    start_date: '2023-12-25',
    end_date: '2023-12-25'
  })
};

fetch('https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'journal_id' => '<accounting-journal-id>',
    'number' => 'JE-2026-0001',
    'currency' => 'EUR',
    'date' => '2026-01-15',
    'items' => [
        [
                'debit' => 242,
                'credit' => 0,
                'account' => '<accounting-account-number>',
                'force_general_account' => '<accounting-account-number>',
                'prioritise_thirdparty_account' => false,
                'description' => 'Consulting services',
                'analytic_distribution' => [
                                
                ],
                'tax_code' => '<accounting-tax-code>',
                'tax_info' => [
                                'tax_code' => '<accounting-tax-code>',
                                'tax_amount' => 42,
                                'vat_account' => '<accounting-account-number>',
                                'reversed_vat_account' => '<accounting-account-number>',
                                'description' => 'VAT 21%'
                ],
                'account_info' => [
                                'account_number' => '<accounting-account-number>',
                                'account_name' => 'Consulting services'
                ]
        ]
    ],
    'reference' => 'JE-REF-0001',
    'due_date' => '2026-02-14',
    'currency_exchange_rate' => 1,
    'pdf' => '<string>',
    'pdf_name' => '<string>',
    'posted' => true,
    'start_date' => '2023-12-25',
    'end_date' => '2023-12-25'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries"

	payload := strings.NewReader("{\n  \"journal_id\": \"<accounting-journal-id>\",\n  \"number\": \"JE-2026-0001\",\n  \"currency\": \"EUR\",\n  \"date\": \"2026-01-15\",\n  \"items\": [\n    {\n      \"debit\": 242,\n      \"credit\": 0,\n      \"account\": \"<accounting-account-number>\",\n      \"force_general_account\": \"<accounting-account-number>\",\n      \"prioritise_thirdparty_account\": false,\n      \"description\": \"Consulting services\",\n      \"analytic_distribution\": [],\n      \"tax_code\": \"<accounting-tax-code>\",\n      \"tax_info\": {\n        \"tax_code\": \"<accounting-tax-code>\",\n        \"tax_amount\": 42,\n        \"vat_account\": \"<accounting-account-number>\",\n        \"reversed_vat_account\": \"<accounting-account-number>\",\n        \"description\": \"VAT 21%\"\n      },\n      \"account_info\": {\n        \"account_number\": \"<accounting-account-number>\",\n        \"account_name\": \"Consulting services\"\n      }\n    }\n  ],\n  \"reference\": \"JE-REF-0001\",\n  \"due_date\": \"2026-02-14\",\n  \"currency_exchange_rate\": 1,\n  \"pdf\": \"<string>\",\n  \"pdf_name\": \"<string>\",\n  \"posted\": true,\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries")
  .header("Content-Type", "application/json")
  .body("{\n  \"journal_id\": \"<accounting-journal-id>\",\n  \"number\": \"JE-2026-0001\",\n  \"currency\": \"EUR\",\n  \"date\": \"2026-01-15\",\n  \"items\": [\n    {\n      \"debit\": 242,\n      \"credit\": 0,\n      \"account\": \"<accounting-account-number>\",\n      \"force_general_account\": \"<accounting-account-number>\",\n      \"prioritise_thirdparty_account\": false,\n      \"description\": \"Consulting services\",\n      \"analytic_distribution\": [],\n      \"tax_code\": \"<accounting-tax-code>\",\n      \"tax_info\": {\n        \"tax_code\": \"<accounting-tax-code>\",\n        \"tax_amount\": 42,\n        \"vat_account\": \"<accounting-account-number>\",\n        \"reversed_vat_account\": \"<accounting-account-number>\",\n        \"description\": \"VAT 21%\"\n      },\n      \"account_info\": {\n        \"account_number\": \"<accounting-account-number>\",\n        \"account_name\": \"Consulting services\"\n      }\n    }\n  ],\n  \"reference\": \"JE-REF-0001\",\n  \"due_date\": \"2026-02-14\",\n  \"currency_exchange_rate\": 1,\n  \"pdf\": \"<string>\",\n  \"pdf_name\": \"<string>\",\n  \"posted\": true,\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/accounting/journal-entries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"journal_id\": \"<accounting-journal-id>\",\n  \"number\": \"JE-2026-0001\",\n  \"currency\": \"EUR\",\n  \"date\": \"2026-01-15\",\n  \"items\": [\n    {\n      \"debit\": 242,\n      \"credit\": 0,\n      \"account\": \"<accounting-account-number>\",\n      \"force_general_account\": \"<accounting-account-number>\",\n      \"prioritise_thirdparty_account\": false,\n      \"description\": \"Consulting services\",\n      \"analytic_distribution\": [],\n      \"tax_code\": \"<accounting-tax-code>\",\n      \"tax_info\": {\n        \"tax_code\": \"<accounting-tax-code>\",\n        \"tax_amount\": 42,\n        \"vat_account\": \"<accounting-account-number>\",\n        \"reversed_vat_account\": \"<accounting-account-number>\",\n        \"description\": \"VAT 21%\"\n      },\n      \"account_info\": {\n        \"account_number\": \"<accounting-account-number>\",\n        \"account_name\": \"Consulting services\"\n      }\n    }\n  ],\n  \"reference\": \"JE-REF-0001\",\n  \"due_date\": \"2026-02-14\",\n  \"currency_exchange_rate\": 1,\n  \"pdf\": \"<string>\",\n  \"pdf_name\": \"<string>\",\n  \"posted\": true,\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\"\n}"

response = http.request(request)
puts response.read_body

{
  "journal_id": "<accounting-journal-id>",
  "id": "<this-journal-entry-id>",
  "reference": "JE-REF-0001",
  "due_date": "2026-02-14",
  "name": "JE-2026-0001",
  "journal_name": "Bank journal",
  "date": "2026-01-15",
  "posted": false,
  "due_dates": [],
  "attachments_info": {
    "status": "unknown",
    "attachments": []
  },
  "items": []
}

Learn more:

What is a journal entry? ↗
What is a ledger account? ↗
How to select the right accounts in journal entries? ↗
How to apply VAT on journal entry lines? ↗
What are the entry number format restrictions? ↗

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.

force_currency_exchange

enum<string> | null

default:false

Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software.

Available options:

true,

false

ignore_accounting_id

boolean

default:false

If set to true, Chift will not wait for the invoice to be processed to return, use this when you do not need the ID in the return value.Note that this might also change the output of the call.

Body

application/json

journal_id

string

required

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

Example:

"<accounting-journal-id>"

number

string

required

Unique 'number' of the journal entry in the accounting software. This is an internal number or ID assigned to the journal entry, not necessarily the label or number visible on an invoice. 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.

Minimum string length: 1

Example:

"JE-2026-0001"

currency

string

required

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

Minimum string length: 1

Example:

"EUR"

date

string<date>

required

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

Example:

"2026-01-15"

items

GenericJournalItem · object[]

required

List of journal items that make up the journal entry. Each item represents a line in the journal entry, and the sum of debits must equal the sum of credits to ensure the entry is balanced. There must always be at least 2 lines/items.

Minimum array length: 2

Show child attributes

reference

string | null

Optional reference field used to store an external or contextual identifier related to the entry. For example, it can be used to store a reference number, the invoice number issued by the suppllier or any other relevant information.

Example:

"JE-REF-0001"

due_date

string<date> | null

If the journal entry relates to an invoice, this is the last due date for payment or settlement (format: YYYY-MM-DD), carried from a client/supplier entry line.

Example:

"2026-02-14"

currency_exchange_rate

number | null

default:1

Exchange rate from the transaction currency to the folder's base currency, at the date of the journal entry. Must be filled in when creating the entry in another currency from the folder's default currency.

pdf

string | null

Base 64 string representing the PDF attached to the item.

pdf_name

string | null

A name for the PDF file to be created for accounting software that support it.

Required string length: 1 - 200

Pattern: ^[a-zA-Z0-9\-_ ]{1,196}(?:.pdf)?$

posted

boolean | null

default:true

Indicates if the journal entry has been posted (finalized) in the accounting system. If not provided, it defaults to True.

start_date

string<date> | null

Start date of the period covered by the journal entry (format: YYYY-MM-DD). This field should be used when the entry relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period begins.

end_date

string<date> | null

End date of the period covered by the journal entry (format: YYYY-MM-DD). This field should be used when the entry relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period ends.

Response

Successful Response

journal_id

string

required

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

Example:

"<accounting-journal-id>"

string

required

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

Example:

"<this-journal-entry-id>"

reference

string | null

Example:

"JE-REF-0001"

due_date

string<date> | null

If the journal entry relates to an invoice, this is the last due date for payment or settlement (format: YYYY-MM-DD), carried from a client/supplier entry line.

Example:

"2026-02-14"

name

string | null

Mainly the accounting entry number (numéro de pièce comptable) assigned by the source system.

Example:

"JE-2026-0001"

journal_name

string | null

Name of the journal in which the journal entry is recorded.

Example:

"Bank journal"

date

string<date> | null

default:1970-01-01

Accounting date of the journal entry, which determines the accounting period and therefore the book year the entry falls into. It is automatically set to '1970-01-01' if the value is not available/empty in the accounting system.

Example:

"2026-01-15"

posted

boolean | null

default:false

Indicates if the journal entry has been posted (finalized) in the accounting system.

due_dates

JournalItemDueDatesOut · object[] | null

List of all due dates of a journal entry. Generally an entry has one client/supplier line per due date, each listed here with its amount.

Show child attributes

attachments_info

ItemAttachmentInfoOut · object

Indicates whether a file attachment (e.g. PDF or image) is linked to this journal entry and how to retrieve it. Check the status field: 'yes' means a direct download URL is available in the attachments array; 'yes_to_request' means the file exists but must be fetched separately via GET /accounting/attachments?type=entry&document_id={id}, which returns the file as a base64-encoded string. 'no' means no attachment is linked. 'unknown' means the connector does not support this.

Show child attributes

items

JournalItemMultiAnalyticPlan · object[] | null

List of journal items that make up the journal entry. Each item represents a line in the journal entry, and the sum of debits must equal the sum of credits to ensure the entry is balanced.

Show child attributes

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Spend Management

Other

Create Journal Entry

Path Parameters

Query Parameters

Body

Response