Items
The AccountingItem Object
A Rutter Item represents a good or service that is sold by a business entity.
Properties
id
stringRequiredThe Rutter generated unique ID of the item.
platform_id
stringRequiredThe platform specific ID of the item.
status
enumRequiredThe status of the item.
type
enumRequiredThe type of the item.
code
stringnullableRequiredThe reference code of the item.
name
stringnullableRequiredThe name of the item.
quantity_on_hand
numbernullableRequiredThe quantity on hand of an item. Only applicable to items with type inventory. Currently only supported for Quickbooks Desktop and Quickbooks.
subsidiaries
arrayRequiredAn array of Subsidiary linked to the item. This feature is currently only supported on NetSuite.
subsidiaries
attributesbill_item
objectRequiredItem details associated with a bill (when the item was purchased).
bill_item
attributesinvoice_item
objectRequiredItem details associated with an invoice (when the item was sold).
invoice_item
attributesupdated_at
stringRequiredThe ISO 8601 timestamp that the item was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the item was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Items
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe limit on the number of entities returned.
name
stringqueryThe exact name to filter on. Supported for QuickBooks Desktop only.
sort
stringqueryThe 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_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectRequiredconnection
attributesitems
arrayRequireditems
attributesnext_cursor
stringnullable- Dynamics 365
- Exact
- Free Agent
- Freshbooks
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
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
item
objectRequireditem
attributesResponse Body
Any of:
item
objectRequireditem
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- Quickbooks
- QuickBooks Desktop
- 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 "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
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
item
objectRequireditem
attributesResponse Body
Any of:
item
objectRequireditem
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- Quickbooks
- QuickBooks Desktop
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.