Accounts
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
Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
nameStringOptional
The account's name.
descriptionStringOptional
The account's description.
classificationEnumOptional
The account's broadest grouping. Possible values include:
ASSET, EQUITY, EXPENSE, LIABILITY, REVENUE. In cases where there is no clear mapping, the original value passed through will be returned.typeStringOptional
The account's type is a narrower and more specific grouping within the account's classification.
statusEnumOptional
The account's status. Possible values include:
ACTIVE, PENDING, INACTIVE. In cases where there is no clear mapping, the original value passed through will be returned.current_balanceNumberOptional
The account's current balance.
currencyEnumOptional
The account's currency. Possible values include:
XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL. In cases where there is no clear mapping, the original value passed through will be returned.account_numberStringOptional
The account's number.
parent_accountUUIDOptional
ID of the parent account.
companyUUIDOptional
The company the account belongs to.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
created_atDateTime (ISO 8601)Required
modified_atDateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/accounts
https://api.merge.dev/api/accounting/v1/accounts
US
EU
Returns a list of Account objects.
Query & Path Parameters
company_idStringOptional
If provided, will only return accounts for this company.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Field support by integration
See all supported fields
Clear Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
currencyEnumcurrent_balanceNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idString
FreeAgent
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumdescriptionStringnameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Microsoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumcurrent_balanceNumberdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtypeString
Moneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringcurrencyEnumnameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeString
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcompanyUUIDcurrent_balanceNumbernameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeString
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumcurrent_balanceNumberdescriptionStringnameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeString
Sage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
classificationEnumcurrent_balanceNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtypeString
Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcompanyUUIDnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeString
Wave Financial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumcurrent_balanceNumberdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeString
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeString
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeString
Zoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
companyUUIDcurrent_balanceNumberdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringPOST
/accounts
https://api.merge.dev/api/accounting/v1/accounts
US
EU
Creates an Account object with the given values.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.nameStringThe account's name.
descriptionStringThe account's description.
classificationEnumThe account's broadest grouping. Must pass in one of the following choices:
ASSET, EQUITY, EXPENSE, LIABILITY, REVENUE.typeStringThe account's type is a narrower and more specific grouping within the account's classification.
statusEnumThe account's status. Must pass in one of the following choices:
ACTIVE, PENDING, INACTIVE.current_balanceNumberThe account's current balance.
currencyEnumThe account's currency. Must pass in one of the following choices:
XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL.account_numberStringThe account's number.
parent_accountUUIDID of the parent account. Must pass in a valid Merge ID, which can be obtained from the
id field in the Parent_account object.companyUUIDThe company the account belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the Company object.integration_paramsObjectlinked_account_paramsObjectField support by integration
See all supported fieldsQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API.
Supported POST Model Parameters
account_numberStringOptional
classificationEnumRequired
currencyEnumOptional
current_balanceNumberOptional
descriptionStringOptional
nameStringRequired
parent_accountUUIDOptional
remote_idStringOptional
statusEnumOptional
typeStringRequired
To include the correct model fields when making POST requests, use the GET /accounts/meta/post endpoint. Learn more in our /meta guide.
GET
/accounts/{id}
https://api.merge.dev/api/accounting/v1/accounts/{id}
US
EU
Returns an Account object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Field support by integration
See all supported fieldsClear Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
currencyEnumcurrent_balanceNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringFreeAgent
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumdescriptionStringnameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringMicrosoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumcurrent_balanceNumberdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtypeStringMoneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringcurrencyEnumnameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcompanyUUIDcurrent_balanceNumbernameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumcurrent_balanceNumberdescriptionStringnameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringSage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
classificationEnumcurrent_balanceNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtypeStringSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcompanyUUIDnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringWave Financial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumcurrent_balanceNumberdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringZoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
companyUUIDcurrent_balanceNumberdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringGET
/accounts/meta/post
https://api.merge.dev/api/accounting/v1/accounts/meta/post
US
EU
Returns metadata for Account POSTs.
Field support by integration
See all supported fieldsClear Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
currencyEnumcurrent_balanceNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringFreeAgent
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumdescriptionStringnameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringMicrosoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumcurrent_balanceNumberdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtypeStringMoneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringcurrencyEnumnameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcompanyUUIDcurrent_balanceNumbernameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumcurrent_balanceNumberdescriptionStringnameStringparent_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringSage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
classificationEnumcurrent_balanceNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtypeStringSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcompanyUUIDnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringWave Financial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumcurrent_balanceNumberdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account_numberStringclassificationEnumcurrencyEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeStringZoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
companyUUIDcurrent_balanceNumberdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtypeString