Raw Material Stock Consumption Information

The GetMaterialConsumption endpoint returns raw material stock consumption information (product technical list) from the MIMS system.

---

How to query raw material stock consumption

HTTP POST Request

Request Type	Example URL
POST	{{url_base}}/GetMaterialConsumption
Example	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetMaterialConsumption"

Input Parameters

Parameter	Type	Required	Description
BranchNo	String(25)	Yes	External branch code
MovementBeginDate	DataHora	Yes	Stock movement start date/time
MovementEndDate	DataHora	No	Stock movement end date/time
ProductNo	String(25)	No	External product code

---

Return

Parameter	Type	Required	Description
WebServiceReturn	WebServiceReturn	Yes	Standard WebService response information on method execution
MaterialConsumptionDataList	GetMaterialConsumptionDataList	Yes	List of objects with consumption information

📝 GetMaterialConsumptionDataList Object

The GetMaterialConsumptionDataList object represents a product that had movement.

Return Parameters

Parameter	Type	Required	Description
BranchNo	String(25)	Yes	External branch code
ProductNo	String(25)	Yes	External product code
ProductionStandartDate	DataHora	Yes	MIMS system stock totalization record date/time
CartonQty	Integer	Yes	Quantity of boxes
NetWeight	Float	Yes	Net weight
StandardWeight	Float	Yes	Standard weight
ItemList	GetMaterialConsumptionItem	Yes	List of materials consumed in this product

📝 GetMaterialConsumptionItem Object

The GetMaterialConsumptionItem object represents a raw material consumption of the product.

Return Parameters

Parameter	Type	Required	Description
MaterialNo	String(25)	Yes	External material code
ProductNo	String(25)	Yes	External product code
StandardQty	Float	Yes	Material consumed quantity (net)
RealQty	Float	Yes	Material consumed quantity (real)
MeasurementUnit	String(25)	Yes	Unit of measurement
ConsumptionType	String(2)	Yes	Enumerator with possible values for record Type: ctAnalytics (Analytical Structure - AS) or ctMaterial (Raw Material - RM)

Observation

• The ProductNo parameter can be a material or a semi-finished product

---

Request Example

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetMaterialConsumption"' \
--header 'Content-Type: application/json' \
--data '{
    "BranchNo": "010101",
    "MovementBeginDate": "2022-11-26T00:00:00",
    "MovementEndDate": "2022-11-26T23:59:59",
    "ProductNo": "PROD001"
}'

---

Response Example

{
  "WebServiceReturn": {
    "Status": "wrsSuccess",
    "ErrorCode": "",
    "Message": "",
    "Actor": "",
    "ReturnQuestion": null
  },
  "MaterialConsumptionDataList": [
    {
      "BranchNo": "BR001",
      "ProductNo": "PROD001",
      "ProductionStandartDate": "2025-05-15T12:00:00Z",
      "CartonQty": 100,
      "NetWeight": 1500.0,
      "StandardWeight": 1520.0,
      "ItemList": [
        {
          "MaterialNo": "MAT001",
          "ProductNo": "PROD001",
          "StandardQty": 1520.0,
          "RealQty": 1500.0,
          "MeasurementUnit": "KG",
          "ConsumptionType": "ctMaterial"
        }
      ]
    }
  ]
}

---