Create a journal entry

curl --request POST \
  --url https://api.rootfi.dev/accounting/journal_entries \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "document_number": "ROOTFI01",
      "posted_date": "2021-09-28T15:00:00.000Z",
      "description": "Test Invoice",
      "currency_id": "GBP",
      "journal_lines": [
        {
          "account_id": "123456",
          "type": "DEBIT",
          "net_amount": 100,
          "contact_id": "123456",
          "tax_id": "123456",
          "tracking_category_ids": [],
          "description": "Test Item"
        },
        {
          "account_id": "123456",
          "type": "CREDIT",
          "net_amount": 100,
          "contact_id": "123456",
          "tax_id": "123456",
          "tracking_category_ids": [],
          "description": "Test Item"
        }
      ]
    }
  ]
}'

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "aXI9pUDA5T7E2LS",
    "data": [
      {
        "job_id": "xQm2K441VosP8W4",
        "status": "success",
        "response": {
          "platform_id": "3770712000001649001",
          "account_id": "3770712000000000361",
          "currency_id": "3770712000000000099",
          "document_number": "ROOTFI01",
          "description": "journal_desc",
          "posted_date": "2023-06-12T00:00:00.000Z",
          "amount": 568,
          "currency_rate": 12,
          "journal_entry_type": "both",
          "updated_at": "2023-10-27T00:00:00.000Z",
          "journal_lines": [
            {
              "platform_id": "3770712000001725038",
              "journal_entry_id": "3770712000001725026",
              "account_id": "3770712000000035001",
              "contact_id": "3770712000000080780",
              "tax_id": null,
              "tracking_category_ids": [
                "3770712000000000335_3770712000001122010"
              ],
              "type": "DEBIT",
              "description": "Test Description for Journal",
              "net_amount": 5,
              "tax_amount": null,
              "updated_at": null
            }
          ],
          "raw_data": {
            "platform_id": "1013",
            "name": "Test",
            "contact_name": "Test",
            "contact_type": "CUSTOMER",
            "currency_id": "1",
            "status": "ARCHIVED"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2023-10-25T13:39:41.201Z",
  "response_timestamp": "2023-10-25T13:39:41.201Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

POST

accounting

journal_entries

curl --request POST \
  --url https://api.rootfi.dev/accounting/journal_entries \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "document_number": "ROOTFI01",
      "posted_date": "2021-09-28T15:00:00.000Z",
      "description": "Test Invoice",
      "currency_id": "GBP",
      "journal_lines": [
        {
          "account_id": "123456",
          "type": "DEBIT",
          "net_amount": 100,
          "contact_id": "123456",
          "tax_id": "123456",
          "tracking_category_ids": [],
          "description": "Test Item"
        },
        {
          "account_id": "123456",
          "type": "CREDIT",
          "net_amount": 100,
          "contact_id": "123456",
          "tax_id": "123456",
          "tracking_category_ids": [],
          "description": "Test Item"
        }
      ]
    }
  ]
}'

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "aXI9pUDA5T7E2LS",
    "data": [
      {
        "job_id": "xQm2K441VosP8W4",
        "status": "success",
        "response": {
          "platform_id": "3770712000001649001",
          "account_id": "3770712000000000361",
          "currency_id": "3770712000000000099",
          "document_number": "ROOTFI01",
          "description": "journal_desc",
          "posted_date": "2023-06-12T00:00:00.000Z",
          "amount": 568,
          "currency_rate": 12,
          "journal_entry_type": "both",
          "updated_at": "2023-10-27T00:00:00.000Z",
          "journal_lines": [
            {
              "platform_id": "3770712000001725038",
              "journal_entry_id": "3770712000001725026",
              "account_id": "3770712000000035001",
              "contact_id": "3770712000000080780",
              "tax_id": null,
              "tracking_category_ids": [
                "3770712000000000335_3770712000001122010"
              ],
              "type": "DEBIT",
              "description": "Test Description for Journal",
              "net_amount": 5,
              "tax_amount": null,
              "updated_at": null
            }
          ],
          "raw_data": {
            "platform_id": "1013",
            "name": "Test",
            "contact_name": "Test",
            "contact_type": "CUSTOMER",
            "currency_id": "1",
            "status": "ARCHIVED"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2023-10-25T13:39:41.201Z",
  "response_timestamp": "2023-10-25T13:39:41.201Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

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

curl --request POST \
  --url https://api.rootfi.dev/accounting/journal_entries \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "document_number": "ROOTFI01",
      "posted_date": "2021-09-28T15:00:00.000Z",
      "description": "Test Invoice",
      "currency_id": "GBP",
      "journal_lines": [
        {
          "account_id": "123456",
          "type": "DEBIT",
          "net_amount": 100,
          "contact_id": "123456",
          "tax_id": "123456",
          "tracking_category_ids": [],
          "description": "Test Item"
        },
        {
          "account_id": "123456",
          "type": "CREDIT",
          "net_amount": 100,
          "contact_id": "123456",
          "tax_id": "123456",
          "tracking_category_ids": [],
          "description": "Test Item"
        }
      ]
    }
  ]
}'

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

The company ID

Example:

1

data

accountingtypesJournalEntriesWriteRequest · object[]

required

Show child attributes

data.account_id

string | null

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

data.currency_id

string | null

The ISO-4217 currency code

data.document_number

string | null

Reference number for the journal entry

data.description

string | null

Memo description of the journal entry

data.posted_date

string | null

Date of creation of the journal entry

data.journal_lines

JournalLines · object[] | null

Array of Journal Entry Line items associated with the journal entry

Show child attributes

data.journal_lines.account_id

string

required

The ID of the account in the accounting platform

data.journal_lines.type

enum<string>

required

The type of the journal line

Available options:

DEBIT,

CREDIT

data.journal_lines.net_amount

number<double>

required

The net amount of the journal line

data.journal_lines.contact_id

string | null

The ID of the contact in the accounting platform

data.journal_lines.tax_id

string | null

The ID of the tax in the accounting platform

data.journal_lines.tracking_category_ids

string[] | null

The IDs of the tracking categories in the accounting platform

data.journal_lines.description

string | null

The description of the journal line

data.journal_lines.raw_data

any | null

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

data.raw_data

any | null

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

Response

200 - application/json

data

accountingtypesCreateJournalEntryResponseData · object

required

Show child attributes

data.status

enum<string>

required

The status of the job.

Available options:

SUCCESS,

FAILED,

CREATED,

RUNNING

data.upload_job_id

string

required

The ID of the job.

data.data

accountingtypesCreateJournalEntriesResponseData · object[]

required

Show child attributes

data.data.job_id

string

required

The ID of the job.

data.data.status

enum<string>

required

The status of the job.

Available options:

success,

failed

data.data.response

accountingtypesJournalEntriesWriteResponseFields · object

required

Show child attributes

data.data.response.platform_id

string

required

The ID that the accounting platform uses to identify this journal entry

data.data.response.account_id

string | null

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

data.data.response.currency_id

string | null

The ISO-4217 currency code

data.data.response.document_number

string | null

Reference number for the journal entry

data.data.response.description

string | null

Memo description of the journal entry

data.data.response.posted_date

string | null

Date of creation of the journal entry

data.data.response.amount

integer | null

The total amount of the journal entry

data.data.response.currency_rate

integer | null

Rate between the currency of the payment and the base currency

data.data.response.journal_entry_type

string | null

Type of the journal entry

data.data.response.updated_at

string | null

The date at which the information was updated on the accounting platform

data.data.response.journal_lines

JournalLinesDataa · object[] | null

Array of Journal Entry Line items associated with the journal entry

Show child attributes

data.data.response.journal_lines.platform_id

string

required

The accounting Platform’s ID for this journal line

data.data.response.journal_lines.journal_entry_id

string

required

The accounting Platform’s ID for this journal entry

data.data.response.journal_lines.net_amount

number<double>

required

The net amount of the journal line

data.data.response.journal_lines.account_id

string | null

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

data.data.response.journal_lines.contact_id

string | null

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

data.data.response.journal_lines.tax_id

string | null

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

data.data.response.journal_lines.tracking_category_ids

string[] | null

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

data.data.response.journal_lines.type

enum<string> | null

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

Available options:

DEBIT,

CREDIT

data.data.response.journal_lines.description

string | null

Description of the journal line

data.data.response.journal_lines.tax_amount

number<double> | null

The tax amount of the journal line

data.data.response.journal_lines.updated_at

string<date-time> | null

The last ISO 8601 timestamp that the data was updated at

data.data.response.journal_lines.raw_data

object

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

data.data.response.raw_data

object

The raw JSON response we receive from the accounting platform for this journal entry

data.data.error

ErrorObject · object

The error message if the job failed.

Show child attributes

data.data.error.code

string

required

data.data.error.message

string

required

data.data.error.platform_error

string

required

data.data.error.raw_data

object

request_timestamp

string<date-time>

required

The time at which the request was received by the server

response_timestamp

string<date-time>

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

Create Journal Entry Overview

⌘I

General

Server Side SDKs

Core API

Unified API

Create a journal entry

Authorizations

Body

Response