Inventory Counts

Prev Next
Get
/public/v1/inventory/inventory-counts

Retrieves a list of inventory counts matching the supplied filter and pagination criteria, sorted by last modified date and time. Each count contains only the items present on that count, not every item with inventory activity. Usage figures such as purchases, transfers, waste, and theoretical usage are calculated when the count is created and change only when the variance data is refreshed in the application.

Security

The requesting user must have the following permission to retrieve inventory counts:

  • Food → Inventory Counts → View Inventory Counts and View Variance Tab
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Query parameters
modifiedOnStart
string (date-time)

Earliest modified date and time to return

modifiedOnEnd
string (date-time)

Latest modified date and time to return

dateOfBusinessStart
string (date)

Earliest count date to return

dateOfBusinessEnd
string (date)

Latest count date to return

status
string

Statuses of the counts to return, as a comma, semicolon or pipe-separated list of "In Progress", "Completed", "Approved", returns counts with any status if not specified

locationIds
string (uuid)

Unique identifier (GUID) of the location to return counts for, only one location is accepted per request

includeData
string

Data to include in the response, as a comma, semicolon or pipe-separated list of "itemDetail", "varianceSummary", includes all data if not specified

pageSize
integer (int32)

Maximum number of top-level objects to return in one page.

Minimum1.0
Maximum250.0
Default250
continuationToken
string

Opaque token from the next link of a previous response that retrieves the next page of results, page size is ignored when supplied

varianceUofM
string

Unit of measure used for variance quantities, "Inventory" or "Reporting", defaults to "Inventory"

Valid values[ "Inventory", "Reporting" ]
Default"Inventory"
includeEodOnly
boolean

Indicates whether to return only end-of-day counts, defaults to true, spot counts are excluded when true

Responses
200

list of inventory count entities

Expand All
object

Contains inventory counts matching the supplied filter and pagination criteria.

items
Array of object | null

Inventory counts on the current page.

object

An inventory count, indicating actual inventory levels at a specific point in time.

id
integer (int64)

The unique identifier of the inventory count.

inventoryCountTemplate
object

The template used to initialize the count. Populated for counts created from a single legacy template and null for counts created from new inventory templates.

name
string | null

The name of the inventory count template.

inventoryCountTemplates
Array of object | null

The templates used to initialize the count, ordered from least frequent to most frequent recurrence. Populated for counts created from new inventory templates and empty for counts created from a legacy inventory template.

object

A reference to an inventory count template, including its identifiers and scheduling details.

inventoryCountId
integer (int64)

The unique identifier of the inventory count.

inventoryCountTemplateId
string | null

The unique identifier of the inventory count template.

inventoryCountTemplateName
string | null

The name of the inventory count template.

isGLPostingTemplate
boolean

Indicates whether counts created from the template post to the general ledger.

recurrence
string | null

The recurrence of the template. Values are "On Demand", "Daily", "Weekly", "Period", "Monthly", "Quarterly", "Annually".

location
object

The location being counted.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

legalEntity
object

The legal entity of the location being counted.

id
string (uuid)

Unique identifier of the legal entity.

name
string | null

Display name of the legal entity.

isCountInOpenFiscalPeriod
boolean

Indicates whether the count date falls within an open fiscal period.

name
string | null

The name of the inventory count.

status
string | null

The status of the inventory count. Values are "In Progress", "Completed", "Approved".

date
string (date) | null

The business date the inventory count is for.

duration
string (date-span)

The time from creation of the inventory count until it was marked completed, zero while the count is in progress.

frequency
string | null

The frequency of the inventory count, taken from the least frequent template for counts that combine multiple templates. Values are "On Demand", "Daily", "Weekly", "Period", "Monthly", "Quarterly", "Annually"; counts created from a single legacy template carry that template's free-text frequency.

isGLPosting
boolean

Indicates whether the inventory count posts to the general ledger.

totalAmount
number (double) | null

The total value of the inventory count, calculated as the sum of each item's total counted quantity multiplied by its cost per first unit of measure.

createdOn
string (date-time)

The date and time the inventory count was created.

createdBy
object

The user who created the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date and time the inventory count was last changed.

modifiedBy
object

