> For the complete documentation index, see [llms.txt](https://docs.hotwax.co/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hotwax.co/documents/integrate-with-hotwax/components/inventory-count/models.md).

# Models

## The co.hotwax.datamanager.DataManagerMapping object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.datamanager.DataManagerMapping":{"title":"Data Manager Mapping","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerMapping"},"mappingPrefId":{"type":"string"},"mappingPrefName":{"type":"string"},"mappingPrefTypeEnumId":{"type":"string"},"mappingPrefValue":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.datamanager.DataManagerMapping.PK object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.datamanager.DataManagerMapping.PK":{"title":"Data Manager Mapping","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerMapping.PK"},"mappingPrefId":{"type":"string"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.createPhysicalInventory.In object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.createPhysicalInventory.In":{"type":"object","properties":{"inventoryCountProductsList":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"facilityId":{"type":"string"},"varianceQuantity":{"type":"number"},"decisionOutcomeEnumId":{"type":"string"},"decisionReasonEnumId":{"type":"string"},"workEffortId":{"type":"string"},"systemQuantity":{"type":"number"},"countedQuantity":{"type":"number"},"comments":{"type":"string"}}}}},"required":["inventoryCountProductsList"]}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.createPhysicalInventory.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.createPhysicalInventory.Out":{"type":"object","properties":{"physicalInventoryId":{"type":"string"},"inventoryItemId":{"type":"string"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.uploadInventoryCountImports.In object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.uploadInventoryCountImports.In":{"type":"object","properties":{"contentPath":{"type":"string","description":"By default, the system uploads the file to runtime://datamanager.\n                    If the contentPath is provided, it places file at runtime://datamanager/${contentPath}."},"contentFile":{"type":"string"}},"required":["contentFile"]}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.uploadInventoryCountImports.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.uploadInventoryCountImports.Out":{"type":"object","properties":{"fileName":{"type":"string"},"contentLocation":{"type":"string"},"fileSize":{"type":"integer","format":"int64","description":"Uploaded file size in Bytes"}},"required":["fileName","contentLocation"]}}}}
```

## The systemMessages object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"systemMessages":{"title":"System Message","type":"object","properties":{"_entity":{"type":"string","default":"systemMessages"},"systemMessageId":{"type":"string"},"systemMessageTypeId":{"type":"string"},"systemMessageRemoteId":{"type":"string"},"statusId":{"type":"string","enum":["SmsgProduced","SmsgSending","SmsgSent","SmsgReceived","SmsgConsuming","SmsgConsumed","SmsgConfirmed","SmsgRejected","SmsgCancelled","SmsgError"]},"isOutgoing":{"type":"string"},"initDate":{"type":"string","format":"date-time"},"processedDate":{"type":"string","format":"date-time"},"lastAttemptDate":{"type":"string","format":"date-time"},"failCount":{"type":"number","format":"int64"},"parentMessageId":{"type":"string"},"ackMessageId":{"type":"string"},"remoteMessageId":{"type":"string"},"messageText":{"type":"string"},"senderId":{"type":"string"},"receiverId":{"type":"string"},"messageId":{"type":"string"},"messageDate":{"type":"string","format":"date-time"},"docType":{"type":"string"},"docSubType":{"type":"string"},"docControl":{"type":"string"},"docSubControl":{"type":"string"},"docVersion":{"type":"string"},"triggerVisitId":{"type":"string"},"productStoreId":{"type":"string"},"shopId":{"type":"string"},"jobRunId":{"type":"string"},"orderId":{"type":"string"},"consumeSmrId":{"type":"string"},"shopifyWebhookId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The systemMessages.PK object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"systemMessages.PK":{"title":"System Message","type":"object","properties":{"_entity":{"type":"string","default":"systemMessages.PK"},"systemMessageId":{"type":"string"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.getUploadedCsvFile.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.getUploadedCsvFile.Out":{"type":"object","properties":{"csvData":{"type":"string"}}}}}}
```

## The moqui.service.message.SystemMessageError object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"moqui.service.message.SystemMessageError":{"title":"System Message Error","type":"object","properties":{"_entity":{"type":"string","default":"moqui.service.message.SystemMessageError"},"systemMessageId":{"type":"string"},"errorDate":{"type":"string","format":"date-time"},"attemptedStatusId":{"type":"string"},"errorText":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.warehouse.FacilityAndLocationAndEnumeration object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.FacilityAndLocationAndEnumeration":{"title":"Facility And Location And Enumeration","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.FacilityAndLocationAndEnumeration"},"facilityId":{"type":"string"},"facilityName":{"type":"string"},"facilityTypeId":{"type":"string"},"locationSeqId":{"type":"string"},"locationTypeEnumId":{"type":"string"},"areaId":{"type":"string"},"aisleId":{"type":"string"},"sectionId":{"type":"string"},"levelId":{"type":"string"},"positionId":{"type":"string"},"geoPointId":{"type":"string"},"isLocked":{"type":"string"},"lastCountDate":{"type":"string","format":"date"},"nextCountDate":{"type":"string","format":"date"},"externalId":{"type":"string"},"enumTypeId":{"type":"string"},"parentEnumId":{"type":"string"},"enumCode":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"optionValue":{"type":"string"},"optionIndicator":{"type":"string"},"relatedEnumId":{"type":"string"},"relatedEnumTypeId":{"type":"string"},"statusFlowId":{"type":"string"},"enumName":{"type":"string"},"primaryEnumerationGroupId":{"type":"string"}}}}}}
```

## The org.apache.ofbiz.workeffort.workeffort.WorkEffort object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"org.apache.ofbiz.workeffort.workeffort.WorkEffort":{"title":"Work Effort","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.workeffort.workeffort.WorkEffort"},"workEffortId":{"type":"string"},"workEffortTypeId":{"type":"string"},"statusId":{"type":"string"},"lastStatusUpdate":{"type":"string","format":"date-time"},"workEffortPurposeTypeId":{"type":"string"},"workEffortParentId":{"type":"string"},"scopeEnumId":{"type":"string"},"priority":{"type":"number","format":"int64"},"percentComplete":{"type":"number","format":"int64"},"workEffortName":{"type":"string"},"showAsEnumId":{"type":"string"},"sendNotificationEmail":{"type":"string"},"description":{"type":"string"},"locationDesc":{"type":"string"},"estimatedStartDate":{"type":"string","format":"date-time"},"estimatedCompletionDate":{"type":"string","format":"date-time"},"actualStartDate":{"type":"string","format":"date-time"},"actualCompletionDate":{"type":"string","format":"date-time"},"estimatedMilliSeconds":{"type":"number","format":"double"},"estimatedSetupMillis":{"type":"number","format":"double"},"estimateCalcMethod":{"type":"string"},"actualMilliSeconds":{"type":"number","format":"double"},"actualSetupMillis":{"type":"number","format":"double"},"totalMilliSecondsAllowed":{"type":"number","format":"double"},"totalMoneyAllowed":{"type":"number"},"moneyUomId":{"type":"string"},"specialTerms":{"type":"string"},"timeTransparency":{"type":"number","format":"int64"},"universalId":{"type":"string"},"sourceReferenceId":{"type":"string"},"fixedAssetId":{"type":"string"},"facilityId":{"type":"string"},"infoUrl":{"type":"string"},"recurrenceInfoId":{"type":"string"},"tempExprId":{"type":"string"},"runtimeDataId":{"type":"string"},"noteId":{"type":"string"},"serviceLoaderName":{"type":"string"},"quantityToProduce":{"type":"number"},"quantityProduced":{"type":"number"},"quantityRejected":{"type":"number"},"reservPersons":{"type":"number"},"reserv2ndPPPerc":{"type":"number"},"reservNthPPPerc":{"type":"number"},"accommodationMapId":{"type":"string"},"accommodationSpotId":{"type":"string"},"revisionNumber":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"createdByUserLogin":{"type":"string"},"createdByUserId":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastModifiedByUserLogin":{"type":"string"},"dueDate":{"type":"string","format":"date-time"},"notes":{"type":"string"},"externalId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The org.apache.ofbiz.workeffort.workeffort.WorkEffort.PK object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"org.apache.ofbiz.workeffort.workeffort.WorkEffort.PK":{"title":"Work Effort","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.workeffort.workeffort.WorkEffort.PK"},"workEffortId":{"type":"string"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.getCycleCounts.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.getCycleCounts.Out":{"type":"object","properties":{"cycleCounts":{"type":"string"},"cycleCountsCount":{"type":"string"}}}}}}
```

## The co.hotwax.warehouse.InventoryCountImport object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryCountImport":{"title":"Inventory Count Import","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryCountImport"},"inventoryCountImportId":{"type":"string"},"countImportName":{"type":"string"},"uploadedByUserLogin":{"type":"string"},"parentCountId":{"type":"string"},"statusId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"dueDate":{"type":"string","format":"date-time"},"workEffortId":{"type":"string"},"facilityAreaId":{"type":"string"},"approvedDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.warehouse.InventoryCountImport.PK object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryCountImport.PK":{"title":"Inventory Count Import","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryCountImport.PK"},"inventoryCountImportId":{"type":"string"}}}}}}
```

## The co.hotwax.warehouse.InventoryCountReview object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryCountReview":{"title":"Inventory Count Review","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryCountReview"},"facilityId":{"type":"string"},"workEffortId":{"type":"string"},"productId":{"type":"string"},"internalName":{"type":"string"},"detailImageUrl":{"type":"string"},"primaryProductCategoryId":{"type":"string"},"quantityOnHand":{"type":"number"},"unitCost":{"type":"number"},"inventoryItemId":{"type":"string"},"quantity":{"type":"number"},"price":{"type":"number"},"decisionOutcomeEnumId":{"type":"string"},"varianceQuantity":{"type":"number"},"systemQuantity":{"type":"number"},"countedQuantity":{"type":"number"},"systemQuantityOnHand":{"type":"number"},"numberOfSessions":{"type":"number"},"proposedVarianceQuantity":{"type":"number"},"extendedUnitCost":{"type":"number"},"extendedPrice":{"type":"number"},"minLastUpdatedAt":{"type":"string","format":"date-time"},"maxLastUpdatedAt":{"type":"string","format":"date-time"},"isRequested":{"type":"string"}}}}}}
```

## The co.hotwax.warehouse.InventoryCountImportAndItem object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryCountImportAndItem":{"title":"Inventory Count Import And Item","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryCountImportAndItem"},"workEffortId":{"type":"string"},"inventoryCountImportId":{"type":"string"},"countImportName":{"type":"string"},"statusId":{"type":"string"},"productId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedAt":{"type":"string","format":"date-time"},"uploadedByUserLogin":{"type":"string"},"counted":{"type":"number"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.storeInventoryCountImportItem.In object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.storeInventoryCountImportItem.In":{"type":"object","properties":{"workEffortId":{"type":"string"},"inventoryCountImportId":{"type":"string"},"items":{"type":"array","items":{"type":"string"}}},"required":["inventoryCountImportId"]}}}}
```

## The co.hotwax.warehouse.InventoryCountImportItemAndInventory object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryCountImportItemAndInventory":{"title":"Inventory Count Import Item And Inventory","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryCountImportItemAndInventory"},"facilityId":{"type":"string"},"availableToPromiseTotal":{"type":"number"},"quantityOnHandTotal":{"type":"number"},"inventoryCountImportId":{"type":"string"},"importItemSeqId":{"type":"string"},"locationSeqId":{"type":"string"},"productId":{"type":"string"},"productIdentifier":{"type":"string"},"quantity":{"type":"number"},"countedByUserLoginId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"createdByUserLoginId":{"type":"string"},"uuid":{"type":"string"},"isRequested":{"type":"string"},"systemQuantityOnHand":{"type":"number"}}}}}}
```

## The co.hotwax.warehouse.InventoryCountImportItem.PK object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryCountImportItem.PK":{"title":"Inventory Count Import Item","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryCountImportItem.PK"},"inventoryCountImportId":{"type":"string"},"importItemSeqId":{"type":"string"}}}}}}
```

## The co.hotwax.warehouse.InventoryCountImportItem object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryCountImportItem":{"title":"Inventory Count Import Item","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryCountImportItem"},"inventoryCountImportId":{"type":"string"},"importItemSeqId":{"type":"string"},"locationSeqId":{"type":"string"},"productId":{"type":"string"},"productIdentifier":{"type":"string"},"quantity":{"type":"number"},"countedByUserLoginId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"createdByUserLoginId":{"type":"string"},"uuid":{"type":"string"},"isRequested":{"type":"string"},"systemQuantityOnHand":{"type":"number"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.cloneDirectedCountImport.In object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.cloneDirectedCountImport.In":{"type":"object","properties":{"inventoryCountImportId":{"type":"string"},"facilityAreaId":{"type":"string"},"countImportName":{"type":"string"}},"required":["inventoryCountImportId"]}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.cloneDirectedCountImport.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.cloneDirectedCountImport.Out":{"type":"object","properties":{"inventoryCountImportId":{"type":"string"}}}}}}
```

## The co.hotwax.warehouse.InventoryCountImportLock object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryCountImportLock":{"title":"Inventory Count Import Lock","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryCountImportLock"},"inventoryCountImportId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"deviceId":{"type":"string"},"userId":{"type":"string"},"overrideByUserId":{"type":"string"},"leaseSeconds":{"type":"number"},"lastHeartbeatAt":{"type":"string","format":"date-time"},"overrideReason":{"type":"string"},"createdByUserLoginId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.createSessionLock.In object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.createSessionLock.In":{"type":"object","properties":{"inventoryCountImportId":{"type":"string"},"deviceId":{"type":"string"},"userId":{"type":"string"},"fromDate":{"type":"string"},"thruDate":{"type":"string"}},"required":["inventoryCountImportId"]}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.createSessionLock.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.createSessionLock.Out":{"type":"object","properties":{"inventoryCountImportId":{"type":"string"},"fromDate":{"type":"string"}}}}}}
```

## The co.hotwax.warehouse.InventoryCountImportLock.PK object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryCountImportLock.PK":{"title":"Inventory Count Import Lock","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryCountImportLock.PK"},"inventoryCountImportId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.queueCycleCountsToExport.In object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.queueCycleCountsToExport.In":{"type":"object","properties":{"countType":{"type":"string"},"facilityId":{"type":"string"},"facilityId_op":{"type":"string","default":"in"},"createdDateFrom":{"type":"string"},"createdDateTo":{"type":"string"},"closedDate":{"type":"string"},"closedDateTo":{"type":"string"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.getExportedCycleCounts.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.getExportedCycleCounts.Out":{"type":"object","properties":{"csvData":{"type":"string"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.checkCycleCount.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.checkCycleCount.Out":{"type":"object","properties":{"isStatusConfigured":{"type":"string","description":"Are WorkEffort(Cycle Count) and InventoryCountImport(Session) statuses configured"},"isWorkEffortStatusFlowConfigured":{"type":"string","description":"Is WorkEffort statusFlowTransitions configured"},"isSessionStatusFlowConfigured":{"type":"string","description":"Is InventoryCountImport statusFlowTransitions configured"},"isAllProductFacDataDocPresent":{"type":"string","description":"Does ProductFacilityAndInventoryItem Data Doc Exists"},"isSessionLockDataDocPresent":{"type":"string","description":"Does InventoryCountImportLock Data Doc Exists"},"isWorkEffortRelatedWithTypeEnum":{"type":"string","description":"Does WorkEffort Type Enum foreign key exists in WorkEffort"},"isWorkEffortRelatedWithPurposeTypeEnum":{"type":"string","description":"Does WorkEffort Purpose Type Enum foreign key exists in WorkEffort"},"isImportItemRelatedToProduct":{"type":"string","description":"Does Product foreign key exists in InventoryCountImportItem"},"isWorkEffortRelatedToInventoryCountImport":{"type":"string","description":"Does InventoryCountImport has foreign key to WorkEffort on workEffortId"},"areAllPermissionConfigured":{"type":"string","description":"Flag indicating if all required security permissions are configured in the system"},"permissionsChecked":{"type":"string","description":"List of security permissions that were checked for existence"},"missingPermissions":{"type":"string","description":"List Missing Permissions"},"areDecisionOutcomesConfigured":{"type":"string","description":"Are Decision outcomes imported"},"decisionsOutcomeEnums":{"type":"string","description":"Cycle Count Decision outcome enum data"},"areDecisionReasonsConfigured":{"type":"string","description":"Are Decision reasons imported"},"decisionsReasonEnums":{"type":"string","description":"Cycle Count Decision Reason enum data"},"areImportExportSystemMessageTypeConfigured":{"type":"string","description":"Are Import/Export System Message Type Data Imported"},"cycleCountImportAndExportSystemMessages":{"type":"string","description":"These are available System Messages for Import/Export Cycle Counts"},"facilityCountWithNoTimeZoneSet":{"type":"string","description":"Number of facilities having no time zone set to them, Facility Time zone are applied to date time fields during cycle count upload"},"messageList":{"type":"string"}}}}}}
```

## The co.hotwax.search.SearchServices.runSolrQuery.In object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.search.SearchServices.runSolrQuery.In":{"type":"object","properties":{"json":{"type":"object"}}}}}}
```

## The co.hotwax.search.SearchServices.runSolrQuery.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.search.SearchServices.runSolrQuery.Out":{"type":"object","properties":{"responseHeader":{"type":"object"},"response":{"type":"object"},"facets":{"type":"object"},"grouped":{"type":"object"}}}}}}
```

## The co.hotwax.atp.AtpServices.getProducts.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.atp.AtpServices.getProducts.Out":{"type":"object","properties":{"productDetail":{"type":"object"}}}}}}
```

## The co.hotwax.cycleCount.InventoryCountServices.recordProductVariance.In object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.cycleCount.InventoryCountServices.recordProductVariance.In":{"type":"object","properties":{"partyId":{"type":"string"},"varianceList":{"type":"array","items":{"type":"string"}}},"required":["varianceList"]}}}}
```

## The co.hotwax.poorti.FulfillmentServices.adjustInventoryDeltaByIdentification.In object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.poorti.FulfillmentServices.adjustInventoryDeltaByIdentification.In":{"type":"object","properties":{"facilityId":{"type":"string"},"externalFacilityId":{"type":"string"},"productId":{"type":"string"},"idType":{"type":"string"},"idValue":{"type":"string"},"availableDelta":{"type":"number"},"allowNegativeInventory":{"type":"boolean","description":"If false, a negative delta is limited so quantity on hand never drops below zero. Available to promise\n                    may still go negative when the removed units are reserved, until those reservations are released.","default":"{true}"},"comments":{"type":"string"},"reasonEnumId":{"type":"string","default":"VAR_MANUAL"}},"required":["availableDelta"]}}}}
```

## The co.hotwax.poorti.FulfillmentServices.adjustInventoryDeltaByIdentification.Out object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.poorti.FulfillmentServices.adjustInventoryDeltaByIdentification.Out":{"type":"object","properties":{"facilityId":{"type":"string"},"productId":{"type":"string"},"inventoryItemId":{"type":"string"},"availableDelta":{"type":"number","description":"The delta actually applied; 0 when the adjustment was skipped."},"applied":{"type":"boolean"},"skipReason":{"type":"string","description":"Set only when applied is false."},"physicalInventoryId":{"type":"string"}}}}}}
```

## The co.hotwax.warehouse.InventoryVarianceDecisionDetail object

```json
{"openapi":"3.1.1","info":{"title":"Directed Cycle Count REST API","version":"4.0.0"},"components":{"schemas":{"co.hotwax.warehouse.InventoryVarianceDecisionDetail":{"title":"Inventory Variance Decision Detail","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.warehouse.InventoryVarianceDecisionDetail"},"workEffortName":{"type":"string"},"workEffortPurposeTypeId":{"type":"string"},"workEffortStatusId":{"type":"string"},"estimatedStartDate":{"type":"string","format":"date-time"},"actualStartDate":{"type":"string","format":"date-time"},"actualCompletionDate":{"type":"string","format":"date-time"},"facilityName":{"type":"string"},"facilityTypeId":{"type":"string"},"internalName":{"type":"string"},"productName":{"type":"string"},"primaryProductCategoryId":{"type":"string"},"reasonDescription":{"type":"string"},"reasonEnumName":{"type":"string"},"outcomeDescription":{"type":"string"},"outcomeEnumName":{"type":"string"},"workEffortId":{"type":"string"},"facilityId":{"type":"string"},"productId":{"type":"string"},"countedQuantity":{"type":"number"},"systemQuantity":{"type":"number"},"varianceQuantity":{"type":"number"},"decisionReasonEnumId":{"type":"string"},"decisionOutcomeEnumId":{"type":"string"},"decidedByUserLoginId":{"type":"string"},"decidedDateTime":{"type":"string","format":"date-time"},"comments":{"type":"string"},"inventoryItemId":{"type":"string"},"physicalInventoryId":{"type":"string"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/inventory-count/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.