About Importing BOM Formulations

The BOM Formulation Import Document describes the information required to create/update a Bill of Materials. This following is a list of parameters related to importing a BOM formulation.
  • schemaVersion: Represents the version of the schema to determine compatibility and parsing. Must increment every time the JSON schema is changed.
  • bomFormulationName: Name of the BOM Formulation. The bomFormulationName is used to determine if a bomFormulation should be updated or created. The bomFormulationName must be unique for every BOM. If a bomFormulationName exists, the import BOM request should update an existing BOM, rather then creating a new BOM when the bomFormulationName does not exist.
  • effectiveDate: The date/time when the BOM is effective. Must adhere to the ISO 8601 UTC standard. The effective date cannot be before the current date/time.
  • expirationDate: The date/time when the BOM expires. Must adhere to the ISO 8601 UTC standard. The expiration date cannot be before the effective date/time.
  • producedMaterialQuantity: The quantity of produced material.
  • producedMaterialQuantityPrecision: The produced material quantity precision.
  • producedMaterialUnitOfMeasureName: The code of the unit of measure used for producing the material.
  • bomFamilyName: The name of the BOM family. The BOM family name is used only when a non-existing bomMasterName is supplied.
  • bomMasterName: The name of the BOM master. If a non-existing bomMasterName is supplied, then as part of validation process, the code will create the new BOM master with the given name and using the BOM family specified by bomFamilyName.
  • producedMaterialNames: The list of produced material codes.
  • propertyValues.property.Name: Custom property name used in the BOM header. Properties are created in the Property Definition app and belong to the BomItem Import group.
  • propertyValues.property.Value: Custom property name used in the BOM header. Properties are created in the Property Definition app and belong to the BomItem Import group. The value type must match the one defined in the Property Definition.
  • billOfMaterials.bomItemName: An alias (stored in the Alias field of the BOM item) to be used in place of the BOM item name.
  • billOfMaterials.quantityPrecision: The BOM item quantity precision.
  • billOfMaterials.scrapFactor: The BOM item scrap factor (%). The percentage of the BOM item expected to be lost during production of the formulation. For example, if 100 units of Product X are required with a scrap factor of 1(%), there should be 101 units on hand when preparing to produce the product.
  • billOfMaterials.lowerTolerancePrecision: The lower tolerance precision of the BOM item.
  • billOfMaterials.propertyValues.property.Name: Custom property name used in the BOM header. Properties are created in the Property Definition app and belong to the BomItem Import group.
  • billOfMaterials.propertyValues.property.Value: Custom property name used in the BOM item. Properties are created in the Property Definition app and belong to the BomItem Import group. The value type must match the one defined in the Property Definition app.
  • billOfMaterials.quantity: The quantity consumed by the BOM item.
  • billOfMaterials.materialName: The material code consumed by the BOM item.
  • billOfMaterials.unitOfMeasureName: The code of the unit of measure used for the BOM item.
  • billOfMaterials.upperTolerancePrecision: The upper tolerance precision of the BOM item.
  • billOfMaterials.lowerTolerance: The lower limit of the required quantity.
  • billOfMaterials.upperTolerance: The upper limit of the required quantity.
  • billOfMaterials.displayOrder: The display order.
  • billOfMaterials.substitution.materialName: The material code of the substitution.
  • billOfMaterials.substitution.unitOfMeasureName: The unit of measure code of the substitution.
  • billOfMaterials.substitution.conversionFactor: The conversion factor of the substitution.