Retrieve accounting account

Returns a single accounting account by accountingCode, including deactivated accounts.

get/accountingaccounts/{companyId}/{accountingCode}

Path parameters

accountingCodestring required

companyIdstring required

Response

Successful Response

activeboolean nullable

Whether the accounting account is active.

type'banks' | 'analytics' | 'accountings'

accountingNamestring nullable

Display name of the accounting account. Defaults to accountingCode when omitted.

collectiveboolean nullable

Whether this is a collective (grouping) accounting account rather than an individual one.

additionalInfoobject nullable

Free-form key/value metadata to attach to the account. Sending an empty object leaves any previously stored metadata unchanged instead of clearing it.

accountingCodestring required

Unique code identifying the accounting account in the company's chart of accounts.

companyIdstring required

Embat company ID. You can get them from "companies" endpoints

updatedAtstring date-time required

Last updated date of the entity in the database

createdAtstring date-time required

Created date of the entity in the database

balancenumber nullable

Current balance of the accounting account.

balanceDatestring date-time nullable

Date the balance was last calculated.

Example response

{
  "accountingName": "Clients - Domestic",
  "attributes": [
    {
      "customId": "cost-center",
      "value": "Marketing",
      "valueCustomId": "cc-marketing"
    }
  ],
  "accountingCode": "430001",
  "balance": 15230.75
}

Changes

No recorded changes to this endpoint across all 6 revisions of this API.