Appearance

List Items ​

Endpoint ​

http
GET /unified/accounting/items
Integrations supported
  • QuickBooks
  • Xero
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Xero

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
created_at
string · date-time

This represents the date when the item was created

Supported in
  • QuickBooks
  • Xero
updated_at
string · date-time

This represents the date when the item was updated

Supported in
  • QuickBooks
  • Xero
name
string

The name of the item

Supported in
  • Xero

Response Body ​

result
object[]

List of Items

id
string
REQUIRED · 

The unique identifier for the item

Supported in
  • QuickBooks
  • Xero
name
string

The name of the item

Supported in
  • QuickBooks
  • Xero
description
string

The description of the item

Supported in
  • QuickBooks
  • Xero
status
string

The status of the item. If no clear mapping exists, then raw value is returned

All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
quantity
number

The quantity of the Item.

Supported in
  • QuickBooks
unit_price
number

The unit price of the item

Supported in
  • QuickBooks
  • Xero
purchase_price
number

The purchase price of the item

Supported in
  • QuickBooks
  • Xero
purchase_account
string

The ID of the account used to record the purchase of the item

Supported in
  • QuickBooks
  • Xero
sales_account
string

The ID of the account used to record the sale

Supported in
  • QuickBooks
  • Xero
asset_account
string

The ID of the account used to record the asset

Supported in
  • QuickBooks
company
string

The ID of the company the item belongs to

created_at
string · date-time

This represents the date when the item was created

Supported in
  • QuickBooks
updated_at
string · date-time

This represents the date when the item was updated

Supported in
  • QuickBooks
  • Xero
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.