Company Info
The
CompanyInfo object contains information about the company of the linked account. If the company has multiple entities (also known as subsidiaries), each entity may show up as a single CompanyInfo record.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
nameStringThe company's name.
legal_nameStringThe company's legal name.
tax_numberStringThe company's tax number.
fiscal_year_end_monthIntegerThe company's fiscal year end month.
fiscal_year_end_dayIntegerThe company's fiscal year end day.
currencyEnumThe currency set in the company's accounting platform. 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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_created_atDateTime (ISO 8601)When the third party's company was created.
urlsArrayThe company's urls.
addressesAddress[]The Address object
The
Address object is used to represent a contact's or company's address.Properties
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
typeEnumThe address type. Possible values include:
BILLING, SHIPPING. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.street_1StringLine 1 of the address's street.
street_2StringLine 2 of the address's street.
cityStringThe address's city.
stateAnyThe address's state or region.
country_subdivisionStringThe address's state or region.
countryEnumThe address's country. Possible values include:
AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.zip_codeStringThe address's zip code.
phone_numbersAccountingPhoneNumber[]The AccountingPhoneNumber object
The
AccountingPhoneNumber object is used to represent a contact's or company's phone number.Properties
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
numberStringThe phone number.
typeStringThe phone number's type.
remote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/company-info
https://api.merge.dev/api/accounting/v1/company-info
US
EU
APAC
Returns a list of CompanyInfo objects.
Query & path parameters
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
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.
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).
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.
nameStringOptional
If provided, will only return CompanyInfo objects with this name.
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
FreeAgent
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnumnameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_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
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberString
Microsoft Dynamics Finance and Operations
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringcountry_subdivisionstringcountrystringzip_codestringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberString
Moneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringcountrystringzip_codestringnameStringphone_numbersAccountingPhoneNumber[]numberstringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberString
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumlegal_nameStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringurlsArray
QuickBooks Desktop
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_dataRemoteData[]pathstringdatastringurlsArray
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
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
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
addressesAddress[]street_1stringstreet_2stringcitystringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumfiscal_year_end_dayIntegerfiscal_year_end_monthIntegernameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringurlsArray
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
currencyEnumlegal_nameStringnameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberString
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
addressesAddress[]street_1stringstreet_2stringcitystringcountrystringzip_codestringcurrencyEnumnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringurlsArray
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringcountrystringzip_codestringcurrencyEnumfiscal_year_end_dayIntegerfiscal_year_end_monthIntegerlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringurlsArray
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
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountrystringzip_codestringcurrencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringGET
/company-info/{id}
https://api.merge.dev/api/accounting/v1/company-info/{id}
US
EU
APAC
Returns a CompanyInfo 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.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
FreeAgent
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnumnameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringFreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_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
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringMicrosoft Dynamics Finance and Operations
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringcountry_subdivisionstringcountrystringzip_codestringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringMoneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringcountrystringzip_codestringnameStringphone_numbersAccountingPhoneNumber[]numberstringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumlegal_nameStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringurlsArrayQuickBooks Desktop
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_dataRemoteData[]pathstringdatastringurlsArrayQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringSage 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
addressesAddress[]street_1stringstreet_2stringcitystringcountry_subdivisionstringcountrystringzip_codestringcurrencyEnumfiscal_year_end_dayIntegerfiscal_year_end_monthIntegernameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringurlsArraySage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnumlegal_nameStringnameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringWave Financial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringcountrystringzip_codestringcurrencyEnumnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringurlsArrayWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringcountrystringzip_codestringcurrencyEnumfiscal_year_end_dayIntegerfiscal_year_end_monthIntegerlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtax_numberStringurlsArrayZoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountrystringzip_codestringcurrencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringphone_numbersAccountingPhoneNumber[]numberstringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString