Get journal entries

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

page

integer

default:1

Page number Page number

Required range: x >= 1

size

integer

default:50

Page size Page size

Required range: 1 <= x <= 100

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.

unposted_allowed

enum<string>

required

Available options:

true,

false

journal_id

string | null

Journal ID used to filter journal entries to only retrieve entries for a specific journal. This is an optional filter parameter.

date_from

string<date> | null

Accounting date from which the journal entries will be retrieved (this date will be included in the response). This parameter is mandatory if the 'updated_after' parameter is not provided.

date_to

string<date> | null

Accounting date until which the journal entries will be retrieved (this date will be included in the response). This parameter is mandatory if the 'updated_after' parameter is not provided.

updated_after

string<date-time> | null

When provided only journal entries modified or created after this datetime will be retrieved (this datetime will NOT be included in the response). E.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC, UTC is the only format that is supported on all connectors.

partner_id

string | null

Response

Successful Response

items

JournalEntryMonoAnalyticPlan · object[]

required

Show child attributes

items.journal_id

string

required

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

items.id

string

required

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

items.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.

items.due_date

string<date> | null

If the journal entry relates to an invoice, this is the due date for payment or settlement (format: YYYY-MM-DD).

items.name

string | null

items.journal_name

string | null

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

items.date

string<date> | null

default:1970-01-01

Accounting date of the journal entry. It is automatically set to '1970-01-01' if the value is not available/empty in the accounting system.

items.posted

boolean | null

default:false

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

items.due_dates

JournalItemDueDatesOut · object[] | null

List of all due dates of a journal entry.

Show child attributes

items.due_dates.due_date

string<date>

required

Due date of the item.

items.due_dates.payment_method

string | null

Payment method used to pay the entry on that due date.

items.due_dates.debit

number | null

default:0

Debit of the item on this due date.

items.due_dates.credit

number | null

default:0

Credit of the item on this due date.

items.attachments_info

ItemAttachmentInfoOut · object

Extra information about the attachments linked to the journal entry.

Show child attributes

items.attachments_info.status

enum<string>

required

The status of the attachment.'yes' means the attachment can be returned directly.'yes_to_request' means an additional request is required.'no' means there is no attachment.'unknown' means we can not yet determine if an attachment is available.

Available options:

unknown,

yes,

yes_to_request,

no

items.attachments_info.attachments

ItemAttachmentInfoAttachment · object[] | null

Show child attributes

items.attachments_info.attachments.filename

string | null

The name of the attachment.

items.attachments_info.attachments.url

string | null

The URL to download the file.

items.items

JournalItemMonoAnalyticPlan · 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

items.items.account_number

string

required

Depending on account_type, if the account_type is 'general_account', this is the general ledger account number used to book the journal item against. If the account_type is 'customer_account', 'supplier_account' or 'employee_account', this is the thirdparty_id (id of the customer, supplier or employee in the accounting system).

Minimum string length: 1

items.items.debit

number

required

Amount to debit on the account. Must be 0 if credit field is not 0

items.items.credit

number

required

Amount to credit on the account. Must be 0 if debit field is not 0

items.items.currency

string

required

Currency code (e.g., USD, EUR) used for the journal item amounts.

Minimum string length: 1

items.items.id

string

required

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

items.items.account_name

string

required

Name or label of the ledger account used to book the journal item against.

items.items.partner_id

string | null

Id of the thirdparty (customer, supplier or employee) in the accounting system if the journal item relates to a thirdparty (e.g., an invoice).

items.items.description

string | null

Text description for this journal item. This is typically used to provide additional context or information.

items.items.currency_exchange_rate

number | null

default:1

Exchange rate applicable at the date of the journal item. Required when currency is different from the folder's default currency.

items.items.partner_name

string | null

Name of the thirdparty (customer, supplier or employee) linked to the journal item if journal item relates to a thirdparty (e.g., an invoice).

items.items.matching_numbers

string[] | null

List of matching numbers used to link this journal item to other entries in the accounting system. This is used for reconciliation/lettering purposes.

items.items.analytic_account

string | null

Analytic account in the default analytic plan.

items.items.analytic_account_name

string | null

Name of the analytic account in the default analytic plan.

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

size

integer

required

Required range: x >= 1

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Get journal entries

Authorizations

Path Parameters

Query Parameters

Response