Get All Journal Entries

Integrations Roadmap

Data Coverage Tool

General

Overview

Server Side SDKs

Typescript SDK

Core API

Companies
Invite Links
Sync
Passthrough
Real Time
Webhooks

Unified API

Accounting
- Accounts
- Bank Accounts
- Bank Transactions
- Bills
- Bill Payments
- Bill Credit Notes
- Contacts
- Company Info
- Currencies
- Documents
- Expenses
- Invoice Credit Notes
- Invoices
- Invoice Payments
- Items
- Journal Entries
  - Overview
  - Overview
  - GET
    Get All Journal Entries
  - POST
    Retrieve journal entries
  - POST
    Create Journal Entry
  - POST
    Create a journal entry
- Purchase Orders
- Sales Orders
- Goods Receipt Notes
- Projects
- Tax Rates
- Tracking Categories
- Balance Sheet
- Cash Flow Statements
- Income Statements
Payments
Ecommerce
CRM

GET

accounting

journal_entries

curl --request GET \
  --url https://api.rootfi.dev/v3/accounting/journal_entries \
  --header 'api_key: <api-key>'

{
  "data": [
    {
      "rootfi_id": 123,
      "rootfi_deleted_at": null,
      "rootfi_created_at": "2024-01-25T09:00:00Z",
      "rootfi_updated_at": "2024-01-25T09:00:00Z",
      "rootfi_company_id": 123,
      "platform_id": "123456_1",
      "platform_unique_id": "123456",
      "account_id": "123456",
      "amount": 100,
      "currency_id": "123456",
      "journal_entry_type": "Example Journal Entry Type",
      "description": "Example Description",
      "updated_at": "2024-01-25T09:00:00Z",
      "currency_rate": 1,
      "posted_date": "2024-01-25T09:00:00Z",
      "document_number": "123456",
      "journal_lines": [
        {
          "platform_id": "123456",
          "journal_entry_id": "123456",
          "account_id": "123456",
          "contact_id": "123456",
          "tax_id": "123456",
          "tracking_category_ids": [
            "123456"
          ],
          "type": "DEBIT",
          "description": "This is a description",
          "net_amount": 100,
          "tax_amount": 100,
          "updated_at": "2024-01-22T05:07:31.000Z"
        }
      ]
    }
  ],
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}

The Journal Entries are basic records of a company’s financial transactions used to record the debits and credits of each transaction.

Authorizations

api_key

string

header

required

Query Parameters

limit

integer | null

The number of objects you want to retrieve

string | null

The next page of objects to retrieve

string | null

The previous page of objects to retrieve

expand

string | null

Comma separated fields to expand. Supported values are currency, journal_lines, account

select

string | null

Comma separated fields to select. Supported values are raw_data, data_hash

rootfi_updated_at[gte]

string | null

Filter by rootfi_updated_at Greater than or Equal To.

rootfi_company_id[eq]

integer | null

Filter by rootfi_company_id. You can filter by any field using this syntax field_name[operator]

include_deleted_records

string | null

Include deleted records. By default, deleted records are not included. Supported values are true and false

return_count

string | null

Return the count of the objects. Supported values are true and false

sort[rootfi_created_at]

enum<string>

Sort by rootfi_created_at

Available options:

ASC,

DESC

sort[rootfi_updated_at]

enum<string>

Sort by rootfi_updated_at

Available options:

ASC,

DESC

Response

200

application/json

The data of the JournalEntries endpoint

data

object[]

required

data.rootfi_id

number

required

The unique ID we assign for that data's information

data.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.rootfi_company_id

number

required

The ID of the company in the accounting platform

data.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

data.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.data_hash

string | null

The hash of the data

data.account_id

string | null

The account id of the JournalEntry

data.amount

number | null

The amount of the JournalEntry

data.currency_id

string | null

The currency id of the JournalEntry

data.journal_entry_type

string | null

The journal entry type of the JournalEntry

data.description

string | null

The description of the JournalEntry

data.updated_at

string | null

The updated at of the JournalEntry

data.currency_rate

number | null

The currency rate of the JournalEntry

data.posted_date

string | null

The posted date of the JournalEntry

data.document_number

string | null

The document number of the JournalEntry

data.journal_lines

object[] | null

The journal lines of the JournalEntry

data.journal_lines.platform_id

string

required

The accounting Platform’s ID for this journal line

data.journal_lines.journal_entry_id

string

required

The accounting Platform’s ID for this journal entry

data.journal_lines.net_amount

