This API retrieves the Material Receiving Report (MRR) of a project from Smart Materials. You can either retrieve a single report using an ID or all the material receiving reports of a project.
Required Privilege: API_MRR
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format: GET https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/ReceivingReports({key})
Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment, and the key parameter defines the material receiving report ID (MrrId).
-
To retrieve all the material receiving reports of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/ReceivingReports.
-
To view the inventory items of a material receiving report, expand InventoryReceipts property using Odata Query.
Sample Code
GET http://localhost: 62434 /smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/ ReceivingReports (10000112339)?$expand=InventoryReceipts
Success Response
Status: 200 OK
Content:
{
"@odata.context": "http://localhost:57101/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/ReceivingReports/$entity",
"MrrId": 10000112339,
"ProjId": "RS",
"MrrNumber": "MRR_V_363",
"RevisionId": 0,
"DpId": 5020,
"MrrType": "By Agreement",
"MrrCreateDate": "2023-01-16T00:00:00+05:30",
"OriginCode": "HOME",
"OriginId": 500005,
"PoSupplement": 0,
"OriginSupplement": 0,
"AgreementNumber": "AUSENCO_SPLIT_MASTER_RECEIVE",
"OrderType": "PO",
"MtrOrVoucherNumber": null,
"MtrId": null,
"RecvType": "O",
"ReleaseNoteNumber": null,
"RelnId": null,
"SellingPrice": 0,
"PackageNumbers": null,
"PackageIds": null,
"WhCode": "11111"
"LocCode": "MW_1",
"SiteCode": null,
"ReceiptStatus": "OK",
"ShipmentGroup": null,
"PromShip": null,
"Shipper": null,
"ShipperRefNo": null,
"WhId": 10000002798,
"LocId": 5401,
"SmstId": 5162,
"SgId": null,
"PohId": 10000138748,
"ReceivedBy": null,
"PostedDate": null,
"MatlRecvDate": "2023-01-16T00:00:00+05:30",
"BnlId": null,
"RentalInd": "N",
"RfaInd": "N",
"PlateInd": "N",
"AutoCreateOSDs": "N",
"ShortDescription": null,
"Description": null,
"InventoryReceipts": [
{
"InvReceiptId": 10000330906,
"ProjId": "RS",
"DpId": 5020,
"MrrId": 10000112339,
"Position": 1,
"SubPosition": 0,
"ItemShipPosition": 1,
"ItemShipSubPosition": 1,
"TagNumber": "TAG-MASTER-1",
"IdentCode": "CE5SGP",
"ItyId":500017,
"ItemType":"STD W TAG",
"CommodityCode": "164101AHPFSDJ2F",
"Size1": "0",
"Size2": "0",
"Size3": "0",
"Size4": "0",
"Size5": "0",
"ItemShipQty": 1,
"ExpectedQty": 5,
"ReceiveToDateQty": -4,
"UnitCode": "EA",
"PlateNumber": null,
"XDim": 0,
"YDim": 0,
"ReceivedQty": 1,
"QuantityChanged": "N",
"SiteCode": null,
"WarehouseCode": "00000",
"LocationCode": "MW_1",
"ReceiptStatus": "OK",
"HeatNumber": null,
"CertificateNumber": null,
"Manufacturer": null,
"FileLocation": null,
"RecvDate": "2023-01-16T00:00:00+05:30",
"LocId": 5401,
"WhId": 6061,
"SmstId": 5162,
"Ident": 16815355,
"UnitId": 500127,
"HeatId": null,
"ItemShipId": 10000784940,
"BnlId": null,
"PlateId": null,
"IdentDeviation": null,
"ReadyToPost": "Y",
"PoliId": 10000714678,
"CommodityId": 4517971,
"QuarantineLocation": "N",
"TagsInInventory": "N",
"RecvHeatNumbers": "N",
"LastInvReceiptId":null
},
{
"InvReceiptId": 10000330907,
"ProjId": "RS",
"DpId": 5020,
"MrrId": 10000112339,
"Position": 1,
"SubPosition": 1,
"ItemShipPosition": 1,
"ItemShipSubPosition": 1,
"TagNumber": "TAG-MASTER-1-2",
"IdentCode": "I10000592837",
"ItyId":500017,
"ItemType":"STD W TAG",
"CommodityCode": "TAG-MASTER-1",
"Size1": "0",
"Size2": "0",
"Size3": "0",
"Size4": "0",
"Size5": "10000592837",
"ItemShipQty": 5,
"ExpectedQty": 0,
"ReceiveToDateQty": 5,
"UnitCode": "EA",
"PlateNumber": null,
"XDim": 0,
"YDim": 0,
"ReceivedQty": 0,
"QuantityChanged": "N",
"SiteCode": null,
"WarehouseCode": "MW_1",
"LocationCode": "MW_1",
"ReceiptStatus": "OK",
"HeatNumber": null,
"CertificateNumber": null,
"Manufacturer": null,
"FileLocation": null,
"RecvDate": "2023-01-16T00:00:00+05:30",
"LocId": 5401,
"WhId": 5981,
"SmstId": 5162,
"Ident": 10000592837,
"UnitId": 500127,
"HeatId": null,
"ItemShipId": 10000784941,
"BnlId": null,
"PlateId": null,
"IdentDeviation": null,
"ReadyToPost": "Y",
"PoliId": 10000714679,
"CommodityId": 10000309728,
"QuarantineLocation": "N",
"TagsInInventory": "N",
"RecvHeatNumbers": "N",
"LastInvReceiptId":null
}
]
}
|
Element |
Description |
Type |
|---|---|---|
|
MrrId |
Unique ID of the Material Receiving Report. |
Integer |
|
ProjId |
Unique ID of the project. Retrieved MRR belongs to this project. |
String |
|
MrrNumber |
Name of the MRR. |
String |
|
RevisionId |
Unique ID of the current MRR revision. Default value is 0. |
Integer |
|
DpId |
Unique ID of the discipline. Retrieved MRR belongs to this discipline. |
Integer |
|
MrrType |
Defines the type of the MRR. Available types are:
|
String |
|
MrrCreateDate |
Date and time when the MRR was created. |
Date Time Offset |
|
OriginCode |
Name or code of the origin (branch) to which the agreement number belongs.
|
String |
|
OriginID |
Unique ID of the origin of an agreement number.
|
Integer |
|
PoSupplement |
Supplement of the agreement number/order.
|
Integer |
|
OriginSupplement |
It is the highest approved supplement for an agreement number.
|
Integer |
|
AgreementNumber |
Name (code, number) of the agreement number.
|
String |
|
OrderType |
Type of the agreement number.
|
String |
|
MtrorVoucherNumber |
Name or code of the MTR / Voucher in case of direct receive. |
String |
|
MtrId |
Unique ID of the MTR/Voucher. |
Integer |
|
RecvType |
Type of receiving. Available values are:
|
String |
|
ReleaseNoteNumber |
Name (code, number) of the release note in case of MRR by Release Note. |
String |
|
RelnId |
Unique ID of a release note number. |
Integer |
|
SellingPrice |
Refers to the selling price in case of MRR by Release Note. |
Decimal |
|
PackageNumbers |
Name (code, number) of all the packages that are received by MRR of type Package. |
String |
|
PackageIds |
Refers to the unique IDs of all the packages that are received by MRR of type Package. |
String |
|
WhCode |
Name or code of the warehouse. |
String |
|
LocCode |
Name or code of the location. |
String |
|
SiteCode |
Name or code of the bin location. |
String |
|
ReceiptStatus |
Name or code of the material receiving status. |
String |
|
ShipmentGroup |
Name or code of the shipment group. |
String |
|
PromShip |
Promised shipping date for the shipment group. |
DateTimeOffset |
|
Shipper |
Company responsible for shipping this material. |
String |
|
ShipperRefNo |
Reference number of the shipper. |
String |
|
WhId |
Unique ID of the warehouse. |
Integer |
|
LocId |
Unique ID of the location. |
Integer |
|
SmstId |
Unique ID of the material receiving status. |
Integer |
|
SgId |
Unique ID of the shipment group. |
Integer |
|
PohId |
Unique ID of the purchase order header. |
Integer |
|
ReceivedBy |
Name of the person who has received the material. |
String |
|
PostedDate |
Date and time when the MRR was posted to inventory. |
DateTimeOffset |
|
MatlRecvDate |
Date and time when the material was received. |
DateTimeOffset |
|
BnIId |
Unique ID of the bin location. |
Integer |
|
RentalInd |
Indicates whether the MRR is for rental equipment or not. Available options are Y and N. |
String |
|
RfaInd |
Indicates whether the material receive report is ready for approval or not. Available values are Y and N. |
String |
|
PlateInd |
Indicates whether all material is received as plate material in normal and nested plate warehouses or not. Available values are Y and N. |
String |
|
AutoCreateOSDs |
Indicates whether the OS&Ds reports get generated automatically or not while posting an MRR. Available values are Y and N.
|
String |
|
ShortDescription |
Short description of the MRR. |
String |
|
Description |
Description of the MRR. |
String |
|
InventoryReceipts |
Description of all the inventory receipts attached to this MRR. |
Collection |
Applicable for only those MRRs whose type is agreement.
Inventory Receipts Details
|
Element |
Description |
Type |
|---|---|---|
|
InvReceiptId |
Unique ID of the retrieved inventory receipt. |
Integer |
|
ProjId |
Unique ID of the project. Retrieved inventory receipt belongs to this project. |
String |
|
DpId |
Unique ID of the discipline. Retrieved inventory receipt belongs to this discipline. |
Integer |
|
MrrId |
Unique ID of the Material Receiving Report (MRR). |
Integer |
|
Position |
Sequence number that identifies the related line items of an order. |
Integer |
|
SubPosition |
An additional sequence number that identifies the split line items of an order. |
Integer |
|
ItemShipPosition |
Sequence number that identifies the related item shipments of an order line item. |
Integer |
|
ItemShipSubPosition |
An additional sequence number that identifies the split item shipments of an order. |
Integer |
|
TagNumber |
Tag number of the item shipment. |
String |
|
IdentCode |
Code of the ident placed on this line item. |
String |
|
ItyId |
Unique ID of the retrieved item type. |
Integer |
|
ItemType |
Name or code of the item type. |
String |
|
CommodityCode |
Commodity code. |
String |
|
Size(1-5) |
Size (Input 1-5)) of the ident on this item shipment. |
String |
|
ItemShipQty |
Order quantity of the item shipment. |
Decimal |
|
ExpectedQty |
Quantity still expected for this item shipment. This quantity is calculated as the quantity of the item shipment minus the quantities already received (posted and not posted) on other MRRs. |
Integer |
|
ReceivedToDateQty |
Quantity received till date and is calculated as (ItemShipQty-ExpectedQty). |
Integer |
|
UnitCode |
Code for the quantity unit. |
String |
|
PlateNumber |
Name or code of the plate. |
string |
|
XDim |
X dimension of the plate. |
Decimal |
|
YDim |
Y dimension of the plate. |
Decimal |
|
ReceivedQty |
Quantity received for this item shipment. |
Decimal |
|
QuantityChanged |
Refers to the quantity which is not equal to the last revision quantity. Available values are Y and N. |
String |
|
SiteCode |
Name or code of the bin location. |
String |
|
WarehouseCode |
Name or code of the warehouse. |
String |
|
LocationCode |
Name or code of the location where the material get stored. |
String |
|
ReceiptStatus |
Name or code of the material receiving status. |
String |
|
HeatNumber |
Name or code of the heat number. |
String |
|
CertificateNumber |
Certificate number of the item shipment. |
String |
|
Manufacturer |
Name or code of the manufacturer. |
String |
|
FileLocation |
Name or code of the file location. |
String |
|
RecvDate |
Date and time when the material was received. |
DateTimeOffset |
|
LocId |
Unique ID of the location. |
Integer |
|
WhId |
Unique ID of the warehouse. |
Integer |
|
SmstId |
Unique ID of the site material status. |
Integer |
|
Ident |
Ident number. |
Integer |
|
UnitId |
Unique ID of the unit. |
Integer |
|
HeatId |
Unique ID of the heat number. |
Integer |
|
ItemShipId |
Unique ID of the item shipment. |
Integer |
|
BnlId |
Unique ID of the bin location. |
Integer |
|
PlateId |
Unique ID of the plate. |
Integer |
|
IdentDeviation |
Refers whether an ident deviation has occurred for the inventory item, i.e., if the property that has been assigned to project default ZP_DEVATTR has been assigned to the requisition line item or not. |
String |
|
ReadyToPost |
Refers whether the inventory item is ready to post or not. Available values are Y and N. |
String |
|
PoliId |
Unique ID of the order line item. |
Integer |
|
CommodityId |
Unique ID of commodity code. |
Integer |
|
QuarantineLocation |
Refers whether the material should be tested/inspected at a quarantine location or not. Available values are Y and N. |
String |
|
TagsInInventory |
Refers whether the tags are in the inventory or not. Available values are Y and N. |
String |
|
RecvHeatNumbers |
Refers whether the heat numbers are assigned to the inventory receipt item or not. Available values are Y and N. |
String |
|
LastInvReceiptId |
Unique ID of the inventory receipt of the previous version. |
Integer |