For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Account object
          • GET/accounts
          • POST/accounts
          • GET/accounts/{id}
          • GET/accounts/meta/post
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsAccounts

The Account object

The Account Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "name": "string",
7  "description": "string",
8  "classification": "ASSET",
9  "type": "string",
10  "account_type": "BANK",
11  "status": "ACTIVE",
12  "current_balance": 1,
13  "currency": "XUA",
14  "account_number": "string",
15  "parent_account": "string",
16  "company": "string",
17  "remote_was_deleted": true,
18  "field_mappings": {},
19  "remote_data": [
20    {
21      "path": "string",
22      "data": {}
23    }
24  ]
25}
Was this page helpful?
Previous

/accounting-periods/{id}

Next

/accounts

Built with

An Account represents a category in a company’s ledger in which a financial transaction is recorded against. The aggregation of each Account object is often referred to as the Chart of Accounts.

An Account can be classified into one of the following categories, determined through the classification field:

  • Asset: Accounts Receivable and Bank Accounts
  • Liability: Accounts Payable and Credit Card Accounts
  • Equity: Treasury Accounts and Retained Earnings
  • Revenue: Income and Other Income
  • Expense: Cost of Goods Sold and Office Expenses
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.

  • ASSET - ASSET
  • EQUITY - EQUITY
  • EXPENSE - EXPENSE
  • LIABILITY - LIABILITY
  • REVENUE - REVENUE
Allowed values:
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.

  • 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 nullOptional

The account's status.

  • ACTIVE - ACTIVE
  • PENDING - PENDING
  • INACTIVE - INACTIVE
Allowed values:
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.
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