Company Info

The CompanyInfo Object

A Rutter Company Info contains basic information about the business entity like their contact name, business name, and default currency.

Properties

idstringRequired

The Rutter generated unique ID of the object.

platform_idstringnullableRequired

The platform specific ID of the object.

currency_codeenumRequired

The 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, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, 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.

namestringRequired

The DBA name of the company.

addressesarrayRequired

A list of addresses linked to the company.

String array.

legal_namestringnullableRequired

The legal name of the company.

created_atstringRequired

The ISO 8601 timestamp that the object was created.

updated_atstringRequired

The ISO 8601 timestamp that the object was last updated.

last_synced_atstringRequired

The ISO 8601 timestamp when the company info was last synced by Rutter.

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/company_info

Fetch Company Info

GEThttps://production.rutterapi.com/versioned/accounting/company_info

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

force_fetchenumquery

Force a response even if the underlying connection hasn't finished the initial sync.

One oftrue or false.

Response Body

connectionobjectRequired

Show connection attributes

company_infoobjectRequired

Show company_info attributes

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

Example Response Body

JSON

1{
2  "connection": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "orgId": "00000000-0000-0000-0000-000000000000",
5    "platform": "NETSUITE"
6  },
7  "company_info": {
8    "id": "00000000-0000-0000-0000-000000000000",
9    "platform_id": "12345678",
10    "currency_code": "USD",
11    "name": "Rutter API",
12    "addresses": [
13      "123 Rutter Road, San Francisco, CA 94110"
14    ],
15    "legal_name": "RutterAPI Inc.",
16    "created_at": "2023-01-02T02:34:56.000Z",
17    "updated_at": "2023-01-02T02:34:56.000Z",
18    "last_synced_at": "2023-01-02T02:34:56.000Z",
19    "platform_data": {
20      "id": 123,
21      "data": "Varies by platform"
22    }
23  }
24}

Have questions?

Contact support for personalized guidance.

Contact support