The user who last modified the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

completedOn
string (date-time) | null

The date and time the inventory count was completed.

completedBy
object

The user who completed the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

approvedOn
string (date-time) | null

The date and time the inventory count was approved.

approvedBy
object

The user who approved the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

teamMember
object

The user who last modified the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

transactionId
string (uuid) | null

The unique identifier (GUID) of the general ledger transaction. Only set when a count that posts to the general ledger has been completed or approved.

alertsCount
integer (int32)

The number of alerts associated with the inventory count.

isCountScheduled
boolean Deprecated

Deprecated. Relates to an earlier version of scheduling and does not indicate whether the count was created from a scheduled template.

isTheoGenerated
boolean

Indicates whether the count quantities were pre-filled from theoretical on-hand quantities.

hasPreviousCountLinks
boolean

Indicates whether the previous count of each counted item is recorded on the count.

details
Array of object | null

The items present on the inventory count.

object

A counted item within an inventory count, for one storage location.

id
integer (int64)

The unique identifier of the detail.

name
string | null

The name of the counted item.

sortIndex
integer (int64)

The sort order of the item within the storage location.

storageLocation
object

The storage location of the counted item.

name
string | null

The name of the inventory count storage location.

inventoryCountTemplateDetailId
integer (int64) | null

The identifier of the template detail used to create this detail.

item
object

The item being counted, including its categories.

id
string (uuid)

The unique identifier (GUID) of the item.

name
string | null

The name of the item.

number
string | null

The item number, if any.

itemType
string | null

The type of the item, if any.

itemCategory1
object

The first category of the item, null when the item has no first category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object

The second category of the item, null when the item has no second category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object

The third category of the item, null when the item has no third category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

costAccount
object

The general ledger cost account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object

The general ledger inventory account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

unitOfMeasure1
object

The first unit of measure configured for the item.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

unitOfMeasure2
object

The second unit of measure configured for the item.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

unitOfMeasure3
object

The third unit of measure configured for the item.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

quantity1
number (double) | null

The counted quantity in the first unit of measure.

quantity2
number (double) | null

The counted quantity in the second unit of measure.

quantity3
number (double) | null

The counted quantity in the third unit of measure.

itemUofM1Cost
number (double)

The cost of the item per first unit of measure.

uofM2QtyMultiplier
number (double)

The conversion factor from the second unit of measure to the first.

uofM3QtyMultiplier
number (double)

The conversion factor from the third unit of measure to the first.

previousQuantity
number (double)

Deprecated. Always returns 0.

totalQuantity
number (double)

The total counted quantity of the item in the storage location.

previousItemUofM1Cost
number (double)

Deprecated. Always returns 0.

isCounted
boolean

Indicates whether the item has been counted in the storage location. A counted quantity of 0 still counts as counted.

totalAmount
number (double)

The total amount of the item in the storage location, calculated as the total counted quantity multiplied by the cost per first unit of measure, rounded to 4 decimal places.

previousAmount
number (double)

Deprecated. Always returns 0.

adjustment
number (double)

Deprecated. Always returns 0.

modifiedOn
string (date-time)

The date and time the detail was last modified.

modifiedBy
object

The user who last modified the detail.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

alert
string | null

The row-level alert for the detail, if any.

templateIds
Array of string | null

The unique identifiers of the templates the item belongs to.

string
varianceSummary
object

The usage variance summary of the inventory count. For counts that combine multiple templates, includes only the items of the least frequent template.

isActualUsageReviewCompleted
boolean

Indicates whether the actual usage variances have been reviewed.

isTheoreticalUsageReviewCompleted
boolean

Indicates whether the theoretical usage variances have been reviewed.

itemSummaries
Array of object | null

The variance details for each item in the count.

object

A summary of the usage variance for an item in an inventory count.

item
object

The item the variance applies to.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
uofM
object

The unit of measure used for the variance quantities.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

costAccount
object

The general ledger cost account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object

The general ledger inventory account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

itemCategory1
object

The first category of the item, null when the item has no first category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object

The second category of the item, null when the item has no second category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object

The third category of the item, null when the item has no third category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

quantitiesFromDate
string (date)

The start date of the quantity transaction range used for the variance.

