Skip to main content
GET
/
consumers
/
{consumer_id}
/
accounting
/
journal
/
entries
/
{journal_entry_id}
Get one journal entry
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/journal/entries/{journal_entry_id} \
  --header 'Authorization: Bearer <token>'
{
  "reference": "<string>",
  "due_date": "2023-12-25",
  "journal_id": "<string>",
  "name": "<string>",
  "journal_name": "<string>",
  "date": "2023-12-25",
  "posted": true,
  "id": "<string>",
  "due_dates": [
    {
      "due_date": "2023-12-25",
      "payment_method": "<string>",
      "debit": 123,
      "credit": 123
    }
  ],
  "attachments_info": {
    "status": "unknown",
    "attachments": [
      {
        "filename": "<string>",
        "url": "<string>"
      }
    ]
  },
  "items": [
    {
      "account_number": "<string>",
      "partner_id": "<string>",
      "description": "<string>",
      "debit": 123,
      "credit": 123,
      "currency": "<string>",
      "currency_exchange_rate": 123,
      "id": "<string>",
      "partner_name": "<string>",
      "account_name": "<string>",
      "matching_numbers": [
        "<string>"
      ],
      "analytic_distribution": [
        {
          "analytic_plan": "<string>",
          "analytic_accounts": [
            {
              "analytic_account": "<string>",
              "percentage": 123
            }
          ]
        }
      ]
    }
  ]
}

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
journal_entry_id
string
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.

Response

Successful Response

journal_id
string
required

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

id
string
required

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

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.

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

name
string | null
journal_name
string | null

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

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.

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.

attachments_info
object

Extra information about the attachments linked to the journal entry.

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.