Create Accounts

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

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

The company ID

data

object[]

required

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

object

required

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

object[]

required

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

object

required

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>

The category of the account.

Available options:

ASSET,

EXPENSE,

LIABILITY,

EQUITY,

INCOME,

BANK,

UNKNOWN

data.data.response.status

enum<string>

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 | null

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

data.data.error

object

The error message if the job failed.

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 | null

request_timestamp

string

required

The time at which the request was received by the server

response_timestamp

string

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

General

Server Side SDKs

Core API

Unified API

Create Accounts

Authorizations

Body

Response