The Production Plan 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
get_items_from string
posting_date string required
item_code string
customer string
warehouse string
project string
from_date string
to_date string
include_non_stock_items boolean

Default: true

include_subcontracted_items boolean

Default: true

ignore_existing_ordered_qty boolean

Default: true

total_planned_qty number

Default: 0

total_produced_qty number

Default: 0

for_warehouse string
sales_order_status string
include_safety_stock boolean

Default: false

combine_items boolean

Default: false

from_delivery_date string
to_delivery_date string
combine_sub_items boolean

Default: false

skip_available_sub_assembly_item boolean

Default: true

sub_assembly_warehouse string
consider_minimum_order_qty boolean

Default: false

reserve_stock boolean

Default: false

The Production Plan object 
{
  "id": "production-plan_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "get_items_from": "get_items_from_example",
  "posting_date": "2024-01-15",
  "item_code": "item_code_example",
  "customer": "customer_example",
  "warehouse": "warehouse_example",
  "project": "project_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "include_non_stock_items": true,
  "include_subcontracted_items": true,
  "ignore_existing_ordered_qty": true,
  "total_planned_qty": 0,
  "total_produced_qty": 0,
  "for_warehouse": "for_warehouse_example",
  "sales_order_status": "sales_order_status_example",
  "include_safety_stock": false,
  "combine_items": false,
  "from_delivery_date": "2024-01-15",
  "to_delivery_date": "2024-01-15",
  "combine_sub_items": false,
  "skip_available_sub_assembly_item": true,
  "sub_assembly_warehouse": "sub_assembly_warehouse_example",
  "consider_minimum_order_qty": false,
  "reserve_stock": false
}
GET /api/manufacturing/production-plan/{id}

Retrieve a production plan

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

Path parameters

id string required

The identifier of the production plan to retrieve.

Returns

Returns the production plan object if a valid identifier was provided.

GET /api/manufacturing/production-plan/{id} 
curl https://api.overplane.dev/api/manufacturing/production-plan/production-plan_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "production-plan_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "get_items_from": "get_items_from_example",
  "posting_date": "2024-01-15",
  "item_code": "item_code_example",
  "customer": "customer_example",
  "warehouse": "warehouse_example",
  "project": "project_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "include_non_stock_items": true,
  "include_subcontracted_items": true,
  "ignore_existing_ordered_qty": true,
  "total_planned_qty": 0,
  "total_produced_qty": 0,
  "for_warehouse": "for_warehouse_example",
  "sales_order_status": "sales_order_status_example",
  "include_safety_stock": false,
  "combine_items": false,
  "from_delivery_date": "2024-01-15",
  "to_delivery_date": "2024-01-15",
  "combine_sub_items": false,
  "skip_available_sub_assembly_item": true,
  "sub_assembly_warehouse": "sub_assembly_warehouse_example",
  "consider_minimum_order_qty": false,
  "reserve_stock": false
}
GET /api/manufacturing/production-plan

List all production plans

Returns a list of production plans. 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 production plan objects.

GET /api/manufacturing/production-plan 
curl https://api.overplane.dev/api/manufacturing/production-plan \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "production-plan_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "get_items_from": "get_items_from_example",
      "posting_date": "2024-01-15",
      "item_code": "item_code_example",
      "customer": "customer_example",
      "warehouse": "warehouse_example",
      "project": "project_example",
      "from_date": "2024-01-15",
      "to_date": "2024-01-15",
      "include_non_stock_items": true,
      "include_subcontracted_items": true,
      "ignore_existing_ordered_qty": true,
      "total_planned_qty": 0,
      "total_produced_qty": 0,
      "for_warehouse": "for_warehouse_example",
      "sales_order_status": "sales_order_status_example",
      "include_safety_stock": false,
      "combine_items": false,
      "from_delivery_date": "2024-01-15",
      "to_delivery_date": "2024-01-15",
      "combine_sub_items": false,
      "skip_available_sub_assembly_item": true,
      "sub_assembly_warehouse": "sub_assembly_warehouse_example",
      "consider_minimum_order_qty": false,
      "reserve_stock": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/production-plan

Create a production plan

Creates a new production plan object.

Body parameters

status string

Default: draft

company string required
get_items_from string
posting_date string required
item_code string
customer string
warehouse string
project string
from_date string
to_date string
include_non_stock_items boolean

Default: true

include_subcontracted_items boolean

Default: true

ignore_existing_ordered_qty boolean

Default: true

