Global API
Request

Item

3min

In Breadwinner for Xero, the "Item" records can be found under the Salesforce Product if you manually Import those into the Salesforce.

When requesting an Item, use the requestJSON to pass the Item data, and the response will have responseJSON which stores the Item response returned by Xero.

The Item has the following parameters.

Item

Field Name

Data Type

Description

ItemID

String

Xero generated identifier for an item

Code

String

User-defined item code

Name

String

The name of the item

IsSold

Boolean

Boolean value. When IsSold is true the item will be available on Sales transactions in the Xero UI

IsPurchased

Boolean

Boolean value. When IsPurchased is true the item is available for purchase transactions in the Xero UI

Description

String

The sales description of the item

PurchaseDescription

String

The purchase description of the item

PurchaseDetails

The PurchaseDetails element can contain a number of individual sub-elements

SalesDetails

The SalesDetails element can contain a number of individual sub-elements

IsTrackedAsInventory

Boolean

True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set

SalesWrapper

Field Name

Data Type

Description

UnitPrice

Decimal

Unit Price of the item

AccountCode

String

Default account code to be used for Sales Item

TaxType

String

Used as an override if the default Tax Code for the selected AccountCode is not correct

PurchaseWrapper

Field Name

Data Type

Description

UnitPrice

Decimal

Unit Price of the item

COGSAccountCode

String

Cost of Goods Sold Account to be used for the Purchase Items.

TaxType

String

Used as an override if the default Tax Code for the selected AccountCode is not correct

Updated 03 Mar 2023
Doc contributor
Did this page help you?