Items
The AccountingItem Object
A Rutter Item represents a good or service that is sold by a business entity.
Properties
id
stringThe Rutter generated unique ID of the item.
platform_id
stringThe platform specific ID of the item.
status
enumThe status of the item.
type
enumThe type of the item.
code
stringnullableThe reference code of the item.
name
stringfilterablenullableThe name of the item.
quantity_on_hand
numbernullableThe quantity on hand of an item. Only applicable to items with type inventory. Supported for QuickBooks and QuickBooks Desktop.
subsidiaries
arrayAn array of Subsidiary linked to the item. Supported for NetSuite.
subsidiaries
attributesbill_item
objectItem details associated with a bill (when the item was purchased).
bill_item
attributesinvoice_item
objectItem details associated with an invoice (when the item was sold).
invoice_item
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the item was created.
updated_at
stringfilterableThe ISO 8601 timestamp that the item was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the item was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Items
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
stringqueryOptionalNot yet supported on Sage Intacct or Dynamics 365 Business Central yet. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable
tag in the response object.
sort
stringqueryOptionalUsed to sort the response objects, e.g. last_synced_at ASC
. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
. Supports only fields decorated with a filterable
tag in the response object except on Sage Intacct and Dynamics 365 Business Central. For those platforms, only updated_at
and last_synced_at
fields are supported.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
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.
name
stringqueryOptionalDeprecated - use filter
instead. The exact name to filter on. Not yet supported on Sage Intacct or Dynamics 365 Business Central yet.
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
items
arrayitems
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
1{
2 "items": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "status": "active",
7 "type": "inventory",
8 "code": "1234",
9 "name": "Rutter Shirt",
10 "quantity_on_hand": 10,
11 "subsidiaries": [
12 {
13 "id": "00000000-0000-0000-0000-000000000000"
14 },
15 {
16 "id": "00000000-0000-0000-0000-000000000000"
17 }
18 ],
19 "bill_item": {
20 "description": "A Rutter shirt from the Vendor",
21 "unit_price": "12.34"
22 },
23 "invoice_item": {
24 "description": "A Rutter shirt for the Customer",
25 "unit_price": "4.21"
26 },
27 "created_at": "2023-01-02T02:34:56.000Z",
28 "updated_at": "2023-01-02T02:34:56.000Z",
29 "last_synced_at": "2023-01-02T02:34:56.000Z",
30 "platform_data": {
31 "id": 123,
32 "data": "Varies by platform"
33 }
34 }
35 ],
36 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
37 "connection": {
38 "id": "00000000-0000-0000-0000-000000000000",
39 "orgId": "00000000-0000-0000-0000-000000000000",
40 "platform": "NETSUITE"
41 }
42}
Fetch an Item
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 yet supported on Sage Intacct or Dynamics 365 Business Central yet.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
item
objectitem
attributesconnection
objectconnection
attributes- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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 "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 "connection": {
35 "id": "00000000-0000-0000-0000-000000000000",
36 "orgId": "00000000-0000-0000-0000-000000000000",
37 "platform": "NETSUITE"
38 }
39}
Create an Item
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
item
objectitem
attributesResponse Body
Any of:
item
objectitem
attributesasync_response
objectOptionalasync_response
attributes- QuickBooks
- QuickBooks Desktop
- NetSuite
- Sage Intacct
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}
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 "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}
Update an Item
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
item
objectitem
attributesResponse Body
Any of:
item
objectitem
attributesasync_response
objectOptionalasync_response
attributes- QuickBooks
- QuickBooks Desktop
- NetSuite
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 "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}
Delete an Item
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Response Body
Any of:
code
enumReturns the status of the requested object: deleted
indicates object was deleted by this operation, whereas not_found
indicates object was not found (allowing us to make DELETE operations idempotent).
success
booleanIndicates whether deletion was successful
async_response
objectOptionalasync_response
attributes- QuickBooks Desktop
1{
2 "code": "deleted",
3 "success": true
4}
Have questions?
Contact support for personalized guidance.