Accounts

The Account object is what businesses use to track transactions. Accountants often call accounts "ledgers".

The Account object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

remote_dataRemoteData[]
Optional

nameString
Optional
The account's name.

descriptionString
Optional
The account's description.

classificationEnum
Optional
The account's classification. 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.

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.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

The Account object
JSON
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "21",
"remote_data": [
{
"path": "/actions",
"data": [
"Varies by platform"
]
}
],
"name": "Cash",
"description": "Cash",
"classification": "ASSET",
"type": "Asset",
"status": "ACTIVE",
"current_balance": 0,
"currency": "USD",
"account_number": "X12Y9AB",
"remote_was_deleted": true
}

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


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.

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, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Which fields should be returned in non-normalized form.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "21",
"remote_data": [
{
"path": "/actions",
"data": [
"Varies by platform"
]
}
],
"name": "Cash",
"description": "Cash",
"classification": "ASSET",
"type": "Asset",
"status": "ACTIVE",
"current_balance": 0,
"currency": "USD",
"account_number": "X12Y9AB",
"remote_was_deleted": 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[]

remote_idString

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

classificationEnum

current_balanceNumber

nameString

remote_idString

statusEnum

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

classificationEnum

currencyEnum

current_balanceNumber

nameString

remote_dataRemoteData[]

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[]

remote_idString

typeString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


classificationEnum

currencyEnum

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

typeString

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


current_balanceNumber

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

typeString
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


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
Which fields should be returned in non-normalized form.
Response
JSON
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "21",
"remote_data": [
{
"path": "/actions",
"data": [
"Varies by platform"
]
}
],
"name": "Cash",
"description": "Cash",
"classification": "ASSET",
"type": "Asset",
"status": "ACTIVE",
"current_balance": 0,
"currency": "USD",
"account_number": "X12Y9AB",
"remote_was_deleted": 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[]

remote_idString

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

classificationEnum

current_balanceNumber

nameString

remote_idString

statusEnum

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

classificationEnum

currencyEnum

current_balanceNumber

nameString

remote_dataRemoteData[]

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[]

remote_idString

typeString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


classificationEnum

currencyEnum

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

typeString

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


current_balanceNumber

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

typeString
Hint: Use the /linked-accounts endpoint to pull platform support information.