The Subsidiary object
Rutter Subsidiaries contains basic information about legal entities within a business.
Properties
id
stringThe Rutter generated unique ID of the subsidiary.
platform_id
stringThe platform specific ID of the subsidiary.
parent_id
stringnullableThe Rutter generated unique ID of the parent subsidiary.
country
stringThe country of the subsidiary.
status
enumThe status of the subsidiary
currency_code
stringnullableThe ISO 4217 currency code of the subsidiary.
name
stringnullableThe name of the subsidiary.
updated_at
stringnullableThe ISO 8601 timestamp that the subsidiary was last updated.
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"parent_id": "00000000-0000-0000-0000-000000000000",
"country": "USA",
"status": "active",
"currency_code": "USD",
"name": "Johnson & Johnson LLC",
"updated_at": "2023-01-02T02:34:56.000Z"
}
List Subsidiaries
GET /accounting/subsidiariesRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributessubsidiaries
arraysubsidiaries
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"parent_id": "00000000-0000-0000-0000-000000000000",
"country": "USA",
"status": "active",
"currency_code": "USD",
"name": "Johnson & Johnson LLC",
"updated_at": "2023-01-02T02:34:56.000Z"
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch a Subsidiary
GET /accounting/subsidiaries/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectconnection
attributessubsidiary
objectsubsidiary
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"subsidiary": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"parent_id": "00000000-0000-0000-0000-000000000000",
"country": "USA",
"status": "active",
"currency_code": "USD",
"name": "Johnson & Johnson LLC",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}