Returns the account with the given identifier.

GET /accounting/accounts/{id}

Group: Accounting › Accounts · Operation ID: getAccount

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the account to return.

Response

200 Success

Under data (getAccountOutput):

Field Type Required Description
id string yes The unique identifier for the account.
accountNumber string yes The account number, unique within its chart of accounts.
accountName string yes The display name of the account.
accountType string yes The top-level classification of the account. Possible values: 'asset', 'liability', 'equity', 'income', 'costOfGoodsSold', 'expense', 'otherIncome', 'otherExpense'.
accountSubType string no A finer classification within accountType. Possible values: 'bank', 'accountsReceivable', 'fixedAsset', 'cip', 'prepaidExpenses', 'deferredExpenses', 'otherCurrentAsset', 'otherAsset', 'unbilledReceivable', 'longTermAsset', 'accountsPayable', 'creditCard', 'deferredRevenue', 'otherCurrentLiability', 'longTermLiability', 'equity', 'income', 'costOfGoodsSold', 'expense', 'otherIncome', 'otherExpense', 'otherComprehensiveIncome'. Absent when none is assigned.
accountStatus string no The lifecycle status of the account. Possible values: 'enabled' (available on transactions), 'disabled' (not available for new transactions), 'draft' (created but not yet reviewed), 'draftErrors' (a draft with validation errors to resolve before it can be enabled).
description string no A free-form description of the account. Absent when none was set.
chartOfAccountsId string yes The identifier of the chart of accounts this account belongs to. An account belongs to exactly one. See id on GET accounting/chart-of-accounts/:id.
parentAccountId string no The identifier of the parent account this account rolls up to. Absent for a top-level account. See id on GET accounting/accounts/:id.
groupingAccount boolean yes Whether this is a grouping (rollup) account. Balances from child accounts aggregate here, and journal entries cannot be posted to it directly.
entityId string no The identifier of the legal entity this account is denominated for. Set only on bank and credit-card accounts. See id on GET base/entities.
currency string no The account's currency. Format ISO 4217, for example 'USD'. Set only on accounts linked to a cash account, alongside entityId.
revaluation boolean no Whether balances on this account are revalued for exchange-rate changes.
payOnBehalf boolean no Whether this account takes part in pay-on-behalf accounting.
elimination boolean no Whether this account is eliminated during consolidation.
exchangeRateType string no Which rate translates this account's amounts on revaluation. Possible values: 'historical', 'average', 'current'. Absent on grouping accounts.
lastModifiedDate string (date-time) yes The date and time the account record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
externalIdentifiers array of object no External identifiers owned by other systems, at most one per fieldName. An empty array when the account has none.
externalIdentifiers[].fieldName string yes The configured key of the external identifier, a camelCase slug such as 'netsuiteAccountId'. It is the fieldName of an existing account external-identifier configuration.
externalIdentifiers[].value string yes The identifier as the source system holds it.
externalIdentifiers[].externalUrl string no An absolute http(s) link to the object in the source system. Absent when none is stored.

Errors

Code Status
NOT_FOUND 400

Statuses