The BOM Creator 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

company string required
rm_cost_as_per string

Default: Valuation Rate

buying_price_list string
price_list_currency string
plc_conversion_rate number
currency string required
conversion_rate number

Default: 1

raw_material_cost number
remarks string
project string
item_code string required
qty number required
item_name string
uom string
item_group string
default_warehouse string
set_rate_based_on_warehouse boolean

Default: false

error_log string
routing string
The BOM Creator object 
{
  "id": "b-o-m-creator_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "currency": "USD",
  "conversion_rate": 1,
  "raw_material_cost": 0,
  "remarks": "remarks_example",
  "project": "project_example",
  "item_code": "item_code_example",
  "qty": 0,
  "item_name": "item_name_example",
  "uom": "uom_example",
  "item_group": "item_group_example",
  "default_warehouse": "default_warehouse_example",
  "set_rate_based_on_warehouse": false,
  "error_log": "error_log_example",
  "routing": "routing_example"
}
GET /api/manufacturing/b-o-m-creator/{id}

Retrieve a bom creator

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

Path parameters

id string required

The identifier of the bom creator to retrieve.

Returns

Returns the bom creator object if a valid identifier was provided.

GET /api/manufacturing/b-o-m-creator/{id} 
curl https://api.overplane.dev/api/manufacturing/b-o-m-creator/b-o-m-creator_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "b-o-m-creator_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "currency": "USD",
  "conversion_rate": 1,
  "raw_material_cost": 0,
  "remarks": "remarks_example",
  "project": "project_example",
  "item_code": "item_code_example",
  "qty": 0,
  "item_name": "item_name_example",
  "uom": "uom_example",
  "item_group": "item_group_example",
  "default_warehouse": "default_warehouse_example",
  "set_rate_based_on_warehouse": false,
  "error_log": "error_log_example",
  "routing": "routing_example"
}
GET /api/manufacturing/b-o-m-creator

List all bom creators

Returns a list of bom creators. 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 creator objects.

GET /api/manufacturing/b-o-m-creator 
curl https://api.overplane.dev/api/manufacturing/b-o-m-creator \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "b-o-m-creator_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "rm_cost_as_per": "Valuation Rate",
      "buying_price_list": "buying_price_list_example",
      "price_list_currency": "USD",
      "plc_conversion_rate": 0,
      "currency": "USD",
      "conversion_rate": 1,
      "raw_material_cost": 0,
      "remarks": "remarks_example",
      "project": "project_example",
      "item_code": "item_code_example",
      "qty": 0,
      "item_name": "item_name_example",
      "uom": "uom_example",
      "item_group": "item_group_example",
      "default_warehouse": "default_warehouse_example",
      "set_rate_based_on_warehouse": false,
      "error_log": "error_log_example",
      "routing": "routing_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/b-o-m-creator

Create a bom creator

Creates a new bom creator object.

Body parameters

status string

Default: draft

company string required
rm_cost_as_per string

Default: Valuation Rate

buying_price_list string
price_list_currency string
plc_conversion_rate number
currency string required
conversion_rate number

Default: 1

raw_material_cost number
remarks string
project string
item_code string required
qty number required
item_name string
uom string
item_group string
default_warehouse string
set_rate_based_on_warehouse boolean

Default: false

error_log string
routing string

Returns

Returns the newly created bom creator object if the call succeeded.

POST /api/manufacturing/b-o-m-creator 
curl https://api.overplane.dev/api/manufacturing/b-o-m-creator \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","currency":"USD","item_code":"item_code_example","qty":0}'
Response 
{
  "id": "b-o-m-creator_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "currency": "USD",
  "conversion_rate": 1,
  "raw_material_cost": 0,
  "remarks": "remarks_example",
  "project": "project_example",
  "item_code": "item_code_example",
  "qty": 0,
  "item_name": "item_name_example",
  "uom": "uom_example",
  "item_group": "item_group_example",
  "default_warehouse": "default_warehouse_example",
  "set_rate_based_on_warehouse": false,
  "error_log": "error_log_example",
  "routing": "routing_example"
}
PATCH /api/manufacturing/b-o-m-creator/{id}

Update a bom creator

Updates the specified bom creator 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 creator to update.

Body parameters

status string

Default: draft

company string
rm_cost_as_per string

Default: Valuation Rate

buying_price_list string
price_list_currency string
plc_conversion_rate number
currency string
conversion_rate number

Default: 1

raw_material_cost number
remarks string
project string
item_code string
qty number
item_name string
uom string
item_group string
default_warehouse string
set_rate_based_on_warehouse boolean

Default: false

error_log string
routing string

Returns

Returns the updated bom creator object.

PATCH /api/manufacturing/b-o-m-creator/{id} 
curl https://api.overplane.dev/api/manufacturing/b-o-m-creator/b-o-m-creator_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "b-o-m-creator_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "currency": "USD",
  "conversion_rate": 1,
  "raw_material_cost": 0,
  "remarks": "remarks_example",
  "project": "project_example",
  "item_code": "item_code_example",
  "qty": 0,
  "item_name": "item_name_example",
  "uom": "uom_example",
  "item_group": "item_group_example",
  "default_warehouse": "default_warehouse_example",
  "set_rate_based_on_warehouse": false,
  "error_log": "error_log_example",
  "routing": "routing_example"
}
DELETE /api/manufacturing/b-o-m-creator/{id}

Delete a bom creator

Permanently deletes a bom creator. This cannot be undone.

Path parameters

id string required

The identifier of the bom creator to delete.

Returns

Returns a confirmation that the bom creator has been deleted.

DELETE /api/manufacturing/b-o-m-creator/{id} 
curl https://api.overplane.dev/api/manufacturing/b-o-m-creator/b-o-m-creator_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "b-o-m-creator_abc123",
  "deleted": true
}
POST /api/manufacturing/b-o-m-creator/{id}/submit

Submit a bom creator

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

Path parameters

id string required

The identifier of the bom creator to act on.

Returns

Returns the bom creator object with updated status.

POST /api/manufacturing/b-o-m-creator/{id}/submit 
curl https://api.overplane.dev/api/manufacturing/b-o-m-creator/b-o-m-creator_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "b-o-m-creator_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "currency": "USD",
  "conversion_rate": 1,
  "raw_material_cost": 0,
  "remarks": "remarks_example",
  "project": "project_example",
  "item_code": "item_code_example",
  "qty": 0,
  "item_name": "item_name_example",
  "uom": "uom_example",
  "item_group": "item_group_example",
  "default_warehouse": "default_warehouse_example",
  "set_rate_based_on_warehouse": false,
  "error_log": "error_log_example",
  "routing": "routing_example"
}
POST /api/manufacturing/b-o-m-creator/{id}/cancel

Cancel a bom creator

Cancels a submitted bom creator, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the bom creator to act on.

Returns

Returns the bom creator object with updated status.

POST /api/manufacturing/b-o-m-creator/{id}/cancel 
curl https://api.overplane.dev/api/manufacturing/b-o-m-creator/b-o-m-creator_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "b-o-m-creator_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "rm_cost_as_per": "Valuation Rate",
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "currency": "USD",
  "conversion_rate": 1,
  "raw_material_cost": 0,
  "remarks": "remarks_example",
  "project": "project_example",
  "item_code": "item_code_example",
  "qty": 0,
  "item_name": "item_name_example",
  "uom": "uom_example",
  "item_group": "item_group_example",
  "default_warehouse": "default_warehouse_example",
  "set_rate_based_on_warehouse": false,
  "error_log": "error_log_example",
  "routing": "routing_example"
}