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
id
stringRequiredThe Rutter generated unique ID of the object.
platform_id
stringnullableRequiredThe platform specific ID of the object.
base_currency_code
enumRequiredThe ISO 4217 currency code of the company.
createdAt
stringRequiredThe ISO 8601 timestamp that the object was created.
name
stringRequiredThe DBA name of the company.
updatedAt
stringRequiredThe ISO 8601 timestamp that the object was last updated.
addresses
arrayRequiredA list of addresses linked to the company.
String array.
legal_name
stringThe legal name of the company.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the company info was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
Fetch Company Info
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectRequiredconnection
attributescompany_info
objectRequiredcompany_info
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
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 "base_currency_code": "USD",
11 "createdAt": "2023-01-02T02:34:56.000Z",
12 "name": "Rutter API",
13 "updatedAt": "2023-01-02T02:34:56.000Z",
14 "addresses": [
15 "123 Rutter Road, San Francisco, CA 94110"
16 ],
17 "legal_name": "RutterAPI Inc.",
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.