Add details to MIR by BOM commodity - Intergraph Smart Materials - Help - Hexagon

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/JSON

IviId

Unique ID of the inventory item

Decimal

Required

To view available inventory items, use:

GET https://{host}/Smat/V1/Projects
(‘:project’)
/Disciplines(‘:discipline’)/
Nls(‘:language’)
/InvItems

LpId

Unique ID of the list position

Decimal

Required

To view available list positions, use:

GET https://{host}/Smat/V1/Projects
(‘:project’)
/Disciplines(‘:discipline’)/
Nls(‘:language’)
/ListPositions

ProjId

Unique ID of the Project. Inventory issues are added to the MIR present in this project.

String

DpId

Unique ID of the Discipline. Inventory issues are added to the MIR present in this discipline.

Integer64

IisId

Unique ID of the inventory issue

Integer64

MirId

Unique ID of the MIR. Inventory issue details are added to this MIR.

Integer64

IvprId

Unique ID of the inventory position reservations

Integer64

BOM Path

Refers to the BOM path of a BOM position, if a position is linked/assigned to the issue item.

String

IssueQty

Quantity of the issued material.

• Depends on the project default ZC_QTYRECV.

  • If value of ZC_QTYRECV, is set to Y, the amount of issued quantity refers to BOM quantity if revision= 0. If revision is greater than 0, then defined value is considered.

  • If value is ZC_QTYRECV, is set to N, defined value is considered.

• Issued quantity gets reserved in the inventory, until the MIR is posted.

Decimal

Ident

Name (code) of the ident

Integer64

ListPosQty

Quantity of the list position

Integer64

ListPosIssueQty

Issued quantity of the list position

Integer64

QtyChanged

Indicates whether the quantity of the material is changed after the last revision or not? Available values are Y and N.

String

OverissueQty

Received quantity by an overissue

Decimal

OnHandQty

Refers to On-hand quantity and is calculated as (= received quantity - reserved quantity - issued quantity).

Decimal

DCIQty

Refers to the Design Change Issue quantity. You cannot update this quantity.

Decimal

RevWithDC

Indicates whether the quantity is revised with respect to DCI Qty or not? Available values are Y and N.

String

DCIOnHandQty

Refers to the DCI On-hand Quantity. You cannot update this quantity.

Decimal

LnId

Unique ID of the list node

Integer64

IssueDate

Date and time of the material issue

Date Time Offset

WhId

Unique ID of the warehouse.

Assigning warehouses depend on the project default ZC_MULT_WH.

If ZC_MULT_WH is set to Y, you can assign only those warehouses to user from screen C.10.02 that have checked "Multiple Selection" indicator, to the MIR.

Integer64

LocId

Unique ID of the location

Integer64

SmstId

Unique ID of the site material status

Integer64

MLDProcessimg

MLD processing occurs, if any of the MLD type is provided by the user. Available options are:

• NULL

• Register and Reissue: MLD gets registered (with this MIR) and a new quantity is issued. You can only insert the MLD quantity and the issue quantity.

• Register only: MLD gets registered and you can insert only the MLD quantity.

• Use OI to compensate: this option allows you to insert a quantity (max Overissue Onhand Qty) to compensate the MLD. After you have posted the MIR, the quantities will be issued against the overissue warehouses (MLD Qty), and the inventory warehouse (Issue Qty). The overissue quantity will be revised for the company in old MIRs.

Default value is Register and Reissue.

String

MLDRegisterQty

Refers to the registered Miss or Lost or Damage (MLD) quantity. You can insert or update this quantity, only if MIR issue type is Miss, Lost, or Damage.

The MX MLD Qty is equal to the Sum Issued/Overissue Qty

Decimal

TotalOIQty

Total overissue quantity that can be used to compensate a MLD quantity

Decimal

OIOnHandQty

Sum of the overissue on-hand quantity

Decimal

SumOIQty

Sum of the issued and overissue quantity for the company

Decimal

UsedOIQty

You can compensate MLD quantity with overissue quantities made for previous MIRs of the same company. However, to use this overissue quantity, MLD type should be "Use OI to compensate". This quantity is UsedOI quantity.

The max quantity of the Used Overissue Qty is equal to the Overissue On-hand Qty and the MLD Qty.

Decimal

RevOverissueQty

Revised quantity by an overissue

Decimal

UnitId

Unique ID of the unit

Integer64

TagNumber

Tag number for this ident

String

TotalRecvQty

Total received quantity for this ident

Integer64

ListPosResvQty

Reserved quantity of the list position

Integer64

CommodityId

Unique ID to identify the commodity

Integer64

Size (1-5)

Sizes of ident (1-5)

String

HeatId

Unique ID of the heat number

Integer64

ItemShipId

Unique ID of the item shipments

Integer64

ResvQty

Reserved quantity by a forecast

Decimal

OriginalIdent

Original Ident

Integer64

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/JSON

onlySiteStatus

Refers to an indicator that controls which issue statuses the best quantity algorithm should be considered.

Allowed values are Y, N, and Null.

• If value is Y, then only those statuses that are mark as "Use on Site" in B.10.08 screen are considered.

• If value is N, then any issue status is considered.

• If value is Null, then it further depends on Project default ZC_BESTQTY. If ZC_BESTQTY is CHECKED, then only those statuses that are mark as "Use on Site" in B.10.08 screen are consider, else all the issue status are considered.

String

Optional

bomListNodes

List nodes of a bill of material

Integer

Required