/accounts/{id}

Returns an Account object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
namestring or null
The account's name.
descriptionstring or null
The account's description.
classificationenum or null
The account's broadest grouping. * `ASSET` - ASSET * `EQUITY` - EQUITY * `EXPENSE` - EXPENSE * `LIABILITY` - LIABILITY * `REVENUE` - REVENUE
Allowed values:
typestring or null
The account's type is a narrower and more specific grouping within the account's classification.
account_typeenum or null
Normalized account type- which is a narrower and more specific grouping within the account's classification. * `BANK` - BANK * `CREDIT_CARD` - CREDIT_CARD * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE * `FIXED_ASSET` - FIXED_ASSET * `OTHER_ASSET` - OTHER_ASSET * `OTHER_CURRENT_ASSET` - OTHER_CURRENT_ASSET * `OTHER_EXPENSE` - OTHER_EXPENSE * `OTHER_INCOME` - OTHER_INCOME * `COST_OF_GOODS_SOLD` - COST_OF_GOODS_SOLD * `OTHER_CURRENT_LIABILITY` - OTHER_CURRENT_LIABILITY * `LONG_TERM_LIABILITY` - LONG_TERM_LIABILITY * `NON_POSTING` - NON_POSTING
statusenum or null
The account's status. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
Allowed values:
current_balancedouble or null
The account's current balance.
currencyenum or null
The account's currency. The currency code in ISO 4217 format.
account_numberstring or null
The account's number.
parent_accountstring or nullformat: "uuid"
ID of the parent account.
companystring or nullformat: "uuid"
The company the account belongs to.
remote_was_deletedbooleanRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information