API Reference
API Reference

Update Item

put
https://api.getkonvex.com/core/api/items

Available for: Alegra

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Item:SubItem. Returned from an existing object and not input on a new object.Limited to 5 levels.
Quickbooks

string
required

Domain erp (QBO)
Quickbooks

string
required

Unique Identifier for an Intuit entity (object). Required for the update operation.
Quickbooks

string
required

Name of the item. This value is unique.
Quickbooks

boolean
required

True if there is quantity on hand to be tracked. Once this value is true, it cannot be updated to false. Applicable for items of type Inventory. Not applicable for Service or NonInventory item types.
Quickbooks

string
required

Classification that specifies the use of this item. See the description at the top of the Item entity page for details about supported item types. For requests with minor versions earlier than 4 specified, this field is read-only and system-defined as follows: Inventory--Default setting when TrackQtyOnHand, InvStartDate, and AssetAccountRef are specified. Used for goods the company sells and buys that are tracked as inventory. Service--Default setting when TrackQtyOnHand, InvStartDate, and AssetAccountRef are not specified. Used for non-tangible goods the company sells and buys that are not tracked as inventory. For example, specialized labor, consulting hours, and professional fees. For requests with minor version=4 query parameter, this field is required to be explicitly set with one of the following: Inventory--Used for goods the company sells and buys that are tracked as inventory. Service--Used for non-tangible goods the company sells and buys that are not tracked as inventory. For example, specialized labor, consulting hours, and professional fees. NonInventory--Use for goods the company sells and buys that are not tracked as inventory. For example, office supplies or goods bought on behalf of the customer. When querying Item objects with minor versions earlier than 4 specified, NonInventory types are returned as type Service. For French locales, Type is tied with ItemCategoryType: if ItemCategoryType is set to Service, then Type is set to Service, if ItemCategoryType is Product, then Type is set to NonInventory. >Required when minor version 4 is specified.
Quickbooks

int32
required

Amount paid when buying or ordering the item, as expressed in the home currency.
Quickbooks

int32
required

Current quantity of the Inventory items available for sale. Not used for Service or NonInventory type items.Required for Inventory type items.
Quickbooks

income_account_ref
object
required

Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of Sales of Product Income. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for IncomeAccountRef.value and IncomeAccountRef.name, respectively.For France locales: This is an optional field. This is the sales account id, If not provided it defaults to the default sales account: 706100 and 707100 are the default expense accounts used for Service and Product type of item, respectively. required for Inventory and Service item types.
Quickbooks

asset_account_ref
object
required

Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for AssetAccountRef.value and AssetAccountRef.name, respectively. Required for Inventory item types.
Quickbooks

boolean
required

If true, transactions for this item are taxable. Applicable to US companies, only.
Quickbooks

meta_data
object
required

Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
Quickbooks

boolean
required

sparse updates(sparse=true).
Quickbooks

boolean
required

Inactivating an item is achieved by setting the Active attribute to false in an object update request. The record is hidden for display purposes. References to inactive objects are left intact. Not valid for Category item types.
Quickbooks

string
required

Version number of the entity. Required for the update operation.
Quickbooks

string
required

Date of opening balance for the inventory transaction. For read operations, the date returned in this field is always the originally provided inventory start date. For update operations, the date supplied is interpreted as the inventory adjust date, is stored as such in the underlying data model, and is reflected in the QuickBooks Online UI for the object. The inventory adjust date is not exposed for read operations through the API. Required for Inventory type items.
Quickbooks

int32
required

Corresponds to the Price/Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax.
Quickbooks

expense_account_ref
object
required

Reference to the expense account used to pay the vendor for this item. Must be an account with account type of Cost of Goods Sold. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for ExpenseAccountRef.value and ExpenseAccountRef.name, respectively. For France locales: This is an optional field. This is the purchase account id, If not provided it defaults to the default purchase account: 605100 and 601100 are the default expense accounts used for Service and Product type of item, respectively. Required for Inventory, NonInventory, and Service item types.
Quickbooks

string
required

Purchase description for the item.
Quickbooks

string
required

Description of the item.
Quickbooks

Headers
string
enum
required

Name of the ERP or accounting software from which you want to obtain the information.
Siigo Alegra Quickbooks

Allowed:
string

If you send the x-connection, the connection will already be secured, and there will be no need to send the connection headers for each software.
Optional for: Siigo Alegra Quickbooks

string
required

User of ERP Api connection.
Quickbooks

string
required

Apikey or token of ERP Api connection.
Quickbooks

string
required

Quickbooks session token.
Quickbooks

boolean
required
Defaults to true

x-testing is used for building the environment. could be sandbox or production ( true: sandbox, false:production).
Quickbooks

Responses

Updated over 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago