The BOM object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

status string

Default: draft

item string required

item_name string

image string

uom string

quantity number

Default: 1

is_active boolean

Default: true

is_default boolean

Default: true

with_operations boolean

Default: false

inspection_required boolean

Default: false

allow_alternative_item boolean

Default: false

set_rate_of_sub_assembly_item_based_on_bom boolean

Default: true

quality_inspection_template string

company string required

transfer_material_against string

Default: Work Order

conversion_rate number

Default: 1

currency string required

rm_cost_as_per string

Default: Valuation Rate

buying_price_list string

routing string

operating_cost number

raw_material_cost number

base_operating_cost number

base_raw_material_cost number

total_cost number

base_total_cost number

project string

description string

show_in_website boolean

Default: false

route string

website_image string

thumbnail string

web_long_description string

show_items boolean

Default: false

show_operations boolean

Default: false

plc_conversion_rate number

price_list_currency string

has_variants boolean

Default: false

process_loss_percentage number

process_loss_qty number

fg_based_operating_cost boolean

Default: false

operating_cost_per_bom_quantity number

bom_creator string

bom_creator_item string

track_semi_finished_goods boolean

Default: false

default_source_warehouse string

default_target_warehouse string

is_phantom_bom boolean

Default: false

secondary_items_cost number

base_secondary_items_cost number

cost_allocation number

cost_allocation_per number

Default: 100

The BOM object

{
  "id": "b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "item": "item_example",
  "item_name": "item_name_example",
  "image": "image_example",
  "uom": "uom_example",
  "quantity": 1,
  "is_active": true,
  "is_default": true,
  "with_operations": false,
  "inspection_required": false,
  "allow_alternative_item": false,
  "set_rate_of_sub_assembly_item_based_on_bom": true,
  "quality_inspection_template": "quality_inspection_template_example",
  "company": "Example Corp",
  "transfer_material_against": "Work Order",
  "conversion_rate": 1,
  "currency": "USD",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "routing": "routing_example",
  "operating_cost": 0,
  "raw_material_cost": 0,
  "base_operating_cost": 0,
  "base_raw_material_cost": 0,
  "total_cost": 0,
  "base_total_cost": 0,
  "project": "project_example",
  "description": "description_example",
  "show_in_website": false,
  "route": "route_example",
  "website_image": "website_image_example",
  "thumbnail": "thumbnail_example",
  "web_long_description": "web_long_description_example",
  "show_items": false,
  "show_operations": false,
  "plc_conversion_rate": 0,
  "price_list_currency": "USD",
  "has_variants": false,
  "process_loss_percentage": 0,
  "process_loss_qty": 0,
  "fg_based_operating_cost": false,
  "operating_cost_per_bom_quantity": 0,
  "bom_creator": "bom_creator_example",
  "bom_creator_item": "bom_creator_item_example",
  "track_semi_finished_goods": false,
  "default_source_warehouse": "default_source_warehouse_example",
  "default_target_warehouse": "default_target_warehouse_example",
  "is_phantom_bom": false,
  "secondary_items_cost": 0,
  "base_secondary_items_cost": 0,
  "cost_allocation": 0,
  "cost_allocation_per": 100
}

GET /api/manufacturing/b-o-m/{id}

Retrieve a bom

Retrieves the details of an existing bom. Supply the unique bom ID that was returned from a previous request.

Path parameters

id string required

The identifier of the bom to retrieve.

Returns

Returns the bom object if a valid identifier was provided.

GET /api/manufacturing/b-o-m/{id}

curl https://api.overplane.dev/api/manufacturing/b-o-m/b-o-m_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "item": "item_example",
  "item_name": "item_name_example",
  "image": "image_example",
  "uom": "uom_example",
  "quantity": 1,
  "is_active": true,
  "is_default": true,
  "with_operations": false,
  "inspection_required": false,
  "allow_alternative_item": false,
  "set_rate_of_sub_assembly_item_based_on_bom": true,
  "quality_inspection_template": "quality_inspection_template_example",
  "company": "Example Corp",
  "transfer_material_against": "Work Order",
  "conversion_rate": 1,
  "currency": "USD",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "routing": "routing_example",
  "operating_cost": 0,
  "raw_material_cost": 0,
  "base_operating_cost": 0,
  "base_raw_material_cost": 0,
  "total_cost": 0,
  "base_total_cost": 0,
  "project": "project_example",
  "description": "description_example",
  "show_in_website": false,
  "route": "route_example",
  "website_image": "website_image_example",
  "thumbnail": "thumbnail_example",
  "web_long_description": "web_long_description_example",
  "show_items": false,
  "show_operations": false,
  "plc_conversion_rate": 0,
  "price_list_currency": "USD",
  "has_variants": false,
  "process_loss_percentage": 0,
  "process_loss_qty": 0,
  "fg_based_operating_cost": false,
  "operating_cost_per_bom_quantity": 0,
  "bom_creator": "bom_creator_example",
  "bom_creator_item": "bom_creator_item_example",
  "track_semi_finished_goods": false,
  "default_source_warehouse": "default_source_warehouse_example",
  "default_target_warehouse": "default_target_warehouse_example",
  "is_phantom_bom": false,
  "secondary_items_cost": 0,
  "base_secondary_items_cost": 0,
  "cost_allocation": 0,
  "cost_allocation_per": 100
}

GET /api/manufacturing/b-o-m

List all boms

Returns a list of boms. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of bom objects.

GET /api/manufacturing/b-o-m

curl https://api.overplane.dev/api/manufacturing/b-o-m \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "b-o-m_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "item": "item_example",
      "item_name": "item_name_example",
      "image": "image_example",
      "uom": "uom_example",
      "quantity": 1,
      "is_active": true,
      "is_default": true,
      "with_operations": false,
      "inspection_required": false,
      "allow_alternative_item": false,
      "set_rate_of_sub_assembly_item_based_on_bom": true,
      "quality_inspection_template": "quality_inspection_template_example",
      "company": "Example Corp",
      "transfer_material_against": "Work Order",
      "conversion_rate": 1,
      "currency": "USD",
      "rm_cost_as_per": "Valuation Rate",
      "buying_price_list": "buying_price_list_example",
      "routing": "routing_example",
      "operating_cost": 0,
      "raw_material_cost": 0,
      "base_operating_cost": 0,
      "base_raw_material_cost": 0,
      "total_cost": 0,
      "base_total_cost": 0,
      "project": "project_example",
      "description": "description_example",
      "show_in_website": false,
      "route": "route_example",
      "website_image": "website_image_example",
      "thumbnail": "thumbnail_example",
      "web_long_description": "web_long_description_example",
      "show_items": false,
      "show_operations": false,
      "plc_conversion_rate": 0,
      "price_list_currency": "USD",
      "has_variants": false,
      "process_loss_percentage": 0,
      "process_loss_qty": 0,
      "fg_based_operating_cost": false,
      "operating_cost_per_bom_quantity": 0,
      "bom_creator": "bom_creator_example",
      "bom_creator_item": "bom_creator_item_example",
      "track_semi_finished_goods": false,
      "default_source_warehouse": "default_source_warehouse_example",
      "default_target_warehouse": "default_target_warehouse_example",
      "is_phantom_bom": false,
      "secondary_items_cost": 0,
      "base_secondary_items_cost": 0,
      "cost_allocation": 0,
      "cost_allocation_per": 100
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/manufacturing/b-o-m

Create a bom

Creates a new bom object.

Body parameters

status string

Default: draft

item string required

item_name string

image string

uom string

quantity number

Default: 1

is_active boolean

Default: true

is_default boolean

Default: true

with_operations boolean

Default: false

inspection_required boolean

Default: false

allow_alternative_item boolean

Default: false

set_rate_of_sub_assembly_item_based_on_bom boolean

Default: true

quality_inspection_template string

company string required

transfer_material_against string

Default: Work Order

conversion_rate number

Default: 1

currency string required

rm_cost_as_per string

Default: Valuation Rate

buying_price_list string

routing string

operating_cost number

raw_material_cost number

base_operating_cost number

base_raw_material_cost number

total_cost number

base_total_cost number

project string

description string

show_in_website boolean

Default: false

route string

website_image string

thumbnail string

web_long_description string

show_items boolean

Default: false

show_operations boolean

Default: false

plc_conversion_rate number

price_list_currency string

has_variants boolean

Default: false

process_loss_percentage number

process_loss_qty number

fg_based_operating_cost boolean

Default: false

operating_cost_per_bom_quantity number

bom_creator string

bom_creator_item string

track_semi_finished_goods boolean

Default: false

default_source_warehouse string

default_target_warehouse string

is_phantom_bom boolean

Default: false

secondary_items_cost number

base_secondary_items_cost number

cost_allocation number

cost_allocation_per number

Default: 100

Returns

Returns the newly created bom object if the call succeeded.

POST /api/manufacturing/b-o-m

curl https://api.overplane.dev/api/manufacturing/b-o-m \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"item":"item_example","company":"Example Corp","currency":"USD"}'

Response

{
  "id": "b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "item": "item_example",
  "item_name": "item_name_example",
  "image": "image_example",
  "uom": "uom_example",
  "quantity": 1,
  "is_active": true,
  "is_default": true,
  "with_operations": false,
  "inspection_required": false,
  "allow_alternative_item": false,
  "set_rate_of_sub_assembly_item_based_on_bom": true,
  "quality_inspection_template": "quality_inspection_template_example",
  "company": "Example Corp",
  "transfer_material_against": "Work Order",
  "conversion_rate": 1,
  "currency": "USD",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "routing": "routing_example",
  "operating_cost": 0,
  "raw_material_cost": 0,
  "base_operating_cost": 0,
  "base_raw_material_cost": 0,
  "total_cost": 0,
  "base_total_cost": 0,
  "project": "project_example",
  "description": "description_example",
  "show_in_website": false,
  "route": "route_example",
  "website_image": "website_image_example",
  "thumbnail": "thumbnail_example",
  "web_long_description": "web_long_description_example",
  "show_items": false,
  "show_operations": false,
  "plc_conversion_rate": 0,
  "price_list_currency": "USD",
  "has_variants": false,
  "process_loss_percentage": 0,
  "process_loss_qty": 0,
  "fg_based_operating_cost": false,
  "operating_cost_per_bom_quantity": 0,
  "bom_creator": "bom_creator_example",
  "bom_creator_item": "bom_creator_item_example",
  "track_semi_finished_goods": false,
  "default_source_warehouse": "default_source_warehouse_example",
  "default_target_warehouse": "default_target_warehouse_example",
  "is_phantom_bom": false,
  "secondary_items_cost": 0,
  "base_secondary_items_cost": 0,
  "cost_allocation": 0,
  "cost_allocation_per": 100
}

PATCH /api/manufacturing/b-o-m/{id}

Update a bom

Updates the specified bom by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the bom to update.

Body parameters

status string

Default: draft

item string

item_name string

image string

uom string

quantity number

Default: 1

is_active boolean

Default: true

is_default boolean

Default: true

with_operations boolean

Default: false

inspection_required boolean

Default: false

allow_alternative_item boolean

Default: false

set_rate_of_sub_assembly_item_based_on_bom boolean

Default: true

quality_inspection_template string

company string

transfer_material_against string

Default: Work Order

conversion_rate number

Default: 1

currency string

rm_cost_as_per string

Default: Valuation Rate

buying_price_list string

routing string

operating_cost number

