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

idstring

The Rutter generated unique ID of the object.

platform_idstringnullable

The platform specific ID of the object.

base_currency_codeenum

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, ZMW, ETH, or BTC.

createdAtstring

The ISO 8601 timestamp that the object was created.

namestring

The DBA name of the company.

updatedAtstring

The ISO 8601 timestamp that the object was last updated.

addressesarray

A list of addresses linked to the company.

String array.

legal_namestringOptional

The legal name of the company.

additional_fieldsobjectOptional

Additional fields required only for a narrow set of use cases.

Show additional_fields attributes

last_synced_atstringfilterable

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

platform_dataobjectOptional

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.

expandarrayqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

One or more ofplatform_data.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

200

Example Response Body

JSON

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

Have questions?

Contact support for personalized guidance.

Contact support