Get Report

The category the report belongs to. See above table for possible values.

The report's key. See above table for possible values.

True to return the report in CSV format, else return as a PDF.

Id of the client to filter for. Defaults to the user's client id.

Name of the client to filter for. Ignored if clientId is provided and is nonzero.

Id of the warehouse to filter for. Defaults to the user's current warehouse unless the report's warehouse parameters is marked with (All).

Name of the warehouse to filter for. Ignored if warehouseId is provided.

CSV string of warehouse ids and/or names to filter for multiple warehouses at once. Supersedes warehouseId and warehouseName if provided.

True to filter for all warehouses and to supersede the warehouseId, warehouseName, and warehouses parameters.

The day the report should start from.

The day the report should stop at.

The single day the report should be reporting on.

Filter by a customer id.

Filter by a customer's account number.

Id of the supplier to filter for.

Name of the supplier to filter for. Ignored if supplierId is provided.

Name of the category to filter for.

Id of the item to filter for.

SKU of the item to filter for. Ignored if itemId is provided.

Code of the carrier to filter for.

True to include completed orders in the report.

Include additional location data.

Include additional quantity data.

Break the data down by date.

Break the data down by location.

Break the data down by lot number.

True to include out of stock items.

Filter for order matching the given order number.

Id of the location to filter for.

Name of the location to filter for. Ignored if locationId is provided.

Minimum cycle count accuracy percentage.

Maximum cycle count accuracy percentage.

Lot number to filter for.

Serial number to filter for.

Expiration date to filter for.

True to break the data down by carrier.

True to include items with no discrepancies in a cycle count.