Purchase Item Register Report
POST
/api/v1/report/purchase-item-register
Purchase Item Register Report
Purpose
Why would you use this?
Information Required
| Field | Required | Description |
|---|---|---|
| api-token | Yes | Authentication token provided by VasyERP |
| dateFrom | No | Start date in UTC format (ISO 8601) |
| dateTo | No | End date in UTC format (ISO 8601) |
| limit | Yes | Number of records to retrieve |
| offset | Yes | Number of records to skip |
| branchList | No | Comma-separated Branch IDs |
| categoryIds | No | Comma-separated Category IDs |
| subCategoryIds | No | Comma-separated Sub Category IDs |
| brandIds | No | Comma-separated Brand IDs |
| subBrandIds | No | Comma-separated Sub Brand IDs |
| productIds | No | Comma-separated Product IDs |
| productType | No | Filter by product type |
| departmentIds | No | Comma-separated Department IDs |
| contactId | No | Comma-separated Supplier Contact ID |
| createdByIds | No | Comma-separated User IDs |
| shippingFromDate | No | Shipping start date in UTC format |
| shippingToDate | No | Shipping end date in UTC format |
| dueFromDate | No | Due start date in UTC format |
| dueToDate | No | Due end date in UTC format |
Information Returned
Important Notes
Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/report/purchase-item-register' \
--header 'api-token: {{.in-api-token}}' \
--header 'Content-Type: application/json' \
--data '{
"dateFrom": "2020-02-04T00:00:00Z",
"dateTo": "2026-05-31T23:59:59Z",
"branchList": "",
"categoryIds": "",
"brandIds": "",
"subBrandIds": "",
"subCategoryIds": "",
"productIds": "",
"productType": "",
"departmentIds": "",
"contactId": "5313752,5313756",
"createdByIds": "",
"shippingFromDate": "",
"shippingToDate": "",
"dueFromDate": "",
"dueToDate": "",
"limit": 2,
"offset": 0
}'Response Response Example
200 - Example 1
{
"status": true,
"message": "Purchase Item Register List",
"code": "200",
"response": {
"totalCount": 2685,
"items": [
{
"purchaseId": 1080224,
"billDate": "29/05/2026",
"billNo": "BIL59",
"voucherNo": "BIL59",
"contactId": 5313891,
"partyName": "Umesh",
"address": "Rahuri",
"gstNo": "-",
"panNo": "-",
"department": "FMCG",
"category": "Beauty & Hygiene",
"subCategory": "Face Care",
"brand": "Glow & Handsome",
"subBrand": "-",
"unit": "PIECES",
"hsn": "34013090",
"productType": "Finished",
"productName": "Glow & Handsome Instant Brightness Rapid Action Facewash 100 gm",
"shortDescription": "-",
"itemCode": "8909106009837",
"rate": 133.12,
"landingCost": 100.08,
"mrp": 199.0,
"sellingPrice": 191.0,
"qty": 1.0,
"freeQty": 0.0,
"discount1": 0.0,
"discount2": 0.0,
"flatDiscountAmount": 48.30557677616502,
"cessRate": 0.0,
"cessAmount": 0.0,
"totalAmount": 100.08,
"taxableAmount": 84.81,
"cgst": 7.635,
"igst": 0.0,
"sgst": 7.635,
"taxRate": 18.0,
"taxAmount": 15.27,
"tcsAmount": 0.0,
"tdsAmount": 0.0,
"location": "my business",
"totalBillAmount": 100.0,
"createdBy": "my business"
},
{
"purchaseId": 1080184,
"billDate": "28/05/2026",
"billNo": "BIL58",
"voucherNo": "BIL58",
"contactId": 5313891,
"partyName": "Umesh",
"address": "Rahuri",
"gstNo": "-",
"panNo": "-",
"department": "FMCG",
"category": "Beauty & Hygiene",
"subCategory": "Face Care",
"brand": "Glow & Handsome",
"subBrand": "-",
"unit": "PIECES",
"hsn": "34013090",
"productType": "Finished",
"productName": "Glow & Handsome Instant Brightness Rapid Action Facewash 100 gm",
"shortDescription": "-",
"itemCode": "8909106009837",
"rate": 133.12,
"landingCost": 157.08,
"mrp": 199.0,
"sellingPrice": 191.0,
"qty": 1.0,
"freeQty": 0.0,
"discount1": 0.0,
"discount2": 0.0,
"flatDiscountAmount": 0.0,
"cessRate": 0.0,
"cessAmount": 0.0,
"totalAmount": 157.08,
"taxableAmount": 133.12,
"cgst": 11.98,
"igst": 0.0,
"sgst": 11.98,
"taxRate": 18.0,
"taxAmount": 23.96,
"tcsAmount": 0.0,
"tdsAmount": 0.0,
"location": "my business",
"totalBillAmount": 157.08,
"createdBy": "my business"
}
]
}
}