Create an Account

post

https://api.brinta.com/accounts/

Creates an account in the company's chart of accounts, optionally linked to one or more cost or profit centers.

Identify the owning company with exactly one of company_id or company_account_external_id. Sending both, or neither, is rejected.

Unknown fields are rejected, so check field names carefully.

Body Params

account_external_id

string

required

Code of the account on the client's system. Must be unique per company.

company_id

string

Id of the company on BRINTA's system (UUID). Mandatory if company_account_external_id is not present. Do not send both.

company_account_external_id

string

Id of the company on the client's system. Mandatory if company_id is not present. Do not send both.

parent_company_id

string

Id of the parent company on BRINTA's system (UUID). Used to verify that the company belongs to this parent. Cannot be sent together with parent_company_external_id.

parent_company_external_id

string

Id of the parent company on the client's system. Used to verify that the company belongs to this parent. Cannot be sent together with parent_company_id.

location

string

required

ISO code of the location of the account, e.g. BR.

name

string

required

Name of the account.

name_alt

string

Alternative name of the account.

description

string

required

length ≤ 300

Description of the account.

description_alt

string

length ≤ 300

Alternative description of the account.

type

string

required

Account type. For example: A (analytical, a posting account) or S (synthetic, a grouping account).

level

integer

required

Depth of the account in the chart of accounts hierarchy.

order_id

integer

required

Display and sort order of the account.

nature

integer

Nature code of the account.

sub_nature

string

enum

Sub-nature of the account.

Allowed:

account_alt

string

Alternative account code, e.g. a local or referential chart of accounts code.

account_group_external_id

string

Id of the account group on the client's system.

hierarchy_code

string

Hierarchy code of the account.

parent_account

string

account_external_id of the parent account. The parent account must already exist.

split_code

string

Split code of the account.

rate

number

Rate associated with the account.

comments

string

Free-text comments.

status

string

enum

Defaults to ACTIVE

Status of the account.

Allowed:

start_date

date-time

Start date of the account (ISO 8601 date-time).

end_date

date-time

End date of the account (ISO 8601 date-time).

valid_from

date-time

Start of the validity period (ISO 8601 date-time).

valid_until

date-time

End of the validity period (ISO 8601 date-time).

centers

array of objects

Cost or profit centers linked to the account. Created if they do not exist.

centers

Responses

400

Invalid request: a mandatory field is missing, an unknown field was sent, both or neither company identifiers were sent, both parent company identifiers were sent, the location was not found, or the account already exists for the company.

404

The company was not found or is not related to the parent company, or the parent account was not found.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Account created.