This API retrieves the inventory receipts of a project from Smart Materials. You can either retrieve a single inventory receipt using inventory receipt Id or all the inventory receipts of a project.
Required Privilege: API_READONLY
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')/InvReceipts({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 inventory receipt Id (InvReceiptId).
To retrieve all the inventory receipts of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/InvReceipts
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/InvReceipts(5062)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/InvReceipts",
"value":[
{
"InvReceiptId":5062,
"ProjId":"RS",
"MrrId":20008,
"LocId":5920,
"WhId":6661,
"SmstId":5581,
"Ident":14640871,
"UnitId":500127,
"DpId":500017,
"RecvQty":50,
"TagNumber":"---",
"HeatId":null,
"ItemShipId":null,
"BnlId":null
}]
}
Element |
Description |
Type |
---|---|---|
InvReceiptId |
Unique ID of the retrieved inventory receipts |
Integer |
ProjId |
Unique ID of the Project. Retrieved inventory receipts belong to this Project. |
String |
MrrId |
Unique ID of the Material Receiving Report (MIR) |
Integer |
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 |
DpId |
Unique ID of the Discipline. Retrieved inventory receipts belong to this Discipline. |
Integer |
RecvQty |
Quantity received for the related item shipment |
Decimal |
TagNumber |
Tag number |
String |
HeatId |
Unique ID of the heat |
Integer |
ItemShipId |
Unique ID of the item shipment |
Integer |
BnlId |
Unique ID of the bin location |
Integer |