dateLastCounted
string (date) | null

The date of the previous count of the item.

beginningQuantity
number (double) | null

The quantity from the previous count.

beginningAmount
number (double) | null

The amount from the previous count.

purchaseQuantity
number (double)

The quantity from purchasing transactions.

purchaseAmount
number (double)

The amount from purchasing transactions.

transferQuantity
number (double)

The quantity from transfer transactions.

transferAmount
number (double)

The amount from transfer transactions.

endQuantity
number (double)

The quantity from the current count.

endAmount
number (double)

The amount from the current count.

endCost
number (double)

The cost from the current count.

actualUsage
number (double)

The actual usage quantity.

actualUsageAmount
number (double)

The amount of the actual usage.

wasteUsage
number (double)

The usage quantity logged as waste.

wasteUsageAmount
number (double)

The amount of the usage logged as waste.

theoreticalUsage
number (double)

The theoretical usage quantity.

theoreticalUsageAmount
number (double)

The amount of the theoretical usage.

variance
number (double)

The variance between actual and theoretical usage.

varianceAmount
number (double)

The amount of the variance between actual and theoretical usage.

unexplainedVariance
number (double)

The variance with no explaining transactions.

unexplainedVarianceAmount
number (double)

The amount of the variance with no explaining transactions.

efficiency
number (double) | null

The usage efficiency of the item.

isAboveTheoreticalThreshold
boolean

Indicates whether the item is above the allowed efficiency threshold.

templateId
string | null

The unique identifier of the count template the item belongs to.

additionalVarianceSummary
object

The usage variance summary for the templates other than the least frequent template, for counts that combine multiple templates.

isActualUsageReviewCompleted
boolean

Indicates whether the actual usage variances have been reviewed.

isTheoreticalUsageReviewCompleted
boolean

Indicates whether the theoretical usage variances have been reviewed.

itemSummaries
Array of object | null

The variance details for each item in the count.

object

A summary of the usage variance for an item in an inventory count.

item
object

The item the variance applies to.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
uofM
object

The unit of measure used for the variance quantities.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

costAccount
object

The general ledger cost account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object

The general ledger inventory account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

itemCategory1
object

The first category of the item, null when the item has no first category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object

The second category of the item, null when the item has no second category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object

The third category of the item, null when the item has no third category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

quantitiesFromDate
string (date)

The start date of the quantity transaction range used for the variance.

dateLastCounted
string (date) | null

The date of the previous count of the item.

beginningQuantity
number (double) | null

The quantity from the previous count.

beginningAmount
number (double) | null

The amount from the previous count.

purchaseQuantity
number (double)

The quantity from purchasing transactions.

purchaseAmount
number (double)

The amount from purchasing transactions.

transferQuantity
number (double)

The quantity from transfer transactions.

transferAmount
number (double)

The amount from transfer transactions.

endQuantity
number (double)

The quantity from the current count.

endAmount
number (double)

The amount from the current count.

endCost
number (double)

The cost from the current count.

actualUsage
number (double)

The actual usage quantity.

actualUsageAmount
number (double)

The amount of the actual usage.

wasteUsage
number (double)

The usage quantity logged as waste.

wasteUsageAmount
number (double)

The amount of the usage logged as waste.

theoreticalUsage
number (double)

The theoretical usage quantity.

theoreticalUsageAmount
number (double)

The amount of the theoretical usage.

variance
number (double)

The variance between actual and theoretical usage.

varianceAmount
number (double)

The amount of the variance between actual and theoretical usage.

unexplainedVariance
number (double)

The variance with no explaining transactions.

unexplainedVarianceAmount
number (double)

The amount of the variance with no explaining transactions.

efficiency
number (double) | null

The usage efficiency of the item.

isAboveTheoreticalThreshold
boolean

Indicates whether the item is above the allowed efficiency threshold.

templateId
string | null

The unique identifier of the count template the item belongs to.

nextLink
string | null

Link to the next page of results, null when no further pages exist.

Expand All
object

Contains inventory counts matching the supplied filter and pagination criteria.

items
Array of object | null

Inventory counts on the current page.

object

An inventory count, indicating actual inventory levels at a specific point in time.

