Company Info
The CompanyInfo object is used to represent a company's information.The CompanyInfo object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
nameStringOptional
The company's name.
legal_nameStringOptional
The company's legal name.
tax_numberStringOptional
The company's tax number.
fiscal_year_end_monthIntegerOptional
The company's fiscal year end month.
fiscal_year_end_dayIntegerOptional
The company's fiscal year end day.
currencyEnumOptional
The 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, or - in cases where there is no clear mapping - the original value passed through.remote_created_atStringOptional
When the third party's company was created.
urlsArrayOptional
The company's urls.
addressesAddress[]Required
The Address object
The
Address object is used to represent a contact's or company's address.JSON
{"type": "SHIPPING","street_1": "2920 Broadway","street_2": "2nd Floor","city": "New York","state": "NY","country_subdivision": "NY","country": "USA","zip_code": "10027","modified_at": "2021-10-16T00:00:00Z"}
Properties
typeEnumOptional
The address type. Possible values include:
BILLING, SHIPPING, or - in cases where there is no clear mapping - the original value passed through.street_1StringOptional
Line 1 of the address's street.
street_2StringOptional
Line 2 of the address's street.
cityStringOptional
The address's city.
stateAnyOptional
The address's state or region.
country_subdivisionStringOptional
The address's state or region.
countryEnumOptional
The 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, or - in cases where there is no clear mapping - the original value passed through.zip_codeStringOptional
The address's zip code.
modified_atStringRequired
This is the datetime that this object was last updated by Merge
phone_numbersAccountingPhoneNumber[]Required
The AccountingPhoneNumber object
The
AccountingPhoneNumber object is used to represent a contact's or company's phone number.JSON
{"number": "+3198675309","type": "Mobile","modified_at": "2021-10-16T00:00:00Z"}
Properties
numberStringOptional
The phone number.
typeStringOptional
The phone number's type.
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]Optional
The CompanyInfo object
JSON
{"id": "65d8ffd0-211b-4ba4-b85a-fbe2ce220982","remote_id": "19202938","name": "Merge Pickleball Company","legal_name": "Merge Pickleball Company Inc.","tax_number": "11-0011000","fiscal_year_end_month": 12,"fiscal_year_end_day": 31,"currency": "USD","remote_created_at": "2020-03-31T00:00:00Z","urls": "https://www.merge.dev","addresses": [{"street_1": "2920 Broadway","street_2": "2nd Floor","city": "New York","state": "NY","country": "USA","zip_code": "10027"}],"phone_numbers": [{"number": "+3198675309","type": "Mobile","modified_at": "2021-10-16T00:00:00Z"}],"remote_was_deleted": true,Show advanced fields}
GET
/company-info
Returns a list of CompanyInfo objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
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_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "65d8ffd0-211b-4ba4-b85a-fbe2ce220982","remote_id": "19202938","name": "Merge Pickleball Company","legal_name": "Merge Pickleball Company Inc.","tax_number": "11-0011000","fiscal_year_end_month": 12,"fiscal_year_end_day": 31,"currency": "USD","remote_created_at": "2020-03-31T00:00:00Z","urls": "https://www.merge.dev","addresses": [{"street_1": "2920 Broadway","street_2": "2nd Floor","city": "New York","state": "NY","country": "USA","zip_code": "10027"}],"phone_numbers": [{"number": "+3198675309","type": "Mobile","modified_at": "2021-10-16T00:00:00Z"}],"remote_was_deleted": true,Show advanced fields}]}
Field support by platform
FreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringmodified_atstringcurrencyEnumlegal_nameStringnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberString
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringmodified_atstringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberString
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumlegal_nameStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberStringurlsArray
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringremote_created_atStringremote_idString
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringmodified_atstringcurrencyEnumfiscal_year_end_dayIntegerfiscal_year_end_monthIntegernameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberStringurlsArray
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumlegal_nameStringnameStringremote_idStringtax_numberString
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringurlsArray
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumnameStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumfiscal_year_end_dayIntegerfiscal_year_end_monthIntegerlegal_nameStringnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberStringurlsArray
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/company-info/{id}
Returns a CompanyInfo object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"id": "65d8ffd0-211b-4ba4-b85a-fbe2ce220982","remote_id": "19202938","name": "Merge Pickleball Company","legal_name": "Merge Pickleball Company Inc.","tax_number": "11-0011000","fiscal_year_end_month": 12,"fiscal_year_end_day": 31,"currency": "USD","remote_created_at": "2020-03-31T00:00:00Z","urls": "https://www.merge.dev","addresses": [{"street_1": "2920 Broadway","street_2": "2nd Floor","city": "New York","state": "NY","country": "USA","zip_code": "10027"}],"phone_numbers": [{"number": "+3198675309","type": "Mobile","modified_at": "2021-10-16T00:00:00Z"}],"remote_was_deleted": true,Show advanced fields}
Field support by platform
FreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringMicrosoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringmodified_atstringcurrencyEnumlegal_nameStringnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberStringMoneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringmodified_atstringnameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberStringNetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumlegal_nameStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberStringurlsArrayQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringremote_created_atStringremote_idStringSage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]typestringstreet_1stringstreet_2stringcitystringstatestringcountry_subdivisionstringcountrystringzip_codestringmodified_atstringcurrencyEnumfiscal_year_end_dayIntegerfiscal_year_end_monthIntegernameStringphone_numbersAccountingPhoneNumber[]numberstringtypestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberStringurlsArraySage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumlegal_nameStringnameStringremote_idStringtax_numberStringWave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringurlsArrayWorkday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumfiscal_year_end_dayIntegerfiscal_year_end_monthIntegerlegal_nameStringnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtax_numberStringurlsArrayZoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumfiscal_year_end_monthIntegerlegal_nameStringnameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringHint: Use the /linked-accounts endpoint to pull platform support information.