# Get a list of available usage product inventories

Endpoint: GET /usage-product-inventories
Version: 2.24
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `usageProductId` (string)
    Filter by usage product id
    Example: "0"

  - `startDate` (string)
    Filter by start date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `endDate` (string)
    Filter by end date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `productReference` (string)
    Filter by product reference
    Example: "xyz | in:x,y | like:xyz"

  - `serviceId` (string)
    Filter by service id
    Example: "xyz | in:x,y | like:xyz"

  - `siteId` (string)
    Filter by site
    Example: "0"

  - `label` (string)
    Filter by label
    Example: "xyz | in:x,y | like:xyz"

## Response 200 fields (application/json):

  - `id` (integer)
    Usage product inventory identifier
    Example: 1

  - `siteId` (integer, required)
    Site identifier
    Example: 1

  - `usageProductId` (integer, required)
    Usage product identifier
    Example: 1

  - `startDate` (string, required)
    Start date

  - `endDate` (string)
    End date

  - `supplierAccountId` (integer)
    Supplier account identifier

  - `billByServiceId` (boolean)
    Bill by Service ID

  - `serviceId` (string)
    Service ID. Extra validations may be applied depending on product configurations

  - `billable` (boolean)
    Billable charge

  - `inFlightOrder` (boolean)
    In-flight order

  - `externalOrderReference` (string)
    external order reference

  - `externalNetworkOrderReference` (string)
    external Network order reference

  - `pendingEndDate` (string)
    Inflight order pending end date

  - `usageCapEnabled` (boolean)
    Usage cap enabled

  - `defaultUsageCap` (number)
    Default usage cap amount. Specify the value in minor currency units (i.e. pence for GBP, cents for EUR/USD)

  - `overrideUsageCap` (number)
    Override the default usage cap amount temporarily. Specify the value in minor currency units (e.g. pence for GBP, cents for EUR/USD)

  - `applySurcharges` (boolean)
    Do surcharge apply to this UPI? If true and a rate is found with a surchargeValue greater than 0 then an additional surcharge will be applied to the usage cost

  - `productReferences` (array, required)

  - `productReferences.id` (integer)
    Product reference identifier
    Example: 1

  - `productReferences.productReference` (string, required)
    Product reference. Extra validations may be applied depending on product configurations.

  - `productReferences.primary` (boolean)
    True if product reference is primary (main billing number)

  - `productReferences.label` (string)
    Product reference

  - `productReferences.userId` (string)
    User Id

  - `productReferences.userEmail` (string)
    User email address

  - `productReferences.costCentreCode` (string)
    Cost centre code

  - `productReferences.departmentCode` (string)
    Department code

  - `productReferences.notes` (string)
    Notes

  - `tripwirePlanId` (integer)
    Tripwire plan identifier


## Response 400 fields

## Response 401 fields

## Response 404 fields

## Response 412 fields

## Response 500 fields

## Response 501 fields