id
integer (int64)

The unique identifier of the inventory count.

inventoryCountTemplate
object

The template used to initialize the count. Populated for counts created from a single legacy template and null for counts created from new inventory templates.

name
string | null

The name of the inventory count template.

inventoryCountTemplates
Array of object | null

The templates used to initialize the count, ordered from least frequent to most frequent recurrence. Populated for counts created from new inventory templates and empty for counts created from a legacy inventory template.

object

A reference to an inventory count template, including its identifiers and scheduling details.

inventoryCountId
integer (int64)

The unique identifier of the inventory count.

inventoryCountTemplateId
string | null

The unique identifier of the inventory count template.

inventoryCountTemplateName
string | null

The name of the inventory count template.

isGLPostingTemplate
boolean

Indicates whether counts created from the template post to the general ledger.

recurrence
string | null

The recurrence of the template. Values are "On Demand", "Daily", "Weekly", "Period", "Monthly", "Quarterly", "Annually".

location
object

The location being counted.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

legalEntity
object

The legal entity of the location being counted.

id
string (uuid)

Unique identifier of the legal entity.

name
string | null

Display name of the legal entity.

isCountInOpenFiscalPeriod
boolean

Indicates whether the count date falls within an open fiscal period.

name
string | null

The name of the inventory count.

status
string | null

The status of the inventory count. Values are "In Progress", "Completed", "Approved".

date
string (date) | null

The business date the inventory count is for.

duration
string (date-span)

The time from creation of the inventory count until it was marked completed, zero while the count is in progress.

frequency
string | null

The frequency of the inventory count, taken from the least frequent template for counts that combine multiple templates. Values are "On Demand", "Daily", "Weekly", "Period", "Monthly", "Quarterly", "Annually"; counts created from a single legacy template carry that template's free-text frequency.

isGLPosting
boolean

Indicates whether the inventory count posts to the general ledger.

totalAmount
number (double) | null

The total value of the inventory count, calculated as the sum of each item's total counted quantity multiplied by its cost per first unit of measure.

createdOn
string (date-time)

The date and time the inventory count was created.

createdBy
object

The user who created the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date and time the inventory count was last changed.

modifiedBy
object

The user who last modified the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

completedOn
string (date-time) | null

The date and time the inventory count was completed.

completedBy
object

The user who completed the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

approvedOn
string (date-time) | null

The date and time the inventory count was approved.

approvedBy
object

The user who approved the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

teamMember
object

The user who last modified the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

transactionId
string (uuid) | null

The unique identifier (GUID) of the general ledger transaction. Only set when a count that posts to the general ledger has been completed or approved.

alertsCount
integer (int32)

The number of alerts associated with the inventory count.

isCountScheduled
boolean Deprecated

Deprecated. Relates to an earlier version of scheduling and does not indicate whether the count was created from a scheduled template.

isTheoGenerated
boolean

Indicates whether the count quantities were pre-filled from theoretical on-hand quantities.

hasPreviousCountLinks
boolean

Indicates whether the previous count of each counted item is recorded on the count.

details
Array of object | null

The items present on the inventory count.

object

A counted item within an inventory count, for one storage location.

id
integer (int64)

The unique identifier of the detail.

name
string | null

The name of the counted item.

sortIndex
integer (int64)

The sort order of the item within the storage location.

storageLocation
object

The storage location of the counted item.

name
string | null

The name of the inventory count storage location.

inventoryCountTemplateDetailId
integer (int64) | null

The identifier of the template detail used to create this detail.

item
object

The item being counted, including its categories.

id
string (uuid)

The unique identifier (GUID) of the item.

name
string | null

The name of the item.

number
string | null

The item number, if any.

itemType
string | null

The type of the item, if any.

itemCategory1
object

The first category of the item, null when the item has no first category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object

The second category of the item, null when the item has no second category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object

The third category of the item, null when the item has no third category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

costAccount
object

The general ledger cost account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object

The general ledger inventory account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

unitOfMeasure1
object

The first unit of measure configured for the item.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

unitOfMeasure2
object

The second unit of measure configured for the item.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

unitOfMeasure3
object

The third unit of measure configured for the item.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

quantity1
number (double) | null

