Create Journal Entry

Create a new Journal Entry.

POST /accounting/journal_entries

cURL

curl --request POST \
  --url https://api.rootfi.dev/v3/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",
      "business_unit_id": "1",
      "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"
        }
      ]
    }
  ]
}'

import { RootFiClient } from "rootfi-api";
const rootfi = new RootFiClient({ apiKey: "<api_key>" });

await rootfi.accounting.journalEntries.create({
  company_id: 1,
  data: [
    {
      document_number: "ROOTFI01",
      posted_date: "2021-09-28T15:00:00.000Z",
      description: "Test Invoice",
      currency_id: "GBP",
      business_unit_id: "1",
      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",
        },
      ],
    },
  ],
});

200

{
  "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

curl --request POST \
  --url https://api.rootfi.dev/v3/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",
      "business_unit_id": "1",
      "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"
        }
      ]
    }
  ]
}'

import { RootFiClient } from "rootfi-api";
const rootfi = new RootFiClient({ apiKey: "<api_key>" });

await rootfi.accounting.journalEntries.create({
  company_id: 1,
  data: [
    {
      document_number: "ROOTFI01",
      posted_date: "2021-09-28T15:00:00.000Z",
      description: "Test Invoice",
      currency_id: "GBP",
      business_unit_id: "1",
      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

Response

200 - application/json

data · accountingtypesCreateJournalEntryResponseData · object · required

Show child attributes

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