raw_material_cost number

base_operating_cost number

base_raw_material_cost number

total_cost number

base_total_cost number

project string

description string

show_in_website boolean

Default: false

route string

website_image string

thumbnail string

web_long_description string

show_items boolean

Default: false

show_operations boolean

Default: false

plc_conversion_rate number

price_list_currency string

has_variants boolean

Default: false

process_loss_percentage number

process_loss_qty number

fg_based_operating_cost boolean

Default: false

operating_cost_per_bom_quantity number

bom_creator string

bom_creator_item string

track_semi_finished_goods boolean

Default: false

default_source_warehouse string

default_target_warehouse string

is_phantom_bom boolean

Default: false

secondary_items_cost number

base_secondary_items_cost number

cost_allocation number

cost_allocation_per number

Default: 100

Returns

Returns the updated bom object.

PATCH /api/manufacturing/b-o-m/{id}

curl https://api.overplane.dev/api/manufacturing/b-o-m/b-o-m_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","item":"item_example"}'

Response

{
  "id": "b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "item": "item_example",
  "item_name": "item_name_example",
  "image": "image_example",
  "uom": "uom_example",
  "quantity": 1,
  "is_active": true,
  "is_default": true,
  "with_operations": false,
  "inspection_required": false,
  "allow_alternative_item": false,
  "set_rate_of_sub_assembly_item_based_on_bom": true,
  "quality_inspection_template": "quality_inspection_template_example",
  "company": "Example Corp",
  "transfer_material_against": "Work Order",
  "conversion_rate": 1,
  "currency": "USD",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "routing": "routing_example",
  "operating_cost": 0,
  "raw_material_cost": 0,
  "base_operating_cost": 0,
  "base_raw_material_cost": 0,
  "total_cost": 0,
  "base_total_cost": 0,
  "project": "project_example",
  "description": "description_example",
  "show_in_website": false,
  "route": "route_example",
  "website_image": "website_image_example",
  "thumbnail": "thumbnail_example",
  "web_long_description": "web_long_description_example",
  "show_items": false,
  "show_operations": false,
  "plc_conversion_rate": 0,
  "price_list_currency": "USD",
  "has_variants": false,
  "process_loss_percentage": 0,
  "process_loss_qty": 0,
  "fg_based_operating_cost": false,
  "operating_cost_per_bom_quantity": 0,
  "bom_creator": "bom_creator_example",
  "bom_creator_item": "bom_creator_item_example",
  "track_semi_finished_goods": false,
  "default_source_warehouse": "default_source_warehouse_example",
  "default_target_warehouse": "default_target_warehouse_example",
  "is_phantom_bom": false,
  "secondary_items_cost": 0,
  "base_secondary_items_cost": 0,
  "cost_allocation": 0,
  "cost_allocation_per": 100
}

DELETE /api/manufacturing/b-o-m/{id}

Delete a bom

Permanently deletes a bom. This cannot be undone.

Path parameters

id string required

The identifier of the bom to delete.

Returns

Returns a confirmation that the bom has been deleted.

DELETE /api/manufacturing/b-o-m/{id}

curl https://api.overplane.dev/api/manufacturing/b-o-m/b-o-m_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "b-o-m_abc123",
  "deleted": true
}

POST /api/manufacturing/b-o-m/{id}/submit

Submit a bom

Submits a draft bom, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the bom to act on.

Returns

Returns the bom object with updated status.

POST /api/manufacturing/b-o-m/{id}/submit