The counted quantity in the first unit of measure.

quantity2
number (double) | null

The counted quantity in the second unit of measure.

quantity3
number (double) | null

The counted quantity in the third unit of measure.

itemUofM1Cost
number (double)

The cost of the item per first unit of measure.

uofM2QtyMultiplier
number (double)

The conversion factor from the second unit of measure to the first.

uofM3QtyMultiplier
number (double)

The conversion factor from the third unit of measure to the first.

previousQuantity
number (double)

Deprecated. Always returns 0.

totalQuantity
number (double)

The total counted quantity of the item in the storage location.

previousItemUofM1Cost
number (double)

Deprecated. Always returns 0.

isCounted
boolean

Indicates whether the item has been counted in the storage location. A counted quantity of 0 still counts as counted.

totalAmount
number (double)

The total amount of the item in the storage location, calculated as the total counted quantity multiplied by the cost per first unit of measure, rounded to 4 decimal places.

previousAmount
number (double)

Deprecated. Always returns 0.

adjustment
number (double)

Deprecated. Always returns 0.

modifiedOn
string (date-time)

The date and time the detail was last modified.

modifiedBy
object

The user who last modified the detail.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

alert
string | null

The row-level alert for the detail, if any.

templateIds
Array of string | null

The unique identifiers of the templates the item belongs to.

string
varianceSummary
object

The usage variance summary of the inventory count. For counts that combine multiple templates, includes only the items of the least frequent template.

isActualUsageReviewCompleted
boolean

Indicates whether the actual usage variances have been reviewed.

isTheoreticalUsageReviewCompleted
boolean

Indicates whether the theoretical usage variances have been reviewed.

itemSummaries
Array of object | null

The variance details for each item in the count.

object

A summary of the usage variance for an item in an inventory count.

item
object

The item the variance applies to.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
uofM
object

The unit of measure used for the variance quantities.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

costAccount
object

The general ledger cost account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object

The general ledger inventory account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

itemCategory1
object

The first category of the item, null when the item has no first category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object

The second category of the item, null when the item has no second category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object

The third category of the item, null when the item has no third category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

quantitiesFromDate
string (date)

The start date of the quantity transaction range used for the variance.

dateLastCounted
string (date) | null

The date of the previous count of the item.

beginningQuantity
number (double) | null

The quantity from the previous count.

beginningAmount
number (double) | null

The amount from the previous count.

purchaseQuantity
number (double)

The quantity from purchasing transactions.

purchaseAmount
number (double)

The amount from purchasing transactions.

transferQuantity
number (double)

The quantity from transfer transactions.

transferAmount
number (double)

The amount from transfer transactions.

endQuantity
number (double)

The quantity from the current count.

endAmount
number (double)

The amount from the current count.

endCost
number (double)

The cost from the current count.

actualUsage
number (double)

The actual usage quantity.

actualUsageAmount
number (double)

The amount of the actual usage.

wasteUsage
number (double)

The usage quantity logged as waste.

wasteUsageAmount
number (double)

The amount of the usage logged as waste.

theoreticalUsage
number (double)

The theoretical usage quantity.

theoreticalUsageAmount
number (double)

The amount of the theoretical usage.

variance
number (double)

The variance between actual and theoretical usage.

varianceAmount
number (double)

The amount of the variance between actual and theoretical usage.

unexplainedVariance
number (double)

The variance with no explaining transactions.

unexplainedVarianceAmount
number (double)

The amount of the variance with no explaining transactions.

efficiency
number (double) | null

The usage efficiency of the item.

isAboveTheoreticalThreshold
boolean

Indicates whether the item is above the allowed efficiency threshold.

templateId
string | null

The unique identifier of the count template the item belongs to.

additionalVarianceSummary
object

The usage variance summary for the templates other than the least frequent template, for counts that combine multiple templates.

isActualUsageReviewCompleted
boolean

Indicates whether the actual usage variances have been reviewed.

isTheoreticalUsageReviewCompleted
boolean

Indicates whether the theoretical usage variances have been reviewed.

itemSummaries
Array of object | null

The variance details for each item in the count.

object

A summary of the usage variance for an item in an inventory count.

item
object

