Current inventory valuation

GET /api/v1/inventory/reports/valuation

Return the current on-hand inventory value (in cents) computed from remaining FIFO cost lots, grouped by location, category, or vendor.

Operation ID: get_valuation_api_v1_inventory_reports_valuation_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

group_by string default: location

Bucketing dimension: 'location' (default), 'category', or 'vendor'.

One of: location, category, vendor

Responses

200 Successful Response

Schema: ValuationResponse

group_by string required

One of: location, category, vendor

total_value_cents integer

total_on_hand_units number

buckets array · ValuationBucket ValuationBucket

5 fields

key string required: Group key (id or label).
label string required: Human-readable label.
on_hand_units number required: Sum of quantity_remaining across lots.
total_value_cents integer required: Sum of quantity_remaining * unit_cost_cents across lots.
lot_count integer required: Number of contributing lots.

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/inventory/reports/valuation

bash

curl -X GET 'https://api.ondayzero.com/api/v1/inventory/reports/valuation' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/inventory/reports/valuation', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/inventory/reports/valuation", headers=headers)
data = response.json()