curl https://api.overplane.dev/api/manufacturing/b-o-m/b-o-m_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "item": "item_example",
  "item_name": "item_name_example",
  "image": "image_example",
  "uom": "uom_example",
  "quantity": 1,
  "is_active": true,
  "is_default": true,
  "with_operations": false,
  "inspection_required": false,
  "allow_alternative_item": false,
  "set_rate_of_sub_assembly_item_based_on_bom": true,
  "quality_inspection_template": "quality_inspection_template_example",
  "company": "Example Corp",
  "transfer_material_against": "Work Order",
  "conversion_rate": 1,
  "currency": "USD",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "routing": "routing_example",
  "operating_cost": 0,
  "raw_material_cost": 0,
  "base_operating_cost": 0,
  "base_raw_material_cost": 0,
  "total_cost": 0,
  "base_total_cost": 0,
  "project": "project_example",
  "description": "description_example",
  "show_in_website": false,
  "route": "route_example",
  "website_image": "website_image_example",
  "thumbnail": "thumbnail_example",
  "web_long_description": "web_long_description_example",
  "show_items": false,
  "show_operations": false,
  "plc_conversion_rate": 0,
  "price_list_currency": "USD",
  "has_variants": false,
  "process_loss_percentage": 0,
  "process_loss_qty": 0,
  "fg_based_operating_cost": false,
  "operating_cost_per_bom_quantity": 0,
  "bom_creator": "bom_creator_example",
  "bom_creator_item": "bom_creator_item_example",
  "track_semi_finished_goods": false,
  "default_source_warehouse": "default_source_warehouse_example",
  "default_target_warehouse": "default_target_warehouse_example",
  "is_phantom_bom": false,
  "secondary_items_cost": 0,
  "base_secondary_items_cost": 0,
  "cost_allocation": 0,
  "cost_allocation_per": 100
}

POST /api/manufacturing/b-o-m/{id}/cancel

Cancel a bom

Cancels a submitted bom, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the bom to act on.

Returns

Returns the bom object with updated status.

POST /api/manufacturing/b-o-m/{id}/cancel

curl https://api.overplane.dev/api/manufacturing/b-o-m/b-o-m_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "item": "item_example",
  "item_name": "item_name_example",
  "image": "image_example",
  "uom": "uom_example",
  "quantity": 1,
  "is_active": true,
  "is_default": true,
  "with_operations": false,
  "inspection_required": false,
  "allow_alternative_item": false,
  "set_rate_of_sub_assembly_item_based_on_bom": true,
  "quality_inspection_template": "quality_inspection_template_example",
  "company": "Example Corp",
  "transfer_material_against": "Work Order",
  "conversion_rate": 1,
  "currency": "USD",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "routing": "routing_example",
  "operating_cost": 0,
  "raw_material_cost": 0,
  "base_operating_cost": 0,
  "base_raw_material_cost": 0,
  "total_cost": 0,
  "base_total_cost": 0,
  "project": "project_example",
  "description": "description_example",
  "show_in_website": false,
  "route": "route_example",
  "website_image": "website_image_example",
  "thumbnail": "thumbnail_example",
  "web_long_description": "web_long_description_example",
  "show_items": false,
  "show_operations": false,
  "plc_conversion_rate": 0,
  "price_list_currency": "USD",
  "has_variants": false,
  "process_loss_percentage": 0,
  "process_loss_qty": 0,
  "fg_based_operating_cost": false,
  "operating_cost_per_bom_quantity": 0,
  "bom_creator": "bom_creator_example",
  "bom_creator_item": "bom_creator_item_example",
  "track_semi_finished_goods": false,
  "default_source_warehouse": "default_source_warehouse_example",
  "default_target_warehouse": "default_target_warehouse_example",
  "is_phantom_bom": false,
  "secondary_items_cost": 0,
  "base_secondary_items_cost": 0,
  "cost_allocation": 0,
  "cost_allocation_per": 100
}

The BOM object

Attributes

Retrieve a bom

Path parameters

Returns

List all boms

Query parameters

Returns

Create a bom

Body parameters

Returns

Update a bom

Path parameters

Body parameters

Returns

Delete a bom

Path parameters

Returns

Submit a bom

Path parameters

Returns

Cancel a bom

Path parameters

Returns

Coming Soon