Create Accounts

curl --request POST \
  --url https://integrate.rootfi.dev/api/write/accounts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api_key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test Account",
      "description": "Rootfi Test Account",
      "nominal_code": "123456",
      "sub_category": "Test",
      "currency_id": "123456",
      "parent_account_id": "1234567",
      "raw_data": {}
    }
  ]
}'

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "xQm2K441VosP8W4",
    "data": [
      {
        "job_id": "aXI9pUDA5T7E2LS",
        "status": "success",
        "response": {
          "platform_id": "1234567890123456789",
          "currency_id": null,
          "parent_account_id": null,
          "nominal_code": "Test Account",
          "name": "Test Account",
          "description": "Test Description",
          "sub_category": "long_term_liability",
          "category": "LIABILITY",
          "status": "ACTIVE",
          "updated_at": "2021-09-28T15:00:00.000Z",
          "raw_data": {
            "platform_id": "1234567890123456789",
            "nominal_code": "Test Account",
            "name": "Test Account",
            "description": "Test Description",
            "category": "LIABILITY",
            "sub_category": "long_term_liability",
            "status": "ACTIVE"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

POST

accounting

accounts

curl --request POST \
  --url https://integrate.rootfi.dev/api/write/accounts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api_key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test Account",
      "description": "Rootfi Test Account",
      "nominal_code": "123456",
      "sub_category": "Test",
      "currency_id": "123456",
      "parent_account_id": "1234567",
      "raw_data": {}
    }
  ]
}'

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "xQm2K441VosP8W4",
    "data": [
      {
        "job_id": "aXI9pUDA5T7E2LS",
        "status": "success",
        "response": {
          "platform_id": "1234567890123456789",
          "currency_id": null,
          "parent_account_id": null,
          "nominal_code": "Test Account",
          "name": "Test Account",
          "description": "Test Description",
          "sub_category": "long_term_liability",
          "category": "LIABILITY",
          "status": "ACTIVE",
          "updated_at": "2021-09-28T15:00:00.000Z",
          "raw_data": {
            "platform_id": "1234567890123456789",
            "nominal_code": "Test Account",
            "name": "Test Account",
            "description": "Test Description",
            "category": "LIABILITY",
            "sub_category": "long_term_liability",
            "status": "ACTIVE"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

The Accounts Data Model is designed to streamline the management and retrieval of account-related information across various accounting platforms.

curl --request POST \
  --url https://integrate.rootfi.dev/api/write/accounts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api_key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test Account",
      "description": "Rootfi Test Account",
      "nominal_code": "123456",
      "sub_category": "Test",
      "currency_id": "123456",
      "parent_account_id": "1234567",
      "raw_data": {}
    }
  ]
}'

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

The company ID

Example:

1

data

accountingtypesAccountsWriteRequestFields · object[]

required

Show child attributes

data.currency_id

string | null

The Accounting Platform’s unique ID for the currency

data.parent_account_id

string | null

The platform ID of the parent account

data.nominal_code

string | null

Reference given to each account for a business. It ensures money is allocated to the correct account.

data.name

string | null

The name of the account

data.description

string | null

Description of the account

data.sub_category

string | null

The sub category of the account

data.current_balance

integer | null

Current balance of the account

data.raw_data

any | null

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

Response

200 - application/json

data

accountingtypesCreateAccountsResponseHelper · 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

accountingtypesAccountsResponseHelper · 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

accountingtypesAccountsWriteResponseFields · object

required

Show child attributes

data.data.response.platform_id

string

required

The ID that the accounting platform uses to identify this account

data.data.response.currency_id

string | null

The Accounting Platform’s unique ID for the currency

data.data.response.parent_account_id

string | null

The platform ID of the parent account

data.data.response.nominal_code

string | null

Reference given to each account for a business. It ensures money is allocated to the correct account.

data.data.response.name

string | null

The name of the account

data.data.response.description

string | null

Description of the account

data.data.response.sub_category

string | null

The sub category of the account

data.data.response.current_balance

integer | null

Current balance of the account

data.data.response.category

enum<string> | null

The category of the account.

Available options:

ASSET,

EXPENSE,

LIABILITY,

EQUITY,

INCOME,

BANK,

UNKNOWN

data.data.response.status

enum<string> | null

The status of the account.

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.data.response.updated_at

string | null

Date the record was last updated in the accounting platform.

data.data.response.raw_data

object

The raw JSON response we get from the accounting platform for that data

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 Account Overview

⌘I

General

Server Side SDKs

Core API

Unified API

Create Accounts

Authorizations

Body

Response