Schemas

Download schema

PaginatedPurchaseRateList

PurchaseRate[] · required

next

string | null · uri

previous

string | null · uri

PaginatedStockLevelBundleList

StockLevelBundle[] · required

next

string | null · uri

previous

string | null · uri

PaginatedStockLevelList

StockLevel[] · required

next

string | null · uri

previous

string | null · uri

PurchaseRate

The cost and the purchasing terms of a product from one of its suppliers. A product has at most one purchase rate per supplier.

id

integer · readOnly · required

product_id

integer · readOnly · required

Id of the product.

contact_id

integer · readOnly · required

Id of the supplier.

tax_id

integer | null · readOnly · required

Id of the tax the supplier charges, which purchase order lines take. Null when there is none.

cost_basis

string · readOnly · required

Per Pack when the pack size is more than 1, and the costs are per pack, otherwise Per Unit.

cost

string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required

Cost of the product. When the pack size is greater than 1, we consider the cost to be cost per pack. For example, if the pack size is 10 and the cost value stored is 150 the actual cost per unit would be 15.

shipping_cost

string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required

Shipping cost of the product. The cost basis logic is applicable here too as it is for the cost per unit field.

supplier_sku

string · maxLength: 200 · readOnly · required

The supplier's own SKU of the product.

pack_size

integer · min: 0 · max: 2147483647 · readOnly · required

Units per pack. The costs are per pack when it is more than 1.

moq

integer · min: -2147483648 · max: 2147483647 · readOnly · required

Minimum order quantity.

uom

string · maxLength: 100 · readOnly · required

Unit of measure, such as kg.

notes

string · readOnly · required

Notes about the supplier's terms for the product.

PurchaseRateCreate

Request body of the purchase rate create.

product_id

integer · required

Id of the product, which must not be archived.

contact_id

integer · required

Id of the supplier.

PurchaseRateUpdate

Request body of the purchase rate update. A value left out keeps the saved one.

cost

string · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

shipping_cost

string · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

Shipping cost of the product. The cost basis logic is applicable here too as it is for the cost per unit field.

supplier_sku

string · maxLength: 200

The supplier's own SKU of the product.

pack_size

integer · min: 0 · max: 2147483647

Units per pack. The costs are per pack when it is more than 1.

moq

integer · min: -2147483648 · max: 2147483647

Minimum order quantity.

tax_id

integer | null

Id of a tax. Null clears the tax.

uom

string · maxLength: 100

Unit of measure, such as kg.

notes

string

Notes about the supplier's terms for the product.

StockLevel

The stock of a product at a warehouse.

id

integer · readOnly · required

updated

string · date-time · readOnly · required

product_id

integer · readOnly · required

warehouse_id

integer · readOnly · required

in_stock

integer · min: -2147483648 · max: 2147483647 · readOnly · required

incoming

integer · min: -2147483648 · max: 2147483647 · readOnly · required

available

integer · readOnly · required

booked

integer · min: -2147483648 · max: 2147483647 · readOnly · required

close_at_quantity

integer | null · min: -2147483648 · max: 2147483647 · readOnly · required

StockLevelBundle

The stock level of a bundle, with the stock levels of its components.

id

integer · readOnly · required

product_id

integer · readOnly · required

warehouse_id

integer · readOnly · required

in_stock

integer · readOnly · required

booked

integer · min: -2147483648 · max: 2147483647 · readOnly · required

available

integer · readOnly · required

_Component[] · readOnly · required

Tax

A tax of the account. A purchase rate sets the tax a supplier charges, and a purchase order line takes the tax of its supplier's purchase rate.

id

integer · readOnly · required

name

string · maxLength: 50 · readOnly · required

Name of the tax, such as GST.

tax_rate

string · decimal · readOnly · pattern: ^-?\d{0,8}(?:\.\d{0,… · required

Rate of the tax as a fraction of the cost, such as 0.18 for 18%.

Warehouse

A warehouse of the account, where the stock of the products is kept.

id

integer · readOnly · required

code

string · readOnly · required

Unique code of the warehouse in the account.

priority

integer · readOnly · required

Display order of the warehouse, lowest first.

is_3pl

boolean · readOnly · required

Whether a third party logistics provider manages the stock of the warehouse.

address_id

integer | null · readOnly · required

Id of the address of the warehouse, used on its purchase orders.

_Component

The stock level of a component of a bundle, with the quantity of the component in the bundle and the number of bundles its stock makes.

id

integer · readOnly · required

product_id

integer · readOnly · required

warehouse_id

integer · readOnly · required

in_stock

integer · min: -2147483648 · max: 2147483647 · readOnly · required

booked

integer · min: -2147483648 · max: 2147483647 · readOnly · required

available

integer · readOnly · required

component_quantity

integer · readOnly · required

possible_bundles

integer · readOnly · required

close_at_quantity

integer | null · min: -2147483648 · max: 2147483647 · readOnly · required