Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Properties

Optional EffectiveQuantityAvailable

EffectiveQuantityAvailable: undefined | number

See EffectiveQuantityOnHand, but here the commitments are subtracted from the on hand stock. So if physical stock is 100, 80% is allocated to other organizations and there is a commitment of 11 then EffectiveQuantityAvailable will be 9.

Optional EffectiveQuantityOnHand

EffectiveQuantityOnHand: undefined | number

The quantity of the physical stock that is available to the OrganizationUnit for which this OrganizationUnit is a supplier.

This can differ from the QuantityOnHand when it comes to stock allocation. It's possible that the supplier reserves stock for certain other OrganizationUnits, meaning that only a portion of the QuantityOnHand is available.

Example: you request stock details for the website, which is supplied by the warehouse organization. There is a stock allocation rule that 80% of the warehouse stock is reserved to shops, so not available to the website. In that case, the website organization will have a stock detail with warehouse as a supplier and the stock detail for the warehouse will (for example) have a QuantityOnHand of 100 but only an EffectiveQuantityOnHand of 20.

Optional ExpectedAvailabilityDate

ExpectedAvailabilityDate: undefined | string

The date that this organization is expected to have stock.

Optional ExpectedStock

ExpectedStock: ExpectedStockItem[]

The stock that is expected to be received in the future.

Optional ExpectedSupplierAvailabilityDate

ExpectedSupplierAvailabilityDate: undefined | string

The earliest date that one of the suppliers of this organization has stock.

OrdersWaitingForStockQuantity

OrdersWaitingForStockQuantity: number

The total quantity of orders that are currently have a fulfillment status of WaitingForStock, meaning that they are waiting until stock becomes available on this OrganizationUnit.

OrganizationUnit

OrganizationUnit: OrganizationUnitModel

QuantityAvailable

QuantityAvailable: number

The quantity of stock that is still available for the OrganizationUnit, so the amount of physical stock minus its commitments.

QuantityCommitted

QuantityCommitted: number

The quantity that has been committed to this OrganizationUnit.

QuantityOnHand

QuantityOnHand: number

The quantity of stock that the OrganizationUnit physically has.

QuantityReservedForOtherOrganizationUnits

QuantityReservedForOtherOrganizationUnits: number

The sum of all StockReservations, meaning the quantities that were reserved on this supplier for other organizations.

Optional StockReservations

StockReservations: StockReservation[]

The stock that is reserved for other organizations that is not available to this organization.

SupplierQuantityAvailable

SupplierQuantityAvailable: number

The SupplierQuantityOnHand minus the SupplierQuantityCommitted

SupplierQuantityCommitted

SupplierQuantityCommitted: number

The quantity committed on all suppliers of this organization

SupplierQuantityOnHand

SupplierQuantityOnHand: number

The quantity that all suppliers have on hand as far as we know from the perspective of the organization that is supplied by them.

The actual supplier might have more stock physically on hand, but due to allocation rules this might not be available to this organization.

Optional Suppliers

The suppliers for this organization.