The item the variance applies to.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
uofM
object

The unit of measure used for the variance quantities.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

costAccount
object

The general ledger cost account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object

The general ledger inventory account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

itemCategory1
object

The first category of the item, null when the item has no first category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object

The second category of the item, null when the item has no second category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object

The third category of the item, null when the item has no third category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

quantitiesFromDate
string (date)

The start date of the quantity transaction range used for the variance.

dateLastCounted
string (date) | null

The date of the previous count of the item.

beginningQuantity
number (double) | null

The quantity from the previous count.

beginningAmount
number (double) | null

The amount from the previous count.

purchaseQuantity
number (double)

The quantity from purchasing transactions.

purchaseAmount
number (double)

The amount from purchasing transactions.

transferQuantity
number (double)

The quantity from transfer transactions.

transferAmount
number (double)

The amount from transfer transactions.

endQuantity
number (double)

The quantity from the current count.

endAmount
number (double)

The amount from the current count.

endCost
number (double)

The cost from the current count.

actualUsage
number (double)

The actual usage quantity.

actualUsageAmount
number (double)

The amount of the actual usage.

wasteUsage
number (double)

The usage quantity logged as waste.

wasteUsageAmount
number (double)

The amount of the usage logged as waste.

theoreticalUsage
number (double)

The theoretical usage quantity.

theoreticalUsageAmount
number (double)

The amount of the theoretical usage.

variance
number (double)

The variance between actual and theoretical usage.

varianceAmount
number (double)

The amount of the variance between actual and theoretical usage.

unexplainedVariance
number (double)

The variance with no explaining transactions.

unexplainedVarianceAmount
number (double)

The amount of the variance with no explaining transactions.

efficiency
number (double) | null

The usage efficiency of the item.

isAboveTheoreticalThreshold
boolean

Indicates whether the item is above the allowed efficiency threshold.

templateId
string | null

The unique identifier of the count template the item belongs to.

nextLink
string | null

Link to the next page of results, null when no further pages exist.

Expand All
object

Contains inventory counts matching the supplied filter and pagination criteria.

items
Array of object | null

Inventory counts on the current page.

object

An inventory count, indicating actual inventory levels at a specific point in time.

id
integer (int64)

The unique identifier of the inventory count.

inventoryCountTemplate
object

The template used to initialize the count. Populated for counts created from a single legacy template and null for counts created from new inventory templates.

name
string | null

The name of the inventory count template.

inventoryCountTemplates
Array of object | null

The templates used to initialize the count, ordered from least frequent to most frequent recurrence. Populated for counts created from new inventory templates and empty for counts created from a legacy inventory template.

object

A reference to an inventory count template, including its identifiers and scheduling details.

inventoryCountId
integer (int64)

The unique identifier of the inventory count.

inventoryCountTemplateId
string | null

The unique identifier of the inventory count template.

inventoryCountTemplateName
string | null

The name of the inventory count template.

isGLPostingTemplate
boolean

Indicates whether counts created from the template post to the general ledger.

recurrence
string | null

The recurrence of the template. Values are "On Demand", "Daily", "Weekly", "Period", "Monthly", "Quarterly", "Annually".

location
object

The location being counted.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

legalEntity
object

The legal entity of the location being counted.

id
string (uuid)

Unique identifier of the legal entity.

name
string | null

Display name of the legal entity.

isCountInOpenFiscalPeriod
boolean

Indicates whether the count date falls within an open fiscal period.

name
string | null

The name of the inventory count.

status
string | null

The status of the inventory count. Values are "In Progress", "Completed", "Approved".

date
string (date) | null

The business date the inventory count is for.

duration
string (date-span)

The time from creation of the inventory count until it was marked completed, zero while the count is in progress.

frequency
string | null

The frequency of the inventory count, taken from the least frequent template for counts that combine multiple templates. Values are "On Demand", "Daily", "Weekly", "Period", "Monthly", "Quarterly", "Annually"; counts created from a single legacy template carry that template's free-text frequency.

isGLPosting
boolean

Indicates whether the inventory count posts to the general ledger.

totalAmount
number (double) | null

The total value of the inventory count, calculated as the sum of each item's total counted quantity multiplied by its cost per first unit of measure.

