Stock Counts

The StockCounts resource allows stock counts to be listed.

The full range of URIs and HTTP Verbs supported are:

Operation	HTTP Action
List a page of Stock Counts	GET `/StockCounts`
View a specific Stock Count	GET `/StockCounts/{stockCountGuid}`

GET Stock Counts

Available Filters for GET Stock Counts

Filter	Description
`completedAfter`	Returns Stock Counts completed after the specified date.
`completedBefore`	Returns Stock Counts completed before the specified date.
`endDate`	Only return Stock Counts created before a specified date.
`modifiedSince`	Returns Stock Counts created or modified since the specified date.
`startDate`	Only return Stock Counts created after a specified date.
`warehouseCode`	Returns Stock Counts with the specified warehouse code.

Note: Date filters should be provided in the ISO format YYYY-MM-DD.

Available Fields for GET Stock Counts

Property	Type	Length
CompletedDate	Nullable DateTime
CostOfGoodsAccount	String	500
CountDate	DateTime
CountType	String	10
Description	String	200
Guid	Guid
Status	String	20
StockCountLines	StockCountLine collection
StockTakeCode	String	20
StockTakeName	String	500
Warehouse	Warehouse

Available Fields for GET Stock Count Lines

Property	Type
AvailableQuantity	Decimal
AverageLandPriceAtTimeOfStockTake	Nullable Decimal
CountQuantity	Nullable Decimal
ExpiryDate	Nullable DateTime
Guid	Guid
LineNumber	Integer
OnHandQuantity	Decimal
Product	Product
ReceiptFIFODate	DateTime

Available Fields for GET Warehouse

Property	Type	Length
Guid	Guid
WarehouseCode	String	15
WarehouseName	String	100

Available Fields for GET Product

Property	Type	Length
Guid	Guid
ProductCode	String	100
ProductDescription	String	500

Examples for Response GET `/StockCounts`

show xml example

 
<?xml version="1.0"?>
<StockCounts xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
    <StockCount>
        <Guid>9317a6e3-1e27-4c49-bc5e-f5e1501d9c1c</Guid>
        <LastModifiedOn>2022-12-01T04:10:40.3751583</LastModifiedOn>
        <CompletedDate xsi:nil="true" />
        <CountDate>2022-12-01T00:00:00</CountDate>
        <CountType>Perpetual</CountType>
        <Status>Active</Status>
        <StockTakeCode>ST-00000011</StockTakeCode>
        <Warehouse>
            <Guid>1e60464c-b607-41ed-909b-58a131f600a9</Guid>
            <WarehouseCode>MAIN</WarehouseCode>
            <WarehouseName>Main Warehouse</WarehouseName>
        </Warehouse>
        <StockCountLines>
            <StockCountLine>
                <Guid>28477aec-b0ef-4618-aee9-26334a6c34a8</Guid>
                <LastModifiedOn>2022-12-01T04:10:40.3751583</LastModifiedOn>
                <LineNumber>1</LineNumber>
                <Product>
                    <Guid>f95b47ae-9ea5-410b-b592-1e60e1a33675</Guid>
                    <ProductCode>DININGCHAIR</ProductCode>
                    <ProductDescription>Dining Chair</ProductDescription>
                </Product>
                <AvailableQuantity>240.0000</AvailableQuantity>
                <AverageLandPriceAtTimeOfStockTake xsi:nil="true" />
                <CountQuantity>33.0000</CountQuantity>
                <ExpiryDate xsi:nil="true" />
                <OnHandQuantity>240.0000</OnHandQuantity>
                <ReceiptFIFODate>2022-12-01T00:00:00</ReceiptFIFODate>
            </StockCountLine>
        </StockCountLines>
    </StockCount>
</StockCounts>

show json example

{
    "Items": [
        {
            "CompletedDate": null,
            "CostOfGoodsAccount": null,
            "CountDate": "/Date(1669852800000)/",
            "CountType": "Perpetual",
            "Description": null,
            "Status": "Active",
            "StockTakeCode": "ST-00000011",
            "StockTakeName": null,
            "Warehouse": {
                "WarehouseCode": "MAIN",
                "WarehouseName": "Main Warehouse",
                "Guid": "1e60464c-b607-41ed-909b-58a131f600a9"
            },
            "StockCountLines": [
                {
                    "LineNumber": 1,
                    "Product": {
                        "Guid": "f95b47ae-9ea5-410b-b592-1e60e1a33675",
                        "ProductCode": "DININGCHAIR",
                        "ProductDescription": "Dining Chair"
                    },
                    "AvailableQuantity": 240.0000,
                    "AverageLandPriceAtTimeOfStockTake": null,
                    "CountQuantity": 33.0000,
                    "ExpiryDate": null,
                    "OnHandQuantity": 240.0000,
                    "ReceiptFIFODate": "/Date(1669852800000)/",
                    "Guid": "28477aec-b0ef-4618-aee9-26334a6c34a8",
                    "LastModifiedOn": "/Date(1669867840375)/"
                }
            ],
            "Guid": "9317a6e3-1e27-4c49-bc5e-f5e1501d9c1c",
            "LastModifiedOn": "/Date(1669867840375)/"
        }
    ]
}

Stock Counts

The full range of URIs and HTTP Verbs supported are:

GET Stock Counts

Examples for Response GET /StockCounts

Examples for Response GET `/StockCounts`