Skip to main content

Monthly Cost Query

The GetMonthlyCostInfo endpoint returns monthly cost information from the MIMS system.


How to query monthly cost

HTTP POST Request

Request TypeExample URL
POST{{url_base}}/GetMonthlyCostInfo
Examplehttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetMonthlyCostInfo"

Input Parameters

ParameterTypeRequiredDescription
PeriodString(40)YesPeriod (Month + Year)
BranchNoString(25)YesExternal branch code

Return

ParameterTypeRequiredDescription
WebServiceReturnWebServiceReturnYesStandard WebService response information on method execution
MonthlyCostInfoDatatListGetMonthlyCostItemYesList of all monthly costs per product in the period

📝 GetMonthlyCostItem Object

The GetMonthlyCostItem object represents the cost of a product in the period

Return Parameters

ParameterTypeRequiredDescription
BranchNoString(25)YesExternal branch code
PeriodString(40)YesPeriod (Month + Year)
ProductNoString(25)YesExternal product code
TotalProductWeightFloatYesTotal product weight
LastDayProcessingMonthDataHoraYesDate/Time of the last day of the month in which data was processed
CostProductRealValueFloatYesReal product cost per kilo
CostProductPresumedValueFloatYesPresumed product cost per kilo

Request Example

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetMonthlyCostInfo"' \
--header 'Content-Type: application/json' \
--data '{
"Period": "202502",
"BranchNo": "BR001"
}'

Response Example

{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"MonthlyCostInfoData": [
{
"BranchNo": "BR001",
"Period": "202502",
"ProductNo": "PROD001",
"TotalProductWeight": 1000.0,
"LastDayProcessingMonth": "2025-02-28T23:59:59Z",
"CostProductRealValue": 5.50,
"CostProductPresumedValue": 5.75
}
]
}