createdOn
string (date-time)

The date and time the inventory count was created.

createdBy
object

The user who created the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date and time the inventory count was last changed.

modifiedBy
object

The user who last modified the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

completedOn
string (date-time) | null

The date and time the inventory count was completed.

completedBy
object

The user who completed the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

approvedOn
string (date-time) | null

The date and time the inventory count was approved.

approvedBy
object

The user who approved the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

teamMember
object

The user who last modified the inventory count.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

transactionId
string (uuid) | null

The unique identifier (GUID) of the general ledger transaction. Only set when a count that posts to the general ledger has been completed or approved.

alertsCount
integer (int32)

The number of alerts associated with the inventory count.

isCountScheduled
boolean Deprecated

Deprecated. Relates to an earlier version of scheduling and does not indicate whether the count was created from a scheduled template.

isTheoGenerated
boolean

Indicates whether the count quantities were pre-filled from theoretical on-hand quantities.

hasPreviousCountLinks
boolean

Indicates whether the previous count of each counted item is recorded on the count.

details
Array of object | null

The items present on the inventory count.

object

A counted item within an inventory count, for one storage location.

id
integer (int64)

The unique identifier of the detail.

name
string | null

The name of the counted item.

sortIndex
integer (int64)

The sort order of the item within the storage location.

storageLocation
object

The storage location of the counted item.

name
string | null

The name of the inventory count storage location.

inventoryCountTemplateDetailId
integer (int64) | null

The identifier of the template detail used to create this detail.

item
object

The item being counted, including its categories.

id
string (uuid)

The unique identifier (GUID) of the item.

name
string | null

The name of the item.

number
string | null

The item number, if any.

itemType
string | null

The type of the item, if any.

itemCategory1
object

The first category of the item, null when the item has no first category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object

The second category of the item, null when the item has no second category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object

The third category of the item, null when the item has no third category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

costAccount
object

The general ledger cost account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object

The general ledger inventory account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

unitOfMeasure1
object

The first unit of measure configured for the item.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

unitOfMeasure2
object

The second unit of measure configured for the item.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

unitOfMeasure3
object

The third unit of measure configured for the item.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

quantity1
number (double) | null

The counted quantity in the first unit of measure.

quantity2
number (double) | null

The counted quantity in the second unit of measure.

quantity3
number (double) | null

The counted quantity in the third unit of measure.

itemUofM1Cost
number (double)

The cost of the item per first unit of measure.

uofM2QtyMultiplier
number (double)

The conversion factor from the second unit of measure to the first.

uofM3QtyMultiplier
number (double)

The conversion factor from the third unit of measure to the first.

previousQuantity
number (double)

Deprecated. Always returns 0.

totalQuantity
number (double)

The total counted quantity of the item in the storage location.

previousItemUofM1Cost
number (double)

Deprecated. Always returns 0.

isCounted
boolean

Indicates whether the item has been counted in the storage location. A counted quantity of 0 still counts as counted.

totalAmount
number (double)

The total amount of the item in the storage location, calculated as the total counted quantity multiplied by the cost per first unit of measure, rounded to 4 decimal places.

previousAmount
number (double)

Deprecated. Always returns 0.

adjustment
number (double)

Deprecated. Always returns 0.

modifiedOn
string (date-time)

The date and time the detail was last modified.

modifiedBy
object

The user who last modified the detail.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

alert
string | null

The row-level alert for the detail, if any.

templateIds
Array of string | null

The unique identifiers of the templates the item belongs to.

string
varianceSummary
object

The usage variance summary of the inventory count. For counts that combine multiple templates, includes only the items of the least frequent template.

isActualUsageReviewCompleted
boolean

Indicates whether the actual usage variances have been reviewed.

isTheoreticalUsageReviewCompleted
boolean

Indicates whether the theoretical usage variances have been reviewed.

itemSummaries
Array of object | null

The variance details for each item in the count.

object

A summary of the usage variance for an item in an inventory count.

item
object

The item the variance applies to.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
uofM
object

The unit of measure used for the variance quantities.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

costAccount
object

The general ledger cost account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object

The general ledger inventory account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

itemCategory1
object

