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
stringnullableThe name of the item.
quantity_on_hand
numbernullableThe quantity on hand of an item. Only applicable to items with type inventory. Currently only supported for Quickbooks Desktop and Quickbooks.
subsidiaries
arrayAn array of Subsidiary linked to the item. This feature is currently only supported on 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
attributesupdated_at
stringThe ISO 8601 timestamp that the item was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"status": "active",
"type": "inventory",
"code": "1234",
"name": "Rutter Shirt",
"quantity_on_hand": 10,
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000"
},
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"bill_item": {
"description": "A Rutter shirt from the Vendor",
"unit_price": "12.34"
},
"invoice_item": {
"description": "A Rutter shirt for the Customer",
"unit_price": "4.21"
},
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
List Items
GET /accounting/itemsRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
items
arrayitems
attributesnext_cursor
stringnullableoptional{
"items": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"status": "active",
"type": "inventory",
"code": "1234",
"name": "Rutter Shirt",
"quantity_on_hand": 10,
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000"
},
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"bill_item": {
"description": "A Rutter shirt from the Vendor",
"unit_price": "12.34"
},
"invoice_item": {
"description": "A Rutter shirt for the Customer",
"unit_price": "4.21"
},
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Create an Item
POST /accounting/itemsRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
item
objectitem
attributesResponse Body
Any of:
item
objectitem
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"item": {
"asset_account_id": "00000000-0000-0000-0000-000000000000",
"name": "Rutter Shirt",
"quantity_on_hand": 10,
"type": "inventory",
"bill_item": {
"account_id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt from the Vendor",
"unit_price": "12.34"
},
"invoice_item": {
"account_id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt for the Customer",
"unit_price": "4.21"
}
}
}
{
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"status": "active",
"type": "inventory",
"code": "1234",
"name": "Rutter Shirt",
"quantity_on_hand": 10,
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000"
},
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"bill_item": {
"description": "A Rutter shirt from the Vendor",
"unit_price": "12.34"
},
"invoice_item": {
"description": "A Rutter shirt for the Customer",
"unit_price": "4.21"
},
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}
Update an Item
PATCH /accounting/items/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
Request Body
item
objectitem
attributesResponse Body
Any of:
item
objectitem
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"status": "active",
"type": "inventory",
"code": "1234",
"name": "Rutter Shirt",
"quantity_on_hand": 10,
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000"
},
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"bill_item": {
"description": "A Rutter shirt from the Vendor",
"unit_price": "12.34"
},
"invoice_item": {
"description": "A Rutter shirt for the Customer",
"unit_price": "4.21"
},
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}