Items

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 ofactive, archived, or unknown.
typeenum

The type of the item.

One ofinventory, non_inventory, service, discount, or unknown.
codestringnullable

The reference code of the item.

namestringfilterablenullable

The name of the item.

quantity_on_handnumbernullable

The quantity on hand of an item. Only applicable to items with type inventory. Supported for QuickBooks and QuickBooks Desktop.

subsidiariesarray

An array of Subsidiary linked to the item. Supported for 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
created_atstringfilterablenullable

The ISO 8601 timestamp that the item was created.

updated_atstringfilterable

The ISO 8601 timestamp that the item was last updated.

last_synced_atstringfilterable

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

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/items
GET
/accounting/items/:id
POST
/accounting/items
PATCH
/accounting/items/:id
DELETE
/accounting/items/:id

List Items

GEThttps://production.rutterapi.com/versioned/accounting/items

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

    Not currently supported on Sage Intacct or Sage Business Cloud. 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.

    Filterable fields: name, updated_at, created_at, last_synced_at.

    sortstringqueryOptional

    Used 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 Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

    Sortable fields: name, updated_at, created_at, last_synced_at.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

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

    namestringfilterablequeryOptional

    Deprecated - use filter instead. The exact name to filter on. Not currently supported on Sage Intacct or Sage Business Cloud.

    updated_at_maxintegerqueryOptional

    Deprecated - 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_minintegerqueryOptional

    Deprecated - 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_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
  • NetSuite
    NetSuite
200
Example Response Body
JSON
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

GEThttps://production.rutterapi.com/versioned/accounting/items/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
  • NetSuite
    NetSuite
200
Example Response Body
JSON
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

POSThttps://production.rutterapi.com/versioned/accounting/items

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    itemobject
    Show item attributes

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
  • NetSuite
    NetSuite
Example Request Body
JSON
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
}
200
Example Response Body
JSON
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

PATCHhttps://production.rutterapi.com/versioned/accounting/items/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    itemobject
    Show item attributes

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
  • NetSuite
    NetSuite
200
Example Response Body
JSON
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

DELETEhttps://production.rutterapi.com/versioned/accounting/items/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.

Response Body

Support by integration
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
200
Example Response Body
JSON
1
{


2
  "code": "deleted",


3
  "success": true


4
}

Have questions?

Contact support for personalized guidance.

Contact support
Previous
Departments
Next
Journal Entries