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
enumThe account type of the account.
category
enumThe category of the account.
status
enumThe status of the account.
balance
numbernullableThe 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. This feature is currently only supported on NetSuite. A subsidiary_id query parameter can be optionally included in GET requests to filter the account results.
subsidiaries
attributescreated_at
stringnullableThe ISO 8601 timestamp that the account was created.
updated_at
stringThe ISO 8601 timestamp that the account was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_type": "bank",
"category": "asset",
"status": "active",
"balance": 123.45,
"currency_code": "USD",
"name": "Checking",
"nominal_code": "1001",
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000"
},
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
List Accounts
GET /versioned/accounting/accountsRequest Parameters
access_token
stringqueryThe access token of the connection.
account_type
enumoptionalqueryThe Rutter account type that you want to filter accounts by. Supported for the following platforms: QUICKBOOKS, NETSUITE, XERO, ZOHOBOOKS, DYNAMICS365, SAGE_INTACCT.
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
attributesaccounts
arrayaccounts
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"accounts": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_type": "bank",
"category": "asset",
"status": "active",
"balance": 123.45,
"currency_code": "USD",
"name": "Checking",
"nominal_code": "1001",
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000"
},
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch an Account
GET /versioned/accounting/accounts/:idRequest Parameters
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
attributesaccount
objectaccount
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"account": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_type": "bank",
"category": "asset",
"status": "active",
"balance": 123.45,
"currency_code": "USD",
"name": "Checking",
"nominal_code": "1001",
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000"
},
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}
Create an Account
POST /versioned/accounting/accountsRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
account
objectaccount
attributesResponse Body
Any of:
account
objectaccount
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"account": {
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"account_type": "bank",
"currency_code": "USD",
"name": "Checking",
"nominal_code": "1000"
}
}
{
"account": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_type": "bank",
"category": "asset",
"status": "active",
"balance": 123.45,
"currency_code": "USD",
"name": "Checking",
"nominal_code": "1001",
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000"
},
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}