API referenceGitHubAPI statusSign up

Journals

A detailed record of all financial transactions of a company

Suggest Edits

📘

Language tip

For line items, or individual transactions, of a company's financial documents, refer to the Journal entries data type

Explore the Journals endpoints in Swagger.

View the coverage for journals in the Data Coverage Explorer.

Overview

In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate journal entry. These entries are used to create the general ledger, which is then used to create the financial statements of a business.

When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries.

Such journals can be divided into two categories:

  • Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal.
  • General journals: journals used to record transactions that fall outside the scope of the special journals.

Multiple journals or subjournals are used in the following Codat integrations:

🚧

When pushing journal entries to an accounting platform that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object.

Data model

Field

Type

Description

id

string

Journal ID.

journalCode

string

Native journal number or code.

name

string

Journal name.
The maximum length for a journal name is 256 characters. All characters above that number will be truncated.

type

string

The type of the journal.

parentId

string

Parent journal ID.
If the journal is a parent journal, this value is not present.

hasChildren

boolean

If the journal has child journals, this value is true. If it doesn’t, it is false.

createdOn

string
See date

Journal creation date.

status

string

Possible statuses:

  • `Unknown`
  • `Active`
  • `Archived`

modifiedDate

string
See date

The last time Codat modified the record.

sourceModifiedDate

string
See date

The last time the journal was modified on the source platform.

Example data

{
      "id": "07b94827-c0a5-4cc7-ba58-3f9efec3b4b3",
      "journalCode": "PAY",
      "name": "Payroll Journal",
      "type": "Payroll Journal",
      "parentId": "90bb7784-083b-4bcb-a534-b30756cee65d",
      "hasChildren": false,
      "createdOn": "2021-02-23T15:33:22",
      "status": "Active",
      "modifiedDate": "2022-07-22T14:46:15Z",
      "sourceModifiedDate": "2022-03-21T21:43:22"
    },

Updated 2 months ago