Accounts
The Account object is what companies use to track transactions. They can be both bank accounts or a general ledger account (also called a chart of accounts).
The Account object
Properties
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
nameString
Optional
The account's name.
descriptionString
Optional
The account's description.
classificationEnum
Optional
The account's broadest grouping. Possible values include: ASSET, EQUITY, EXPENSE, LIABILITY, REVENUE, or - in cases where there is no clear mapping - the original value passed through.
typeString
Optional
The account's type is a narrower and more specific grouping within the account's classification.
statusEnum
Optional
The account's status. Possible values include: ACTIVE, PENDING, INACTIVE, or - in cases where there is no clear mapping - the original value passed through.
current_balanceNumber
Optional
The account's current balance.
currencyEnum
Optional
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, or - in cases where there is no clear mapping - the original value passed through.
account_numberString
Optional
The account's number.
parent_accountString
Optional
ID of the parent account.
companyString
Optional
The company the account belongs to.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
modified_atString
Required
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]
Optional
The Account object
JSON
{
  "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
  "remote_id": "21",
  "name": "Cash",
  "description": "Cash",
  "classification": "ASSET",
  "type": "Asset",
  "status": "ACTIVE",
  "current_balance": 0,
  "currency": "USD",
  "account_number": "X12Y9AB",
  "parent_account": "22d92d6c-22f9-11ed-861d-0242ac120002",
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
  "remote_was_deleted": true,
Show advanced fields
}
GET
/accounts

Returns a list of Account objects.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
company_idString
Optional
If provided, will only return accounts for this company.
created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeString
Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeInteger
Optional
Number of results to return per page.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
remote_idString
Optional
The API provider's ID for the given object.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
      "remote_id": "21",
      "name": "Cash",
      "description": "Cash",
      "classification": "ASSET",
      "type": "Asset",
      "status": "ACTIVE",
      "current_balance": 0,
      "currency": "USD",
      "account_number": "X12Y9AB",
      "parent_account": "22d92d6c-22f9-11ed-861d-0242ac120002",
      "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
      "remote_was_deleted": true,
Show advanced fields
    }
  ]
}
Field support by platform
Clear Books
Clear Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
current_balanceNumber
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
FreeAgent
FreeAgent

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
descriptionString
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
current_balanceNumber
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
typeString
Moneybird
Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
currencyEnum
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
NetSuite
NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
companyString
current_balanceNumber
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
QuickBooks Online
QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
current_balanceNumber
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Sage Business Cloud Accounting
Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

classificationEnum
current_balanceNumber
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
typeString
Sage Intacct
Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
companyString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Wave Financial
Wave Financial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
current_balanceNumber
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Xero
Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Zoho Books
Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

companyString
current_balanceNumber
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST
/accounts

Creates an Account object with the given values.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.
nameString
The account's name.
descriptionString
The account's description.
classificationEnum
The account's broadest grouping. Must pass in one of the following choices: ASSET, EQUITY, EXPENSE, LIABILITY, REVENUE.
typeString
The account's type is a narrower and more specific grouping within the account's classification.
statusEnum
The account's status. Must pass in one of the following choices: ACTIVE, PENDING, INACTIVE.
current_balanceNumber
The account's current balance.
currencyEnum
The 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_numberString
The account's number.
parent_accountString
ID of the parent account. Must pass in a valid Merge ID, which can be obtained from the id field in the Parent_account object.
companyString
The 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_paramsObject
linked_account_paramsObject
POST v1/accounts
JSON
{
  "model": {
    "name": "Cash",
    "description": "Cash",
    "classification": "ASSET",
    "type": "Asset",
    "status": "ACTIVE",
    "current_balance": 0,
    "currency": "USD",
    "account_number": "X12Y9AB",
    "parent_account": "22d92d6c-22f9-11ed-861d-0242ac120002",
    "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"
  }
}
Response
JSON
{
  "model": {
    "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
    "remote_id": "21",
    "name": "Cash",
    "description": "Cash",
    "classification": "ASSET",
    "type": "Asset",
    "status": "ACTIVE",
    "current_balance": 0,
    "currency": "USD",
    "account_number": "X12Y9AB",
    "parent_account": "22d92d6c-22f9-11ed-861d-0242ac120002",
    "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
    "remote_was_deleted": true,
Show advanced fields
  }
}
Field support by platform
QuickBooks Online
QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

account_numberString
Optional
classificationEnum
Required
currencyEnum
Optional
current_balanceNumber
Optional
descriptionString
Optional
nameString
Required
parent_accountString
Optional
remote_idString
Optional
statusEnum
Optional
typeString
Required
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/accounts/{id}

Returns an Account object with the given id.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
  "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
  "remote_id": "21",
  "name": "Cash",
  "description": "Cash",
  "classification": "ASSET",
  "type": "Asset",
  "status": "ACTIVE",
  "current_balance": 0,
  "currency": "USD",
  "account_number": "X12Y9AB",
  "parent_account": "22d92d6c-22f9-11ed-861d-0242ac120002",
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
  "remote_was_deleted": true,
Show advanced fields
}
Field support by platform
Clear Books
Clear Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
current_balanceNumber
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
FreeAgent
FreeAgent

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
descriptionString
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
current_balanceNumber
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
typeString
Moneybird
Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
currencyEnum
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
NetSuite
NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
companyString
current_balanceNumber
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
QuickBooks Online
QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
current_balanceNumber
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Sage Business Cloud Accounting
Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

classificationEnum
current_balanceNumber
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
typeString
Sage Intacct
Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
companyString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Wave Financial
Wave Financial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
current_balanceNumber
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Xero
Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Zoho Books
Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

companyString
current_balanceNumber
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/accounts/meta/post

Returns metadata for Account POSTs.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Response
JSON
{
  "request_schema": {},
  "remote_field_classes": {},
  "status": {
    "linked_account_status": "string",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}
Field support by platform
Clear Books
Clear Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
current_balanceNumber
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
FreeAgent
FreeAgent

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
descriptionString
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
current_balanceNumber
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
typeString
Moneybird
Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
currencyEnum
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
NetSuite
NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
companyString
current_balanceNumber
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
QuickBooks Online
QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
current_balanceNumber
nameString
parent_accountString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Sage Business Cloud Accounting
Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

classificationEnum
current_balanceNumber
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
typeString
Sage Intacct
Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
companyString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Wave Financial
Wave Financial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
current_balanceNumber
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Xero
Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

account_numberString
classificationEnum
currencyEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Zoho Books
Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

companyString
current_balanceNumber
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
statusEnum
typeString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
Previous
Overview
Next Up
Addresses