number

required

The net amount of the journal line. Should always be a positive value

data.journal_lines.account_id

string | null

The accounting platform’s unique ID for the account associated with the journal line

data.journal_lines.contact_id

string | null

The accounting platform’s unique ID for the contact associated with the journal line

data.journal_lines.tax_id

string | null

The accounting platform’s unique ID for the tax associated with the journal line

data.journal_lines.tracking_category_ids

string[] | null

The accounting platform’s unique ID for the tracking category associated with the journal line

data.journal_lines.type

enum<string>

Type of the journal line. Values are credit, debit, unknown.

Available options:

DEBIT,

CREDIT

data.journal_lines.description

string | null

Description of the journal line

data.journal_lines.tax_amount

number | null

The tax amount of the journal line

data.journal_lines.updated_at

string | null

The last ISO 8601 timestamp that the data was updated at

data.journal_lines.raw_data

object | null

A JSON containing fields that you can directly pass to the accounting platform.

data.journal_lines.account

object

The account of the journal line

data.journal_lines.account.rootfi_id

number

required

The unique ID we assign for that data's information

data.journal_lines.account.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.journal_lines.account.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.journal_lines.account.rootfi_company_id

number

required

The ID of the company in the accounting platform

data.journal_lines.account.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

data.journal_lines.account.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.journal_lines.account.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.journal_lines.account.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.journal_lines.account.data_hash

string | null

The hash of the data

data.journal_lines.account.name

string | null

Name of the account

data.journal_lines.account.description

string | null

Description of the account

data.journal_lines.account.nominal_code

string | null

The nominal code of the account

data.journal_lines.account.current_balance

number | null

The current balance of the account

data.journal_lines.account.updated_at

string | null

The date the account was last updated

data.journal_lines.account.status

string | null

The status of the account

data.journal_lines.account.category

enum<string>

The category of the account

Available options:

ASSET,

EXPENSE,

LIABILITY,

EQUITY,

INCOME,

BANK,

UNKNOWN

data.journal_lines.account.sub_category

string | null

The sub category of the account

data.journal_lines.account.currency_id

string | null

The currency id of the account

data.journal_lines.account.parent_account_id

string | null

The parent account id of the account

data.journal_lines.account.parent_account

object

The parent account of the account.

data.journal_lines.account.parent_account.rootfi_id

number

required

The unique ID we assign for that data's information

data.journal_lines.account.parent_account.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.journal_lines.account.parent_account.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.journal_lines.account.parent_account.rootfi_company_id

number

required

The ID of the company in the accounting platform

data.journal_lines.account.parent_account.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

data.journal_lines.account.parent_account.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.journal_lines.account.parent_account.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.journal_lines.account.parent_account.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.journal_lines.account.parent_account.data_hash

string | null

The hash of the data

data.journal_lines.account.parent_account.name

string | null

Name of the account

data.journal_lines.account.parent_account.description

string | null

Description of the account

data.journal_lines.account.parent_account.nominal_code

string | null

The nominal code of the account

data.journal_lines.account.parent_account.current_balance

number | null

The current balance of the account

data.journal_lines.account.parent_account.updated_at

string | null

The date the account was last updated

data.journal_lines.account.parent_account.status

string | null

The status of the account

data.journal_lines.account.parent_account.category

enum<string>

The category of the account

Available options:

ASSET,

EXPENSE,

LIABILITY,

EQUITY,

INCOME,

BANK,

UNKNOWN

data.journal_lines.account.parent_account.sub_category

string | null

The sub category of the account

data.journal_lines.account.parent_account.currency_id

string | null

The currency id of the account

data.journal_lines.account.parent_account.parent_account_id

string | null

The parent account id of the account

data.journal_lines.account.currency

object

The currency of the account.

data.journal_lines.contact

object

The contact of the journal line

data.journal_lines.contact.rootfi_id

number

required

The unique ID we assign for that data's information

data.journal_lines.contact.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.journal_lines.contact.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.journal_lines.contact.rootfi_company_id

number

required

The ID of the company in the accounting platform

data.journal_lines.contact.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

data.journal_lines.contact.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.journal_lines.contact.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.journal_lines.contact.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.journal_lines.contact.data_hash

string | null

The hash of the data

data.journal_lines.contact.name

string | null

Name of the contact

data.journal_lines.contact.contact_name

string | null

Name of the contact person for the contact

data.journal_lines.contact.contact_type

enum<string>

The type of contact. Values are either CUSTOMER or VENDOR

Available options:

CUSTOMER,

VENDOR

data.journal_lines.contact.currency_id

string | null

The ISO-4217 currency code

data.journal_lines.contact.tax_number

string | null

Contact’s tax number

data.journal_lines.contact.registration_number

string | null

Contact’s identifying number

data.journal_lines.contact.status

enum<string>

The status of the contact. Values are ACTIVE, ARCHIVED, UNKNOWN

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.journal_lines.contact.updated_at

string | null

The date the contact was last updated

data.journal_lines.contact.external_links

object[] | null

External links for the contact

data.journal_lines.contact.phone_numbers

object[] | null

Phone numbers for the contact

data.journal_lines.contact.addresses

object[] | null

Addresses for the contact

data.journal_lines.tax_rate

object

The tax rate of the journal line

data.journal_lines.tax_rate.rootfi_id

number

required

The unique ID we assign for that data's information

data.journal_lines.tax_rate.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.journal_lines.tax_rate.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.journal_lines.tax_rate.rootfi_company_id

number

required

The ID of the company in the accounting platform

data.journal_lines.tax_rate.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

data.journal_lines.tax_rate.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.journal_lines.tax_rate.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.journal_lines.tax_rate.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.journal_lines.tax_rate.data_hash

string | null

The hash of the data

data.journal_lines.tax_rate.name

string | null

Display name

data.journal_lines.tax_rate.code

string | null

Simple ID for the tax rate

data.journal_lines.tax_rate.tax_type

string | null

The type of tax as mentioned in the accounting platform

data.journal_lines.tax_rate.effective_tax_rate

number | null

The total tax rate after accounting for the compounding effects of the all tax components

data.journal_lines.tax_rate.total_tax_rate

number | null

The sum of all the tax rate components

data.journal_lines.tax_rate.components

object[] | null

The list of tax rate components

data.journal_lines.tax_rate.updated_at

string | null

The last time the tax rate was updated

data.currency

object

The currency of the JournalEntry

data.account

object

The account of the JournalEntry

data.account.rootfi_id

number

required

The unique ID we assign for that data's information

data.account.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.account.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.account.rootfi_company_id

number

required

The ID of the company in the accounting platform

data.account.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

data.account.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.account.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.account.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.account.data_hash

string | null

The hash of the data

data.account.name

string | null

Name of the account

data.account.description

string | null

Description of the account

data.account.nominal_code

string | null

The nominal code of the account

data.account.current_balance

number | null

The current balance of the account

data.account.updated_at

string | null

The date the account was last updated

data.account.status

string | null

The status of the account

data.account.category

enum<string>

The category of the account

Available options:

ASSET,

EXPENSE,

LIABILITY,

EQUITY,

INCOME,

BANK,

UNKNOWN

data.account.sub_category

string | null

The sub category of the account

data.account.currency_id

string | null

The currency id of the account

data.account.parent_account_id

string | null

The parent account id of the account

data.account.parent_account

object

The parent account of the account.

data.account.currency

object

The currency of the account.

string | null

The previous page of objects to retrieve

string | null

The next page of objects to retrieve

total_count

integer | null

The total count of the objects

Overview Retrieve journal entries

curl --request GET \
  --url https://api.rootfi.dev/v3/accounting/journal_entries \
  --header 'api_key: <api-key>'

{
  "data": [
    {
      "rootfi_id": 123,
      "rootfi_deleted_at": null,
      "rootfi_created_at": "2024-01-25T09:00:00Z",
      "rootfi_updated_at": "2024-01-25T09:00:00Z",
      "rootfi_company_id": 123,
      "platform_id": "123456_1",
      "platform_unique_id": "123456",
      "account_id": "123456",
      "amount": 100,
      "currency_id": "123456",
      "journal_entry_type": "Example Journal Entry Type",
      "description": "Example Description",
      "updated_at": "2024-01-25T09:00:00Z",
      "currency_rate": 1,
      "posted_date": "2024-01-25T09:00:00Z",
      "document_number": "123456",
      "journal_lines": [
        {
          "platform_id": "123456",
          "journal_entry_id": "123456",
          "account_id": "123456",
          "contact_id": "123456",
          "tax_id": "123456",
          "tracking_category_ids": [
            "123456"
          ],
          "type": "DEBIT",
          "description": "This is a description",
          "net_amount": 100,
          "tax_amount": 100,
          "updated_at": "2024-01-22T05:07:31.000Z"
        }
      ]
    }
  ],
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}