Listar existências
RegistosGET /inventory/balances
What is where: on hand, reserved, available and in transit
Pages the stock balance rows (one per location and item), ordered by location then item, with limit (default 20, max 100) and the after cursor. Narrow with location_id and item_id. Set non_zero=true to skip empty rows, below_reorder=true for rows at or under the reorder level once holds and planned shortfalls are taken off, and short_for_planned=true for rows where planned work orders need more than is available. Needs the inventory:read scope.
Parâmetros
location_idOne location
item_idOne item
below_reorderOnly balances at or under their reorder level
non_zeroLeave out empty balances
short_for_plannedOnly balances whose available stock does not cover the unreserved need of planned work orders
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Devolve
200 Balances ordered by location and item
Mostrar atributos
dataMostrar atributos filhos
tenant_iditem_iditem_codeitem_nameunitlocation_idlocation_nameon_handQuantity in the item's unit, with at most three decimals (12.5 metres).
reservedQuantity in the item's unit, with at most three decimals (12.5 metres).
availableQuantity in the item's unit, with at most three decimals (12.5 metres).
in_transitQuantity in the item's unit, with at most three decimals (12.5 metres).
reorder_levelQuantity in the item's unit, with at most three decimals (12.5 metres).
planned_shortQuantity in the item's unit, with at most three decimals (12.5 metres).
below_reorderAvailable less planned_short is at or under the reorder level
value_minorupdated_at
has_morenext_cursor
Permissões inventory:read · Funções: admin, analyst, field_reader, field_supervisor, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/inventory/balances" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/inventory/balances", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/inventory/balances",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/inventory/balances", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"item_id": "itm_2vLmKDHWenXi6Pxs8hv8WJHGW53",
"item_code": "ITE-2026-000142",
"item_name": "Ana Matsinhe",
"unit": "unit",
"location_id": "loc_2NbCeVvmOLLm0vFE4ZvkGRtMsrx",
"location_name": "Ana Matsinhe",
"on_hand": 1,
"reserved": 1,
"available": 1,
"in_transit": 1,
"reorder_level": 1,
"planned_short": 1,
"below_reorder": true,
"value_minor": 1342,
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}