Stock Summary Report
POST
/api/v1/report/stock-summary
Stock Summary Report
Purpose
Why would you use this?
Information Required
| Field | Required | Description |
|---|---|---|
| api-token | Yes | Authentication token provided by VasyERP |
| branchList | Yes | Comma-separated Branch IDs |
| fromDate | Yes | Start date in UTC format (ISO 8601) |
| toDate | Yes | End date in UTC format (ISO 8601) |
| limit | Yes | Number of records to retrieve |
| offset | Yes | Number of records to skip |
| product | No | Product ID(s) to filter records |
| category | No | Category ID(s) to filter records |
| subCategoryId | No | Sub Category ID(s) to filter records |
| brand | No | Brand ID(s) to filter records |
| subBrandId | No | Sub Brand ID(s) to filter records |
Information Returned
Important Notes
Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/report/stock-summary' \
--header 'api-token: {{.in-api-token}}' \
--header 'Content-Type: application/json' \
--data '{
"branchList": "24448",
"fromDate": "2026-03-31T18:30:00Z",
"toDate": "2027-04-01T18:29:59Z",
"product": "",
"category": "",
"subCategoryId": "",
"brand": "",
"subBrandId": "",
"limit": 2,
"offset": 0
}'Response Response Example
200 - Example
{
"status": true,
"message": "Stock Summary List",
"code": "200",
"response": {
"totalCount": 4487,
"items": [
{
"productId": 18172417,
"productVariantId": 20335005,
"branchName": "my business",
"itemCode": "ITEM101",
"productName": "ITEM101",
"categoryName": "Chocolate",
"variantName": null,
"unit": "PCS",
"mrp": 315.0,
"sellingPrice": 315.0,
"discount": 0.0,
"discountType": "percentage",
"purchasePrice": 169.49,
"openingStock": 0.0,
"inQty": 3.0,
"outQty": 4.0
},
{
"productId": 18172418,
"productVariantId": 20335006,
"branchName": "my business",
"itemCode": "ITEM102",
"productName": "ITEM102",
"categoryName": "Chocolate",
"variantName": null,
"unit": "PCS",
"mrp": 200.0,
"sellingPrice": 200.0,
"discount": 0.0,
"discountType": "percentage",
"purchasePrice": 84.75,
"openingStock": 0.0,
"inQty": 1.0,
"outQty": 2.0
}
]
}
}