Items

The AccountingItem Object

A Rutter Item represents a good or service that is sold by a business entity.

Properties

idstringRequired

The Rutter generated unique ID of the item.

platform_idstringRequired

The platform specific ID of the item.

statusenumRequired

The status of the item.

One ofactivearchived, or unknown.
typeenumRequired

The type of the item.

One ofinventorynon_inventoryservicediscount, or unknown.
codestringnullableRequired

The reference code of the item.

namestringnullableRequired

The name of the item.

quantity_on_handnumbernullableRequired

The quantity on hand of an item. Only applicable to items with type inventory. Currently only supported for Quickbooks Desktop and Quickbooks.

subsidiariesarrayRequired

An array of Subsidiary linked to the item. This feature is currently only supported on NetSuite.

Show subsidiaries attributes
bill_itemobjectRequired

Item details associated with a bill (when the item was purchased).

Show bill_item attributes
invoice_itemobjectRequired

Item details associated with an invoice (when the item was sold).

Show invoice_item attributes
updated_atstringRequired

The ISO 8601 timestamp that the item was last updated.

last_synced_atstringRequired

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

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/items
POST
/accounting/items
PATCH
/accounting/items/:id

List Items

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    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.

    namestringquery

    The exact name to filter on. Supported for QuickBooks Desktop only.

    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
    itemsarrayRequired
    Show items attributes
    next_cursorstringnullable
Support by integration
  • Dynamics 365
    Dynamics 365
  • Exact
    Exact
  • Free Agent
    Free Agent
  • Freshbooks
    Freshbooks
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
"items": [
8
{
9
"id": "00000000-0000-0000-0000-000000000000",
10
"platform_id": "12345678",
11
"status": "active",
12
"type": "inventory",
13
"code": "1234",
14
"name": "Rutter Shirt",
15
"quantity_on_hand": 10,
16
"subsidiaries": [
17
{
18
"id": "00000000-0000-0000-0000-000000000000"
19
},
20
{
21
"id": "00000000-0000-0000-0000-000000000000"
22
}
23
],
24
"bill_item": {
25
"description": "A Rutter shirt from the Vendor",
26
"unit_price": "12.34"
27
},
28
"invoice_item": {
29
"description": "A Rutter shirt for the Customer",
30
"unit_price": "4.21"
31
},
32
"updated_at": "2023-01-02T02:34:56.000Z",
33
"last_synced_at": "2023-01-02T02:34:56.000Z",
34
"platform_data": {
35
"id": 123,
36
"data": "Varies by platform"
37
}
38
}
39
],
40
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
41
}

Create an Item

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    itemobjectRequired
    Show item attributes

Response Body

    Any of:

    itemobjectRequired
    Show item attributes
    async_responseobject
    Show async_response attributes
    errorsarray
    Show errors attributes
Support by integration
  • Quickbooks
    Quickbooks
  • QuickBooks Desktop
    QuickBooks Desktop
  • Sage Intacct
    Sage Intacct
Example Request Body
JSON
1
{
2
"item": {
3
"asset_account_id": "00000000-0000-0000-0000-000000000000",
4
"name": "Rutter Shirt",
5
"quantity_on_hand": 10,
6
"type": "inventory",
7
"bill_item": {
8
"account_id": "00000000-0000-0000-0000-000000000000",
9
"description": "A Rutter shirt from the Vendor",
10
"unit_price": "12.34"
11
},
12
"invoice_item": {
13
"account_id": "00000000-0000-0000-0000-000000000000",
14
"description": "A Rutter shirt for the Customer",
15
"unit_price": "4.21"
16
}
17
}
18
}
Example Response Body
JSON
1
{
2
"item": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"platform_id": "12345678",
5
"status": "active",
6
"type": "inventory",
7
"code": "1234",
8
"name": "Rutter Shirt",
9
"quantity_on_hand": 10,
10
"subsidiaries": [
11
{
12
"id": "00000000-0000-0000-0000-000000000000"
13
},
14
{
15
"id": "00000000-0000-0000-0000-000000000000"
16
}
17
],
18
"bill_item": {
19
"description": "A Rutter shirt from the Vendor",
20
"unit_price": "12.34"
21
},
22
"invoice_item": {
23
"description": "A Rutter shirt for the Customer",
24
"unit_price": "4.21"
25
},
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
}

Update an Item

PATCHhttps://production.rutterapi.com/versioned/accounting/items/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    itemobjectRequired
    Show item attributes

Response Body

    Any of:

    itemobjectRequired
    Show item attributes
    async_responseobject
    Show async_response attributes
    errorsarray
    Show errors attributes
Support by integration
  • Quickbooks
    Quickbooks
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{
2
"item": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"platform_id": "12345678",
5
"status": "active",
6
"type": "inventory",
7
"code": "1234",
8
"name": "Rutter Shirt",
9
"quantity_on_hand": 10,
10
"subsidiaries": [
11
{
12
"id": "00000000-0000-0000-0000-000000000000"
13
},
14
{
15
"id": "00000000-0000-0000-0000-000000000000"
16
}
17
],
18
"bill_item": {
19
"description": "A Rutter shirt from the Vendor",
20
"unit_price": "12.34"
21
},
22
"invoice_item": {
23
"description": "A Rutter shirt for the Customer",
24
"unit_price": "4.21"
25
},
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
}

Have questions?

Contact support for personalized guidance.

Contact support