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

idstring

The Rutter generated unique ID of the account.

platform_idstring

The platform specific ID of the account.

account_typeenumfilterable

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

The category of the account.

One ofassetexpenseequityliabilityincomenonposting, or unknown.
statusenumfilterable

The status of the account.

One ofactiveinactive, or pending.
currency_codeenumnullable

The ISO 4217 currency code of the account.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
current_balancenumbernullable

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

namestringnullable

The business facing name of the account.

nominal_codestringnullable

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

subsidiariesarray

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

Show subsidiaries attributes
created_atstringfilterablenullable

The ISO 8601 timestamp that the account was created.

updated_atstringfilterable

The ISO 8601 timestamp that the account was last updated.

last_synced_atstringfilterable

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

platform_urlstringnullable

A 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_dataobjectOptional

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.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

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

    sortstringqueryOptional

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

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    account_typeenumqueryOptional

    Deprecated - use filter instead. The exact account type to filter on.

    One ofaccounts_payableaccounts_receivablebankfixed_assetother_assetother_current_assetliabilityequityexpenseother_expenseincomeother_incomecredit_cardcost_of_goods_soldother_current_liabilitylong_term_liabilitynon_posting, or unknown.
    last_synced_at_minintegerqueryOptional

    Deprecated - 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_maxintegerqueryOptional

    Deprecated - 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_minintegerqueryOptional

    Deprecated - 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_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

    accountsarray
    Show accounts attributes
    next_cursorstringnullableOptional
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
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
"currency_code": "USD",
10
"current_balance": 123.45,
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

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

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

    accountobject
    Show account attributes
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
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
"currency_code": "USD",
9
"current_balance": 123.45,
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

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    accountobject
    Show account attributes

Response Body

    Any of:

    accountobject
    Show account attributes
    async_responseobjectOptional
    Show async_response attributes
    errorsarrayOptional
    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
"name": "Checking",
6
"nominal_code": "1000"
7
}
8
}
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
"currency_code": "USD",
9
"current_balance": 123.45,
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.

Contact support