The first category of the item, null when the item has no first category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object

The second category of the item, null when the item has no second category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object

The third category of the item, null when the item has no third category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

quantitiesFromDate
string (date)

The start date of the quantity transaction range used for the variance.

dateLastCounted
string (date) | null

The date of the previous count of the item.

beginningQuantity
number (double) | null

The quantity from the previous count.

beginningAmount
number (double) | null

The amount from the previous count.

purchaseQuantity
number (double)

The quantity from purchasing transactions.

purchaseAmount
number (double)

The amount from purchasing transactions.

transferQuantity
number (double)

The quantity from transfer transactions.

transferAmount
number (double)

The amount from transfer transactions.

endQuantity
number (double)

The quantity from the current count.

endAmount
number (double)

The amount from the current count.

endCost
number (double)

The cost from the current count.

actualUsage
number (double)

The actual usage quantity.

actualUsageAmount
number (double)

The amount of the actual usage.

wasteUsage
number (double)

The usage quantity logged as waste.

wasteUsageAmount
number (double)

The amount of the usage logged as waste.

theoreticalUsage
number (double)

The theoretical usage quantity.

theoreticalUsageAmount
number (double)

The amount of the theoretical usage.

variance
number (double)

The variance between actual and theoretical usage.

varianceAmount
number (double)

The amount of the variance between actual and theoretical usage.

unexplainedVariance
number (double)

The variance with no explaining transactions.

unexplainedVarianceAmount
number (double)

The amount of the variance with no explaining transactions.

efficiency
number (double) | null

The usage efficiency of the item.

isAboveTheoreticalThreshold
boolean

Indicates whether the item is above the allowed efficiency threshold.

templateId
string | null

The unique identifier of the count template the item belongs to.

additionalVarianceSummary
object

The usage variance summary for the templates other than the least frequent template, for counts that combine multiple templates.

isActualUsageReviewCompleted
boolean

Indicates whether the actual usage variances have been reviewed.

isTheoreticalUsageReviewCompleted
boolean

Indicates whether the theoretical usage variances have been reviewed.

itemSummaries
Array of object | null

The variance details for each item in the count.

object

A summary of the usage variance for an item in an inventory count.

item
object

The item the variance applies to.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
uofM
object

The unit of measure used for the variance quantities.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

costAccount
object

The general ledger cost account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object

The general ledger inventory account of the item.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

itemCategory1
object

The first category of the item, null when the item has no first category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object

The second category of the item, null when the item has no second category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object

The third category of the item, null when the item has no third category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

quantitiesFromDate
string (date)

The start date of the quantity transaction range used for the variance.

dateLastCounted
string (date) | null

The date of the previous count of the item.

beginningQuantity
number (double) | null

The quantity from the previous count.

beginningAmount
number (double) | null

The amount from the previous count.

purchaseQuantity
number (double)

The quantity from purchasing transactions.

purchaseAmount
number (double)

The amount from purchasing transactions.

transferQuantity
number (double)

The quantity from transfer transactions.

transferAmount
number (double)

The amount from transfer transactions.

endQuantity
number (double)

The quantity from the current count.

endAmount
number (double)

The amount from the current count.

endCost
number (double)

The cost from the current count.

actualUsage
number (double)

The actual usage quantity.

actualUsageAmount
number (double)

The amount of the actual usage.

wasteUsage
number (double)

The usage quantity logged as waste.

wasteUsageAmount
number (double)

The amount of the usage logged as waste.

theoreticalUsage
number (double)

The theoretical usage quantity.

theoreticalUsageAmount
number (double)

The amount of the theoretical usage.

variance
number (double)

The variance between actual and theoretical usage.

varianceAmount
number (double)

The amount of the variance between actual and theoretical usage.

unexplainedVariance
number (double)

The variance with no explaining transactions.

unexplainedVarianceAmount
number (double)

The amount of the variance with no explaining transactions.

efficiency
number (double) | null

The usage efficiency of the item.

isAboveTheoreticalThreshold
boolean

Indicates whether the item is above the allowed efficiency threshold.

templateId
string | null

The unique identifier of the count template the item belongs to.

nextLink
string | null

Link to the next page of results, null when no further pages exist.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.