The Company Info object
A Rutter Company Info contains basic information about the business entity like their contact name, business name, and default currency.
Properties
id
stringThe Rutter generated unique ID of the object.
name
stringThe DBA name of the company.
legal_name
stringoptionalThe legal name of the company.
addresses
arrayA list of addresses linked to the company.
String array.
platform_id
stringnullableThe platform specific ID of the object.
createdAt
stringThe ISO 8601 timestamp that the object was created.
updatedAt
stringThe ISO 8601 timestamp that the object was last updated.
base_currency_code
enumThe ISO 4217 currency code of the company.
One ofAED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, or ZMW.
Example CompanyInfo Object
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"name": "Rutter API",
"legal_name": "RutterAPI Inc.",
"addresses": [
"123 Rutter Road, San Francisco, CA 94110"
],
"base_currency_code": "USD",
"createdAt": "2023-01-02T02:34:56.000Z",
"updatedAt": "2023-01-02T02:34:56.000Z"
}
Fetch Company Info
GET /accounting/company_infoSupported for: Dynamics 365Fresh BooksNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctWaveXeroZoho Books
Request Parameters
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
One oftrue or false.
Response Body
connection
ConnectionShow
connection
attributescompany_info
Company InfoShow
company_info
attributesExample Response Body
{
"company_info": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"name": "Rutter API",
"legal_name": "RutterAPI Inc.",
"addresses": [
"123 Rutter Road, San Francisco, CA 94110"
],
"base_currency_code": "USD",
"createdAt": "2023-01-02T02:34:56.000Z",
"updatedAt": "2023-01-02T02:34:56.000Z"
},
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE",
"orgId": "00000000-0000-0000-0000-000000000000"
}
}