Inventory Zones

Sections

Theme switcher

Get Inventory Count Definition

Header Parameters

Authorizationstring

Query Parameters

selectstring

Allows a comma-separated list of columns to select. If no columns are specified, all columns will be selected by default.

e.g. LedgerBalances.accountCode, LedgerBalances.accountingPeriod, LedgerBalances.baseAmount_amount

Path Parameters

businessUnitstring Required
inventoryCountDefnCodestring Required

Response

200
Object

OK

Response Attributes

analysisDimension1string
analysisDimension1Fromstring
analysisDimension1Tostring
analysisDimension2string
analysisDimension2Fromstring
analysisDimension2Tostring
analysisDimension3string
analysisDimension3Fromstring
analysisDimension3Tostring
analysisDimension4string
analysisDimension4Fromstring
analysisDimension4Tostring
analysisDimension5string
analysisDimension5Fromstring
analysisDimension5Tostring
applyToleranceValuesobject

Show child attributes

automaticLockobject

Show child attributes

batchReferenceRangestring
characteristic1Datatypeobject

Show child attributes

characteristic1Fromstring
characteristic1Tostring
characteristic2Datatypeobject

Show child attributes

characteristic2Fromstring
characteristic2Tostring
characteristic3Datatypeobject

Show child attributes

characteristic3Fromstring
characteristic3Tostring
characteristic4Datatypeobject

Show child attributes

characteristic4Fromstring
characteristic4Tostring
characteristic5Datatypeobject

Show child attributes

characteristic5Fromstring
characteristic5Tostring
characteristicCode1string
characteristicCode2string
characteristicCode3string
characteristicCode4string
characteristicCode5string
dateTimeLastUpdatedstring
descriptionstring
discrepancyEntryOnlyobject

Show child attributes

discreteValueAlpha1string
discreteValueAlpha2string
discreteValueAlpha3string
discreteValueAlpha4string
discreteValueAlpha5string
discreteValueNumeric1number
discreteValueNumeric2number
discreteValueNumeric3number
discreteValueNumeric4number
discreteValueNumeric5number
generateEmptyCountobject

Show child attributes

includeAllLocationsobject

Show child attributes

includeLockedLocationsobject

Show child attributes

includeQuarantinedLocationsobject

Show child attributes

includeRandomiserobject

Show child attributes

inventoryCountDefnCodestring
inventoryCountMethodobject

Show child attributes

itemCodeRangestring
locationRangestring
logicalValue1object

Show child attributes

logicalValue2object

Show child attributes

logicalValue3object

Show child attributes

logicalValue4object

Show child attributes

logicalValue5object

Show child attributes

lookupCodestring
maximumCountLinesinteger
negativeAdjustmentMovementstring
numberOfLinesPerDocketinteger
openBatchesOnlyobject

Show child attributes

optionalDocketPageNumberobject

Show child attributes

overdueItemsOnlyobject

Show child attributes

paretoAnalysisRangeobject

Show child attributes

positiveAdjustmentMovementstring
printOriginalQuantityobject

Show child attributes

productGroupRangestring
reasonCodestring
recalculateExpectedQuantityobject

Show child attributes

runTimeOverride1object

Show child attributes

runTimeOverride2object

Show child attributes

runTimeOverride3object

Show child attributes

runTimeOverride4object

Show child attributes

shortHeadingstring
statusobject

Show child attributes

toBatchstring
toItemCodestring
toLocationstring
toParetoAnalysisobject

Show child attributes

toProductGroupstring
toWarehousestring
toZonestring
toleranceCostIndicatorobject

Show child attributes

tolerancePercentagenumber
toleranceQuantitynumber
toleranceValuenumber
updateCountinteger
userIdLastUpdatedstring
warehouseRangestring
zoneRangestring
userDefinedFieldsobject
linksarray

Show child attributes

401
Object

Unauthorised.

403
Object

Forbidden

404
Object

Not found

500
Object

Internal server error

Response Attributes

statusCodestring

The HTTP status code.

internalStatusCodestring

A internal status code for diagnosing the error.

messagestring

A user friendly message describing the error.

errorsstring

A collection of error messages that give more detail of the error.

retryablestring

Indicates that the operation can be retried.

504
Object

Request timed out.

Response Attributes

statusCodestring

The HTTP status code.

internalStatusCodestring

A internal status code for diagnosing the error.

messagestring

A user friendly message describing the error.

errorsstring

A collection of error messages that give more detail of the error.

retryablestring

Indicates that the operation can be retried.

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?