The Manufacturing Settings 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.

allow_overtime boolean

Default: false

allow_production_on_holidays boolean

Default: false

capacity_planning_for_days integer

Default: 30

mins_between_operations integer
overproduction_percentage_for_sales_order number
overproduction_percentage_for_work_order number
backflush_raw_materials_based_on string

Default: BOM

material_consumption boolean

Default: false

update_bom_costs_automatically boolean

Default: false

disable_capacity_planning boolean

Default: false

make_serial_no_batch_from_work_order boolean

Default: false

add_corrective_operation_cost_in_finished_good_valuation boolean

Default: false

job_card_excess_transfer boolean

Default: false

get_rm_cost_from_consumption_entry boolean

Default: false

validate_components_quantities_per_bom boolean

Default: false

enforce_time_logs boolean

Default: false

transfer_extra_materials_percentage number
allow_editing_of_items_and_quantities_in_work_order boolean

Default: false

set_op_cost_and_secondary_items_from_sub_assemblies boolean

Default: false

The Manufacturing Settings object 
{
  "id": "manufacturing-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "allow_overtime": false,
  "allow_production_on_holidays": false,
  "capacity_planning_for_days": 30,
  "mins_between_operations": 0,
  "overproduction_percentage_for_sales_order": 0,
  "overproduction_percentage_for_work_order": 0,
  "backflush_raw_materials_based_on": "BOM",
  "material_consumption": false,
  "update_bom_costs_automatically": false,
  "disable_capacity_planning": false,
  "make_serial_no_batch_from_work_order": false,
  "add_corrective_operation_cost_in_finished_good_valuation": false,
  "job_card_excess_transfer": false,
  "get_rm_cost_from_consumption_entry": false,
  "validate_components_quantities_per_bom": false,
  "enforce_time_logs": false,
  "transfer_extra_materials_percentage": 0,
  "allow_editing_of_items_and_quantities_in_work_order": false,
  "set_op_cost_and_secondary_items_from_sub_assemblies": false
}
GET /api/manufacturing/manufacturing-settings

Retrieve manufacturing settings

Retrieves the current manufacturing settings. This is a singleton resource.

Returns

Returns the manufacturing settings object.

GET /api/manufacturing/manufacturing-settings 
curl https://api.overplane.dev/api/manufacturing/manufacturing-settings \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "manufacturing-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "allow_overtime": false,
  "allow_production_on_holidays": false,
  "capacity_planning_for_days": 30,
  "mins_between_operations": 0,
  "overproduction_percentage_for_sales_order": 0,
  "overproduction_percentage_for_work_order": 0,
  "backflush_raw_materials_based_on": "BOM",
  "material_consumption": false,
  "update_bom_costs_automatically": false,
  "disable_capacity_planning": false,
  "make_serial_no_batch_from_work_order": false,
  "add_corrective_operation_cost_in_finished_good_valuation": false,
  "job_card_excess_transfer": false,
  "get_rm_cost_from_consumption_entry": false,
  "validate_components_quantities_per_bom": false,
  "enforce_time_logs": false,
  "transfer_extra_materials_percentage": 0,
  "allow_editing_of_items_and_quantities_in_work_order": false,
  "set_op_cost_and_secondary_items_from_sub_assemblies": false
}
PATCH /api/manufacturing/manufacturing-settings/{id}

Update a manufacturing settings

Updates the specified manufacturing settings 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 manufacturing settings to update.

Body parameters

allow_overtime boolean

Default: false

allow_production_on_holidays boolean

Default: false

capacity_planning_for_days integer

Default: 30

mins_between_operations integer
overproduction_percentage_for_sales_order number
overproduction_percentage_for_work_order number
backflush_raw_materials_based_on string

Default: BOM

material_consumption boolean

Default: false

update_bom_costs_automatically boolean

Default: false

disable_capacity_planning boolean

Default: false

make_serial_no_batch_from_work_order boolean

Default: false

add_corrective_operation_cost_in_finished_good_valuation boolean

Default: false

job_card_excess_transfer boolean

Default: false

get_rm_cost_from_consumption_entry boolean

Default: false

validate_components_quantities_per_bom boolean

Default: false

enforce_time_logs boolean

Default: false

transfer_extra_materials_percentage number
allow_editing_of_items_and_quantities_in_work_order boolean

Default: false

set_op_cost_and_secondary_items_from_sub_assemblies boolean

Default: false

Returns

Returns the updated manufacturing settings object.

PATCH /api/manufacturing/manufacturing-settings/{id} 
curl https://api.overplane.dev/api/manufacturing/manufacturing-settings/manufacturing-settings_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"allow_overtime":false,"allow_production_on_holidays":false}'
Response 
{
  "id": "manufacturing-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "allow_overtime": false,
  "allow_production_on_holidays": false,
  "capacity_planning_for_days": 30,
  "mins_between_operations": 0,
  "overproduction_percentage_for_sales_order": 0,
  "overproduction_percentage_for_work_order": 0,
  "backflush_raw_materials_based_on": "BOM",
  "material_consumption": false,
  "update_bom_costs_automatically": false,
  "disable_capacity_planning": false,
  "make_serial_no_batch_from_work_order": false,
  "add_corrective_operation_cost_in_finished_good_valuation": false,
  "job_card_excess_transfer": false,
  "get_rm_cost_from_consumption_entry": false,
  "validate_components_quantities_per_bom": false,
  "enforce_time_logs": false,
  "transfer_extra_materials_percentage": 0,
  "allow_editing_of_items_and_quantities_in_work_order": false,
  "set_op_cost_and_secondary_items_from_sub_assemblies": false
}