total_planned_qty number

Default: 0

total_produced_qty number

Default: 0

for_warehouse string
sales_order_status string
include_safety_stock boolean

Default: false

combine_items boolean

Default: false

from_delivery_date string
to_delivery_date string
combine_sub_items boolean

Default: false

skip_available_sub_assembly_item boolean

Default: true

sub_assembly_warehouse string
consider_minimum_order_qty boolean

Default: false

reserve_stock boolean

Default: false

Returns

Returns the newly created production plan object if the call succeeded.

POST /api/manufacturing/production-plan 
curl https://api.overplane.dev/api/manufacturing/production-plan \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","posting_date":"2024-01-15"}'
Response 
{
  "id": "production-plan_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "get_items_from": "get_items_from_example",
  "posting_date": "2024-01-15",
  "item_code": "item_code_example",
  "customer": "customer_example",
  "warehouse": "warehouse_example",
  "project": "project_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "include_non_stock_items": true,
  "include_subcontracted_items": true,
  "ignore_existing_ordered_qty": true,
  "total_planned_qty": 0,
  "total_produced_qty": 0,
  "for_warehouse": "for_warehouse_example",
  "sales_order_status": "sales_order_status_example",
  "include_safety_stock": false,
  "combine_items": false,
  "from_delivery_date": "2024-01-15",
  "to_delivery_date": "2024-01-15",
  "combine_sub_items": false,
  "skip_available_sub_assembly_item": true,
  "sub_assembly_warehouse": "sub_assembly_warehouse_example",
  "consider_minimum_order_qty": false,
  "reserve_stock": false
}
PATCH /api/manufacturing/production-plan/{id}

Update a production plan

Updates the specified production plan 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 production plan to update.

Body parameters

status string

Default: draft

company string
get_items_from string
posting_date string
item_code string
customer string
warehouse string
project string
from_date string
to_date string
include_non_stock_items boolean

Default: true

include_subcontracted_items boolean

Default: true

ignore_existing_ordered_qty boolean

Default: true

total_planned_qty number

Default: 0

total_produced_qty number

Default: 0

for_warehouse string
sales_order_status string
include_safety_stock boolean

Default: false

combine_items boolean

Default: false

from_delivery_date string
to_delivery_date string
combine_sub_items boolean

Default: false

skip_available_sub_assembly_item boolean

Default: true

sub_assembly_warehouse string
consider_minimum_order_qty boolean

Default: false

reserve_stock boolean

Default: false

Returns

Returns the updated production plan object.

PATCH /api/manufacturing/production-plan/{id} 
curl https://api.overplane.dev/api/manufacturing/production-plan/production-plan_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "production-plan_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "get_items_from": "get_items_from_example",
  "posting_date": "2024-01-15",
  "item_code": "item_code_example",
  "customer": "customer_example",
  "warehouse": "warehouse_example",
  "project": "project_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "include_non_stock_items": true,
  "include_subcontracted_items": true,
  "ignore_existing_ordered_qty": true,
  "total_planned_qty": 0,
  "total_produced_qty": 0,
  "for_warehouse": "for_warehouse_example",
  "sales_order_status": "sales_order_status_example",
  "include_safety_stock": false,
  "combine_items": false,
  "from_delivery_date": "2024-01-15",
  "to_delivery_date": "2024-01-15",
  "combine_sub_items": false,
  "skip_available_sub_assembly_item": true,
  "sub_assembly_warehouse": "sub_assembly_warehouse_example",
  "consider_minimum_order_qty": false,
  "reserve_stock": false
}
DELETE /api/manufacturing/production-plan/{id}

Delete a production plan

Permanently deletes a production plan. This cannot be undone.

Path parameters

id string required

The identifier of the production plan to delete.

Returns

Returns a confirmation that the production plan has been deleted.

DELETE /api/manufacturing/production-plan/{id} 
curl https://api.overplane.dev/api/manufacturing/production-plan/production-plan_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "production-plan_abc123",
  "deleted": true
}
POST /api/manufacturing/production-plan/{id}/submit

Submit a production plan

Submits a draft production plan, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the production plan to act on.

Returns

Returns the production plan object with updated status.

POST /api/manufacturing/production-plan/{id}/submit 
curl https://api.overplane.dev/api/manufacturing/production-plan/production-plan_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "production-plan_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "get_items_from": "get_items_from_example",
  "posting_date": "2024-01-15",
  "item_code": "item_code_example",
  "customer": "customer_example",
  "warehouse": "warehouse_example",
  "project": "project_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "include_non_stock_items": true,
  "include_subcontracted_items": true,
  "ignore_existing_ordered_qty": true,
  "total_planned_qty": 0,
  "total_produced_qty": 0,
  "for_warehouse": "for_warehouse_example",
  "sales_order_status": "sales_order_status_example",
  "include_safety_stock": false,
  "combine_items": false,
  "from_delivery_date": "2024-01-15",
  "to_delivery_date": "2024-01-15",
  "combine_sub_items": false,
  "skip_available_sub_assembly_item": true,
  "sub_assembly_warehouse": "sub_assembly_warehouse_example",
  "consider_minimum_order_qty": false,
  "reserve_stock": false
}
POST /api/manufacturing/production-plan/{id}/cancel

Cancel a production plan

Cancels a submitted production plan, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the production plan to act on.

Returns

Returns the production plan object with updated status.

POST /api/manufacturing/production-plan/{id}/cancel 
curl https://api.overplane.dev/api/manufacturing/production-plan/production-plan_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "production-plan_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "get_items_from": "get_items_from_example",
  "posting_date": "2024-01-15",
  "item_code": "item_code_example",
  "customer": "customer_example",
  "warehouse": "warehouse_example",
  "project": "project_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "include_non_stock_items": true,
  "include_subcontracted_items": true,
  "ignore_existing_ordered_qty": true,
  "total_planned_qty": 0,
  "total_produced_qty": 0,
  "for_warehouse": "for_warehouse_example",
  "sales_order_status": "sales_order_status_example",
  "include_safety_stock": false,
  "combine_items": false,
  "from_delivery_date": "2024-01-15",
  "to_delivery_date": "2024-01-15",
  "combine_sub_items": false,
  "skip_available_sub_assembly_item": true,
  "sub_assembly_warehouse": "sub_assembly_warehouse_example",
  "consider_minimum_order_qty": false,
  "reserve_stock": false
}

Line items

Child objects that belong to this production plan. These are accessed via the parent's ID.

Material Request Plan Item

Attributes

idx integer
production_plan_id string required
item_code string required
item_name string
warehouse string required
material_request_type string
quantity number required
projected_qty number
actual_qty number
min_order_qty number
sales_order string
requested_qty number
description string
uom string
from_warehouse string
safety_stock number
ordered_qty number
reserved_qty_for_production number
required_bom_qty number
conversion_factor number
schedule_date string
stock_reserved_qty number
from_bom string
sub_assembly_item_reference string
main_item_code string

Endpoints

GET /api/manufacturing/material-request-plan-item?parent_id={id}
POST /api/manufacturing/material-request-plan-item
PATCH /api/manufacturing/material-request-plan-item/{id}
DELETE /api/manufacturing/material-request-plan-item/{id}
POST /api/manufacturing/material-request-plan-item/reorder
Material Request Plan Item object 
{
  "id": "material-request-plan-item_abc123",
  "idx": 1,
  "production_plan_id": "production_plan_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "warehouse": "warehouse_example",
  "material_request_type": "material_request_type_example",
  "quantity": 0,
  "projected_qty": 0,
  "actual_qty": 0,
  "min_order_qty": 0,
  "sales_order": "sales_order_example",
  "requested_qty": 0,
  "description": "description_example",
  "uom": "uom_example",
  "from_warehouse": "from_warehouse_example",
  "safety_stock": 0,
  "ordered_qty": 0,
  "reserved_qty_for_production": 0,
  "required_bom_qty": 0,
  "conversion_factor": 0,
  "schedule_date": "2024-01-15",
  "stock_reserved_qty": 0,
  "from_bom": "from_bom_example",
  "sub_assembly_item_reference": "sub_assembly_item_reference_example",
  "main_item_code": "main_item_code_example"
}

Production Plan Item

Attributes

idx integer
production_plan_id string required
include_exploded_items boolean
item_code string required
bom_no string required
planned_qty number required
warehouse string
planned_start_date string required
pending_qty number
ordered_qty number
produced_qty number
description string
stock_uom string required
sales_order string
sales_order_item string
material_request string
material_request_item string
product_bundle_item string
item_reference string
temporary_name string

Endpoints

