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

idstringRequired

The Rutter generated unique ID of the account.

platform_idstringRequired

The platform specific ID of the account.

account_typeenumRequired

The account type of the account.

One ofaccounts_payableaccounts_receivablebankfixed_assetother_assetother_current_assetliabilityequityexpenseother_expenseincomeother_incomecredit_cardcost_of_goods_soldother_current_liabilitylong_term_liabilitynon_posting, or unknown.
categoryenumRequired

The category of the account.

One ofassetexpenseequityliabilityincomenonposting, or unknown.
statusenumRequired

The status of the account.

One ofactiveinactive, or pending.
balancenumbernullableRequired

The running balance of all credits and debits applied to the account.

currency_codeenumnullableRequired

The ISO 4217 currency code of the account.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
namestringnullableRequired

The business facing name of the account.

nominal_codestringnullableRequired

The nominal code of the account used to classify accounts by department or account type.

subsidiariesarrayRequired

An 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.

Show subsidiaries attributes
created_atstringnullableRequired

The ISO 8601 timestamp that the account was created.

updated_atstringRequired

The ISO 8601 timestamp that the account was last updated.

last_synced_atstringRequired

The ISO 8601 timestamp when the account was last synced by Rutter.

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/accounts
GET
/accounting/accounts/:id
POST
/accounting/accounts

List Accounts

GEThttps://production.rutterapi.com/versioned/accounting/accounts

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    account_typeenumquery

    The Rutter account type that you want to filter accounts by. Supported for the following platforms: QUICKBOOKS, NETSUITE, XERO, ZOHOBOOKS, DYNAMICS365, SAGE_INTACCT.

    One ofaccounts_payableaccounts_receivablebankfixed_assetother_assetother_current_assetliabilityequityexpenseother_expenseincomeother_incomecredit_cardcost_of_goods_soldother_current_liabilitylong_term_liabilitynon_posting, or unknown.
    cursorstringquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    last_synced_at_minintegerquery

    Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

    limitintegerquery

    The limit on the number of entities returned.

    sortstringquery

    The field and direction to sort by (ASC or DESC), e.g. last_synced_at ASC. Currently supports the fields: updated_at, last_synced_at. If a field is provided but ASC or DESC is not, defaults to ASC. If this field is omitted, defaults, to updated_at DESC.

    updated_at_maxintegerquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegerquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    connectionobjectRequired
    Show connection attributes
    accountsarrayRequired
    Show accounts attributes
    next_cursorstringnullable
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{
2
"connection": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"orgId": "00000000-0000-0000-0000-000000000000",
5
"platform": "NETSUITE"
6
},
7
"accounts": [
8
{
9
"id": "00000000-0000-0000-0000-000000000000",
10
"platform_id": "12345678",
11
"account_type": "bank",
12
"category": "asset",
13
"status": "active",
14
"balance": 123.45,
15
"currency_code": "USD",
16
"name": "Checking",
17
"nominal_code": "1001",
18
"subsidiaries": [
19
{
20
"id": "00000000-0000-0000-0000-000000000000"
21
},
22
{
23
"id": "00000000-0000-0000-0000-000000000000"
24
}
25
],
26
"created_at": "2023-01-02T02:34:56.000Z",
27
"updated_at": "2023-01-02T02:34:56.000Z",
28
"last_synced_at": "2023-01-02T02:34:56.000Z",
29
"platform_data": {
30
"id": 123,
31
"data": "Varies by platform"
32
}
33
}
34
],
35
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
36
}

Fetch an Account

GEThttps://production.rutterapi.com/versioned/accounting/accounts/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    id_typeenumquery

    Optionally, search for a connection by Rutter ID or platform ID. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    One ofrutter or platform.

Response Body

    connectionobjectRequired
    Show connection attributes
    accountobjectRequired
    Show account attributes
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{
2
"connection": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"orgId": "00000000-0000-0000-0000-000000000000",
5
"platform": "NETSUITE"
6
},
7
"account": {
8
"id": "00000000-0000-0000-0000-000000000000",
9
"platform_id": "12345678",
10
"account_type": "bank",
11
"category": "asset",
12
"status": "active",
13
"balance": 123.45,
14
"currency_code": "USD",
15
"name": "Checking",
16
"nominal_code": "1001",
17
"subsidiaries": [
18
{
19
"id": "00000000-0000-0000-0000-000000000000"
20
},
21
{
22
"id": "00000000-0000-0000-0000-000000000000"
23
}
24
],
25
"created_at": "2023-01-02T02:34:56.000Z",
26
"updated_at": "2023-01-02T02:34:56.000Z",
27
"last_synced_at": "2023-01-02T02:34:56.000Z",
28
"platform_data": {
29
"id": 123,
30
"data": "Varies by platform"
31
}
32
}
33
}

Create an Account

POSThttps://production.rutterapi.com/versioned/accounting/accounts

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    accountobjectRequired
    Show account attributes

Response Body

    Any of:

    accountobjectRequired
    Show account attributes
    async_responseobject
    Show async_response attributes
    errorsarray
    Show errors attributes
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Request Body
JSON
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
}
Example Response Body
JSON
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_data": {
24
"id": 123,
25
"data": "Varies by platform"
26
}
27
}
28
}

Have questions?

Contact support for personalized guidance.

Contact support