WAwafeq
Items

Retrieve item

Endpoint for retrieving a single item.

get/items/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/items/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Response

created_tsstring date-time required

The timestamp in UTC when the item was created

descriptionstring

The description of the item.

expense_accountstring nullable

The expense account for this item.

external_idstring

External identifier for the item.

idstring required

The unique identifier of the item.

is_activeboolean

Whether the item is active.

is_tracked_inventoryboolean

Whether inventory is tracked for this item.

legacy_idstring required

[Deprecated] The legacy identifier of the item.

modified_tsstring date-time required

The timestamp in UTC when the item was last modified

namestring required

The name of the item.

purchase_tax_ratestring nullable

The tax rate applied when purchasing this item.

quantity_on_handnumber double nullable required

The current quantity on hand. Only relevant for tracked inventory items.

revenue_accountstring nullable

The revenue account for this item.

revenue_tax_ratestring nullable

The tax rate applied when selling this item.

skustring

The SKU of the item.

unit_costnumber double nullable

The default unit cost of the item if no unit of measure is specified.

unit_pricenumber double nullable

The default unit price of the item if no unit of measure is specified.

Changes

No recorded changes to this operation across all 2 revisions of this API.