GET /api/manufacturing/production-plan-item?parent_id={id}
POST /api/manufacturing/production-plan-item
PATCH /api/manufacturing/production-plan-item/{id}
DELETE /api/manufacturing/production-plan-item/{id}
POST /api/manufacturing/production-plan-item/reorder
Production Plan Item object 
{
  "id": "production-plan-item_abc123",
  "idx": 1,
  "production_plan_id": "production_plan_id_example",
  "include_exploded_items": true,
  "item_code": "item_code_example",
  "bom_no": "bom_no_example",
  "planned_qty": 0,
  "warehouse": "warehouse_example",
  "planned_start_date": "2024-01-15",
  "pending_qty": 0,
  "ordered_qty": 0,
  "produced_qty": 0,
  "description": "description_example",
  "stock_uom": "stock_uom_example",
  "sales_order": "sales_order_example",
  "sales_order_item": "sales_order_item_example",
  "material_request": "material_request_example",
  "material_request_item": "material_request_item_example",
  "product_bundle_item": "product_bundle_item_example",
  "item_reference": "item_reference_example",
  "temporary_name": "temporary_name_example"
}

Production Plan Item Reference

Attributes

idx integer
production_plan_id string required
sales_order string
sales_order_item string
qty number
item_reference string

Endpoints

GET /api/manufacturing/production-plan-item-reference?parent_id={id}
POST /api/manufacturing/production-plan-item-reference
PATCH /api/manufacturing/production-plan-item-reference/{id}
DELETE /api/manufacturing/production-plan-item-reference/{id}
POST /api/manufacturing/production-plan-item-reference/reorder
Production Plan Item Reference object 
{
  "id": "production-plan-item-reference_abc123",
  "idx": 1,
  "production_plan_id": "production_plan_id_example",
  "sales_order": "sales_order_example",
  "sales_order_item": "sales_order_item_example",
  "qty": 0,
  "item_reference": "item_reference_example"
}

Production Plan Material Request Warehouse

Attributes

idx integer
production_plan_id string required
warehouse string

Endpoints

GET /api/manufacturing/production-plan-material-request-warehouse?parent_id={id}
POST /api/manufacturing/production-plan-material-request-warehouse
PATCH /api/manufacturing/production-plan-material-request-warehouse/{id}
DELETE /api/manufacturing/production-plan-material-request-warehouse/{id}
POST /api/manufacturing/production-plan-material-request-warehouse/reorder
Production Plan Material Request Warehouse object 
{
  "id": "production-plan-material-request-warehouse_abc123",
  "idx": 1,
  "production_plan_id": "production_plan_id_example",
  "warehouse": "warehouse_example"
}

Production Plan Sub Assembly Item

Attributes

idx integer
production_plan_id string required
item_name string
qty number
purchase_order string
received_qty number
bom_no string
production_plan_item string
parent_item_code string
bom_level integer
uom string
stock_uom string
description string
production_item string
indent integer
fg_warehouse string
type_of_manufacturing string
supplier string
schedule_date string
actual_qty number
projected_qty number
wo_produced_qty number
required_qty number
stock_reserved_qty number
ordered_qty number
sales_order string
sales_order_item string

Endpoints

GET /api/manufacturing/production-plan-sub-assembly-item?parent_id={id}
POST /api/manufacturing/production-plan-sub-assembly-item
PATCH /api/manufacturing/production-plan-sub-assembly-item/{id}
DELETE /api/manufacturing/production-plan-sub-assembly-item/{id}
POST /api/manufacturing/production-plan-sub-assembly-item/reorder
Production Plan Sub Assembly Item object 
{
  "id": "production-plan-sub-assembly-item_abc123",
  "idx": 1,
  "production_plan_id": "production_plan_id_example",
  "item_name": "item_name_example",
  "qty": 0,
  "purchase_order": "purchase_order_example",
  "received_qty": 0,
  "bom_no": "bom_no_example",
  "production_plan_item": "production_plan_item_example",
  "parent_item_code": "parent_item_code_example",
  "bom_level": 0,
  "uom": "uom_example",
  "stock_uom": "stock_uom_example",
  "description": "description_example",
  "production_item": "production_item_example",
  "indent": 0,
  "fg_warehouse": "fg_warehouse_example",
  "type_of_manufacturing": "In House",
  "supplier": "supplier_example",
  "schedule_date": "2024-01-15",
  "actual_qty": 0,
  "projected_qty": 0,
  "wo_produced_qty": 0,
  "required_qty": 0,
  "stock_reserved_qty": 0,
  "ordered_qty": 0,
  "sales_order": "sales_order_example",
  "sales_order_item": "sales_order_item_example"
}