Common ModelsAccounts

/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

expandlist of enumsOptional
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

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional
The account's name.
descriptionstring or nullOptional
The account's description.
classificationenum or nullOptional
The account's broadest grouping.
typestring or nullOptional
The account's type is a narrower and more specific grouping within the account's classification.
account_typeenum or nullOptional

Normalized account type- which is a narrower and more specific grouping within the account’s classification.

statusenum or nullOptional
The account's status.
current_balancedouble or nullOptional
The account's current balance.
currencyenum or nullOptional
The account's currency. The currency code in ISO 4217 format.
account_numberstring or nullOptional
The account's number.
parent_accountstring or nullOptionalformat: "uuid"
ID of the parent account.
companystring or nullOptionalformat: "uuid"
The company the account belongs to.
account_urlstring or nullOptionalformat: "uri"<=2000 characters
The 3rd party URL of the account.
remote_was_deletedbooleanOptionalRead-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 nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only