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.
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
stringnullableThe 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
stringqueryOptionalUsed to specify criteria to filter out the objects returned. Supports all filterable
fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
sort
stringqueryOptionalUsed to sort the returned objects, e.g. last_synced_at ASC
. Supports all filterable
fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at
and last_synced_at
fields are supported. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
account_type
enumqueryOptionalDeprecated - 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
accounts
arrayaccounts
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "accounts": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
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 ],
31 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
32 "connection": {
33 "id": "00000000-0000-0000-0000-000000000000",
34 "orgId": "00000000-0000-0000-0000-000000000000",
35 "platform": "NETSUITE"
36 }
37}
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 supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
account
objectaccount
attributesconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "account": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_type": "bank",
6 "category": "asset",
7 "status": "active",
8 "balance": 123.45,
9 "currency_code": "USD",
10 "name": "Checking",
11 "nominal_code": "1001",
12 "subsidiaries": [
13 {
14 "id": "00000000-0000-0000-0000-000000000000"
15 },
16 {
17 "id": "00000000-0000-0000-0000-000000000000"
18 }
19 ],
20 "created_at": "2023-01-02T02:34:56.000Z",
21 "updated_at": "2023-01-02T02:34:56.000Z",
22 "last_synced_at": "2023-01-02T02:34:56.000Z",
23 "platform_url": "https://platform.com/resource?id=123",
24 "platform_data": {
25 "id": 123,
26 "data": "Varies by platform"
27 }
28 },
29 "connection": {
30 "id": "00000000-0000-0000-0000-000000000000",
31 "orgId": "00000000-0000-0000-0000-000000000000",
32 "platform": "NETSUITE"
33 }
34}
Create an Account
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
account
objectaccount
attributesResponse Body
Any of:
account
objectaccount
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "account": {
3 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
4 "account_type": "bank",
5 "currency_code": "USD",
6 "name": "Checking",
7 "nominal_code": "1000"
8 }
9}
1{
2 "account": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_type": "bank",
6 "category": "asset",
7 "status": "active",
8 "balance": 123.45,
9 "currency_code": "USD",
10 "name": "Checking",
11 "nominal_code": "1001",
12 "subsidiaries": [
13 {
14 "id": "00000000-0000-0000-0000-000000000000"
15 },
16 {
17 "id": "00000000-0000-0000-0000-000000000000"
18 }
19 ],
20 "created_at": "2023-01-02T02:34:56.000Z",
21 "updated_at": "2023-01-02T02:34:56.000Z",
22 "last_synced_at": "2023-01-02T02:34:56.000Z",
23 "platform_url": "https://platform.com/resource?id=123",
24 "platform_data": {
25 "id": 123,
26 "data": "Varies by platform"
27 }
28 }
29}
Have questions?
Contact support for personalized guidance.