Accounting

Items
Get API Keys

The Item object

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

Properties

idstring

The Rutter generated unique ID of the item.

namestringnullable

The name of the item.

codestringnullable

The reference code of the item.

updated_atstring

The ISO 8601 timestamp that the item was last updated.

statusenum

The status of the item.

One ofactive, archived, or unknown.
typeenum

The type of the item.

One ofinventory, non_inventory, service, or unknown.
bill_itemobject

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

Show bill_item attributes
invoice_itemobject

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

Show invoice_item attributes
platform_dataoptional

The raw platform data corresponding to the Rutter object.

Example Item Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Rutter Shirt",
  "code": "1234",
  "status": "active",
  "type": "inventory",
  "bill_item": {
    "description": "A Rutter shirt.",
    "unit_price": "12.34"
  },
  "invoice_item": {
    "description": "A Rutter shirt.",
    "unit_price": "12.34"
  },
  "updated_at": "2023-01-02T02:34:56.000Z"
}

List Items

GET /accounting/items
Supported for: NetSuiteQuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    The Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    The Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.

Response Body

    itemsarray
    Show items attributes
    next_cursorstringnullable
Example Response Body
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Rutter Shirt",
      "code": "1234",
      "status": "active",
      "type": "inventory",
      "bill_item": {
        "description": "A Rutter shirt.",
        "unit_price": "12.34"
      },
      "invoice_item": {
        "description": "A Rutter shirt.",
        "unit_price": "12.34"
      },
      "updated_at": "2023-01-02T02:34:56.000Z"
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Next
Expenses