Accounts
The Account Object
A Rutter Account represents an account contained within the business entity's chart of accounts. Every account is part of one of the five categories asset
, liability
, equity
, income
, and expense
, and contains an account_type
representing the sub-category of account. The account object also contains a balance representing the running sum of all credits and debits applied against the account.
Properties
id
stringThe Rutter generated unique ID of the account.
platform_id
stringThe platform specific ID of the account.
parent_id
stringnullableOptionalThe Rutter ID of the Parent Account linked to the account. Supported for QuickBooks.
account_type
enumfilterableThe account type of the account.
category
enumThe category of the account.
status
enumfilterableThe status of the account.
balance
numberfilterablenullableThe running balance of all credits and debits applied to the account.
currency_code
enumnullableThe ISO 4217 currency code of the account.
name
stringfilterablenullableThe business facing name of the account.
nominal_code
stringnullableThe nominal code of the account used to classify accounts by department or account type.
subsidiaries
arrayAn array of Subsidiaries linked to the account. Supported for NetSuite. A subsidiary_id query parameter can be optionally included in GET requests to filter the account results.
subsidiaries
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the account was created.
updated_at
stringfilterableThe ISO 8601 timestamp that the account was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the account was last synced by Rutter.
platform_url
stringnullableA URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Accounts
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalNot currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable
tag in the response object.
Filterable fields: created_at
, updated_at
, name
, balance
, account_type
, status
, last_synced_at
.
sort
stringqueryOptionalUsed to sort the response objects, e.g. last_synced_at ASC
. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
. Supports only fields decorated with a filterable
tag in the response object except on Sage Intacct and Dynamics 365 Business Central. For those platforms, only updated_at_min
, updated_at_max
and last_synced_at_min
fields are supported and not deprecated.
Sortable fields: created_at
, updated_at
, name
, balance
, account_type
, status
, last_synced_at
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
account_type
enumfilterablequeryOptionalDeprecated - use filter
instead. The exact account type to filter on.
last_synced_at_min
integerqueryOptionalDeprecated - use filter
instead. Used to filter objects with a last_synced_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_max
integerqueryOptionalDeprecated - use filter
instead. Used to filter objects with a updated_at
value less than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_min
integerqueryOptionalDeprecated - use filter
instead. Used to filter objects with a updated_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
1{
2 "accounts": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "parent_id": "00000000-0000-0000-0000-000000000000",
7 "account_type": "bank",
8 "category": "asset",
9 "status": "active",
10 "balance": 123.45,
11 "currency_code": "USD",
12 "name": "Checking",
13 "nominal_code": "1001",
14 "subsidiaries": [
15 {
16 "id": "00000000-0000-0000-0000-000000000000"
17 },
18 {
19 "id": "00000000-0000-0000-0000-000000000000"
20 }
21 ],
22 "created_at": "2023-01-02T02:34:56.000Z",
23 "updated_at": "2023-01-02T02:34:56.000Z",
24 "last_synced_at": "2023-01-02T02:34:56.000Z",
25 "platform_url": "https://platform.com/resource?id=123",
26 "platform_data": {
27 "id": 123,
28 "data": "Varies by platform"
29 }
30 }
31 ],
32 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
33 "connection": {
34 "id": "00000000-0000-0000-0000-000000000000",
35 "orgId": "00000000-0000-0000-0000-000000000000",
36 "platform": "NETSUITE"
37 }
38}
Fetch an Account
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not currently supported on Sage Intacct or Sage Business Cloud.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
1{
2 "account": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "parent_id": "00000000-0000-0000-0000-000000000000",
6 "account_type": "bank",
7 "category": "asset",
8 "status": "active",
9 "balance": 123.45,
10 "currency_code": "USD",
11 "name": "Checking",
12 "nominal_code": "1001",
13 "subsidiaries": [
14 {
15 "id": "00000000-0000-0000-0000-000000000000"
16 },
17 {
18 "id": "00000000-0000-0000-0000-000000000000"
19 }
20 ],
21 "created_at": "2023-01-02T02:34:56.000Z",
22 "updated_at": "2023-01-02T02:34:56.000Z",
23 "last_synced_at": "2023-01-02T02:34:56.000Z",
24 "platform_url": "https://platform.com/resource?id=123",
25 "platform_data": {
26 "id": 123,
27 "data": "Varies by platform"
28 }
29 },
30 "connection": {
31 "id": "00000000-0000-0000-0000-000000000000",
32 "orgId": "00000000-0000-0000-0000-000000000000",
33 "platform": "NETSUITE"
34 }
35}
Create an Account
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe response mode for our async endpoints. prefer_sync
allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async
makes the API respond with the asynchronous response. See Asynchronous Operations.
account
objectaccount
attributesResponse Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
1{
2 "account": {
3 "parent_id": "00000000-0000-0000-0000-000000000000",
4 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
5 "account_type": "bank",
6 "currency_code": "USD",
7 "name": "Checking",
8 "nominal_code": "1000"
9 }
10}
1{
2 "account": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "parent_id": "00000000-0000-0000-0000-000000000000",
6 "account_type": "bank",
7 "category": "asset",
8 "status": "active",
9 "balance": 123.45,
10 "currency_code": "USD",
11 "name": "Checking",
12 "nominal_code": "1001",
13 "subsidiaries": [
14 {
15 "id": "00000000-0000-0000-0000-000000000000"
16 },
17 {
18 "id": "00000000-0000-0000-0000-000000000000"
19 }
20 ],
21 "created_at": "2023-01-02T02:34:56.000Z",
22 "updated_at": "2023-01-02T02:34:56.000Z",
23 "last_synced_at": "2023-01-02T02:34:56.000Z",
24 "platform_url": "https://platform.com/resource?id=123",
25 "platform_data": {
26 "id": 123,
27 "data": "Varies by platform"
28 }
29 }
30}
Update an Account
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe response mode for our async endpoints. prefer_sync
allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async
makes the API respond with the asynchronous response. See Asynchronous Operations.
account
objectaccount
attributesResponse Body
- QuickBooks
- NetSuite
1{
2 "account": {
3 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
4 "name": "Checking 1001",
5 "nominal_code": "1001"
6 }
7}
1{
2 "account": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "parent_id": "00000000-0000-0000-0000-000000000000",
6 "account_type": "bank",
7 "category": "asset",
8 "status": "active",
9 "balance": 123.45,
10 "currency_code": "USD",
11 "name": "Checking",
12 "nominal_code": "1001",
13 "subsidiaries": [
14 {
15 "id": "00000000-0000-0000-0000-000000000000"
16 },
17 {
18 "id": "00000000-0000-0000-0000-000000000000"
19 }
20 ],
21 "created_at": "2023-01-02T02:34:56.000Z",
22 "updated_at": "2023-01-02T02:34:56.000Z",
23 "last_synced_at": "2023-01-02T02:34:56.000Z",
24 "platform_url": "https://platform.com/resource?id=123",
25 "platform_data": {
26 "id": 123,
27 "data": "Varies by platform"
28 }
29 }
30}
Have questions?
Contact support for personalized guidance.