The AccountingItem 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.

platform_idstring

The platform specific ID of the item.

statusenum

The status of the item.

One ofactivearchived, or unknown.
typeenum

The type of the item.

One ofinventorynon_inventoryservicediscount, or unknown.
codestringnullable

The reference code of the item.

namestringnullable

The name of the item.

quantity_on_handnumbernullable

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

subsidiariesarray

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

Show subsidiaries attributes
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
updated_atstring

The ISO 8601 timestamp that the item was last updated.

last_synced_atstring

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

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example AccountingItem Object
{
  "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",
  "last_synced_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Items

GET /versioned/accounting/items
Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho Books

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.
    last_synced_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

    limitintegeroptionalquery

    The limit on the number of entities returned.

    sortstringoptionalquery

    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_maxintegeroptionalquery

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

    updated_at_minintegeroptionalquery

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

Response Body

    itemsarray
    Show items attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "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",
      "last_synced_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Create an Item

POST /versioned/accounting/items
Supported for: QuickBooksQuickBooks DesktopSage Intacct

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    itemobject
    Show item attributes

Response Body

    Any of:

    itemobject
    Show item attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "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"
    }
  }
}
Example Response Body
{
  "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",
    "last_synced_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Update an Item

PATCH /versioned/accounting/items/:id
Supported for: QuickBooks Desktop

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

Request Body

    itemobject
    Show item attributes

Response Body

    Any of:

    itemobject
    Show item attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Response Body
{
  "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",
    "last_synced_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}