The Subcontracting Order 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

title string

Default: {supplier_name}

purchase_order string required
supplier string required
supplier_name string required
supplier_warehouse string required
company string required
transaction_date string required
schedule_date string
supplier_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
shipping_address string
shipping_address_display string
billing_address string
billing_address_display string
set_warehouse string
total_qty number
total number
set_reserve_warehouse string
total_additional_costs number
per_received number
select_print_heading string
letter_head string
distribute_additional_costs_based_on string

Default: Qty

cost_center string
project string
supplier_currency string
reserve_stock boolean

Default: false

production_plan string
The Subcontracting Order object 
{
  "id": "subcontracting-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{supplier_name}",
  "purchase_order": "purchase_order_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "schedule_date": "2024-01-15",
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "set_warehouse": "set_warehouse_example",
  "total_qty": 0,
  "total": 0,
  "set_reserve_warehouse": "set_reserve_warehouse_example",
  "total_additional_costs": 0,
  "per_received": 0,
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "distribute_additional_costs_based_on": "Qty",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "supplier_currency": "USD",
  "reserve_stock": false,
  "production_plan": "production_plan_example"
}
GET /api/subcontracting/subcontracting-order/{id}

Retrieve a subcontracting order

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

Path parameters

id string required

The identifier of the subcontracting order to retrieve.

Returns

Returns the subcontracting order object if a valid identifier was provided.

GET /api/subcontracting/subcontracting-order/{id} 
curl https://api.overplane.dev/api/subcontracting/subcontracting-order/subcontracting-order_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "subcontracting-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{supplier_name}",
  "purchase_order": "purchase_order_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "schedule_date": "2024-01-15",
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "set_warehouse": "set_warehouse_example",
  "total_qty": 0,
  "total": 0,
  "set_reserve_warehouse": "set_reserve_warehouse_example",
  "total_additional_costs": 0,
  "per_received": 0,
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "distribute_additional_costs_based_on": "Qty",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "supplier_currency": "USD",
  "reserve_stock": false,
  "production_plan": "production_plan_example"
}
GET /api/subcontracting/subcontracting-order

List all subcontracting orders

Returns a list of subcontracting orders. 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 subcontracting order objects.

GET /api/subcontracting/subcontracting-order 
curl https://api.overplane.dev/api/subcontracting/subcontracting-order \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "subcontracting-order_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "title": "{supplier_name}",
      "purchase_order": "purchase_order_example",
      "supplier": "supplier_example",
      "supplier_name": "supplier_name_example",
      "supplier_warehouse": "supplier_warehouse_example",
      "company": "Example Corp",
      "transaction_date": "2024-01-15",
      "schedule_date": "2024-01-15",
      "supplier_address": "supplier_address_example",
      "address_display": "address_display_example",
      "contact_person": "contact_person_example",
      "contact_display": "contact_display_example",
      "contact_mobile": "contact_mobile_example",
      "contact_email": "user@example.com",
      "shipping_address": "shipping_address_example",
      "shipping_address_display": "shipping_address_display_example",
      "billing_address": "billing_address_example",
      "billing_address_display": "billing_address_display_example",
      "set_warehouse": "set_warehouse_example",
      "total_qty": 0,
      "total": 0,
      "set_reserve_warehouse": "set_reserve_warehouse_example",
      "total_additional_costs": 0,
      "per_received": 0,
      "select_print_heading": "select_print_heading_example",
      "letter_head": "letter_head_example",
      "distribute_additional_costs_based_on": "Qty",
      "cost_center": "cost_center_example",
      "project": "project_example",
      "supplier_currency": "USD",
      "reserve_stock": false,
      "production_plan": "production_plan_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/subcontracting/subcontracting-order

Create a subcontracting order

Creates a new subcontracting order object.

Body parameters

status string

Default: draft

title string

Default: {supplier_name}

purchase_order string required
supplier string required
supplier_name string required
supplier_warehouse string required
company string required
transaction_date string required
schedule_date string
supplier_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
shipping_address string
shipping_address_display string
billing_address string
billing_address_display string
set_warehouse string
total_qty number
total number
set_reserve_warehouse string
total_additional_costs number
per_received number
select_print_heading string
letter_head string
distribute_additional_costs_based_on string

Default: Qty

cost_center string
project string
supplier_currency string
reserve_stock boolean

Default: false

production_plan string

Returns

Returns the newly created subcontracting order object if the call succeeded.

POST /api/subcontracting/subcontracting-order 
curl https://api.overplane.dev/api/subcontracting/subcontracting-order \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"purchase_order":"purchase_order_example","supplier":"supplier_example","supplier_name":"supplier_name_example","supplier_warehouse":"supplier_warehouse_example","company":"Example Corp","transaction_date":"2024-01-15"}'
Response 
{
  "id": "subcontracting-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{supplier_name}",
  "purchase_order": "purchase_order_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "schedule_date": "2024-01-15",
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "set_warehouse": "set_warehouse_example",
  "total_qty": 0,
  "total": 0,
  "set_reserve_warehouse": "set_reserve_warehouse_example",
  "total_additional_costs": 0,
  "per_received": 0,
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "distribute_additional_costs_based_on": "Qty",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "supplier_currency": "USD",
  "reserve_stock": false,
  "production_plan": "production_plan_example"
}
PATCH /api/subcontracting/subcontracting-order/{id}

Update a subcontracting order

Updates the specified subcontracting order 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 subcontracting order to update.

Body parameters

status string

Default: draft

title string

Default: {supplier_name}

purchase_order string
supplier string
supplier_name string
supplier_warehouse string
company string
transaction_date string
schedule_date string
supplier_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
shipping_address string
shipping_address_display string
billing_address string
billing_address_display string
set_warehouse string
total_qty number
total number
set_reserve_warehouse string
total_additional_costs number
per_received number
select_print_heading string
letter_head string
distribute_additional_costs_based_on string

Default: Qty

cost_center string
project string
supplier_currency string
reserve_stock boolean

Default: false

production_plan string

Returns

Returns the updated subcontracting order object.

PATCH /api/subcontracting/subcontracting-order/{id} 
curl https://api.overplane.dev/api/subcontracting/subcontracting-order/subcontracting-order_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","title":"{supplier_name}"}'
Response 
{
  "id": "subcontracting-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{supplier_name}",
  "purchase_order": "purchase_order_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "schedule_date": "2024-01-15",
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "set_warehouse": "set_warehouse_example",
  "total_qty": 0,
  "total": 0,
  "set_reserve_warehouse": "set_reserve_warehouse_example",
  "total_additional_costs": 0,
  "per_received": 0,
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "distribute_additional_costs_based_on": "Qty",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "supplier_currency": "USD",
  "reserve_stock": false,
  "production_plan": "production_plan_example"
}
DELETE /api/subcontracting/subcontracting-order/{id}

Delete a subcontracting order

Permanently deletes a subcontracting order. This cannot be undone.

Path parameters

id string required

The identifier of the subcontracting order to delete.

Returns

Returns a confirmation that the subcontracting order has been deleted.

DELETE /api/subcontracting/subcontracting-order/{id} 
curl https://api.overplane.dev/api/subcontracting/subcontracting-order/subcontracting-order_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "subcontracting-order_abc123",
  "deleted": true
}
POST /api/subcontracting/subcontracting-order/{id}/submit

Submit a subcontracting order

Submits a draft subcontracting order, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the subcontracting order to act on.

Returns

Returns the subcontracting order object with updated status.

POST /api/subcontracting/subcontracting-order/{id}/submit 
curl https://api.overplane.dev/api/subcontracting/subcontracting-order/subcontracting-order_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "subcontracting-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{supplier_name}",
  "purchase_order": "purchase_order_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "schedule_date": "2024-01-15",
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "set_warehouse": "set_warehouse_example",
  "total_qty": 0,
  "total": 0,
  "set_reserve_warehouse": "set_reserve_warehouse_example",
  "total_additional_costs": 0,
  "per_received": 0,
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "distribute_additional_costs_based_on": "Qty",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "supplier_currency": "USD",
  "reserve_stock": false,
  "production_plan": "production_plan_example"
}
POST /api/subcontracting/subcontracting-order/{id}/cancel

Cancel a subcontracting order

Cancels a submitted subcontracting order, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the subcontracting order to act on.

Returns

Returns the subcontracting order object with updated status.

POST /api/subcontracting/subcontracting-order/{id}/cancel 
curl https://api.overplane.dev/api/subcontracting/subcontracting-order/subcontracting-order_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "subcontracting-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{supplier_name}",
  "purchase_order": "purchase_order_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "schedule_date": "2024-01-15",
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "set_warehouse": "set_warehouse_example",
  "total_qty": 0,
  "total": 0,
  "set_reserve_warehouse": "set_reserve_warehouse_example",
  "total_additional_costs": 0,
  "per_received": 0,
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "distribute_additional_costs_based_on": "Qty",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "supplier_currency": "USD",
  "reserve_stock": false,
  "production_plan": "production_plan_example"
}

Line items

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

Subcontracting Order Item

Attributes

idx integer
subcontracting_order_id string required
item_code string required
item_name string required
schedule_date string
expected_delivery_date string
description string
image string
image_view string
qty number
stock_uom string required
conversion_factor number
rate number required
amount number required
warehouse string required
expense_account string
manufacturer string
manufacturer_part_no string
bom string required
include_exploded_items boolean
service_cost_per_qty number required
additional_cost_per_qty number
rm_cost_per_qty number
page_break boolean
received_qty number
returned_qty number
cost_center string
project string
material_request string
material_request_item string
purchase_order_item string
job_card string
subcontracting_conversion_factor number
production_plan_sub_assembly_item string

Endpoints

GET /api/subcontracting/subcontracting-order-item?parent_id={id}
POST /api/subcontracting/subcontracting-order-item
PATCH /api/subcontracting/subcontracting-order-item/{id}
DELETE /api/subcontracting/subcontracting-order-item/{id}
POST /api/subcontracting/subcontracting-order-item/reorder
Subcontracting Order Item object 
{
  "id": "subcontracting-order-item_abc123",
  "idx": 1,
  "subcontracting_order_id": "subcontracting_order_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "schedule_date": "2024-01-15",
  "expected_delivery_date": "2024-01-15",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "qty": 1,
  "stock_uom": "stock_uom_example",
  "conversion_factor": 1,
  "rate": 0,
  "amount": 0,
  "warehouse": "warehouse_example",
  "expense_account": "expense_account_example",
  "manufacturer": "manufacturer_example",
  "manufacturer_part_no": "manufacturer_part_no_example",
  "bom": "bom_example",
  "include_exploded_items": false,
  "service_cost_per_qty": 0,
  "additional_cost_per_qty": 0,
  "rm_cost_per_qty": 0,
  "page_break": false,
  "received_qty": 0,
  "returned_qty": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "material_request": "material_request_example",
  "material_request_item": "material_request_item_example",
  "purchase_order_item": "purchase_order_item_example",
  "job_card": "job_card_example",
  "subcontracting_conversion_factor": 0,
  "production_plan_sub_assembly_item": "production_plan_sub_assembly_item_example"
}

Subcontracting Order Service Item

Attributes

idx integer
subcontracting_order_id string required
item_code string required
item_name string required
qty number required
rate number required
amount number required
fg_item string required
fg_item_qty number
purchase_order_item string
material_request string
material_request_item string

Endpoints

GET /api/subcontracting/subcontracting-order-service-item?parent_id={id}
POST /api/subcontracting/subcontracting-order-service-item
PATCH /api/subcontracting/subcontracting-order-service-item/{id}
DELETE /api/subcontracting/subcontracting-order-service-item/{id}
POST /api/subcontracting/subcontracting-order-service-item/reorder
Subcontracting Order Service Item object 
{
  "id": "subcontracting-order-service-item_abc123",
  "idx": 1,
  "subcontracting_order_id": "subcontracting_order_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "qty": 0,
  "rate": 0,
  "amount": 0,
  "fg_item": "fg_item_example",
  "fg_item_qty": 1,
  "purchase_order_item": "purchase_order_item_example",
  "material_request": "material_request_example",
  "material_request_item": "material_request_item_example"
}

Subcontracting Order Supplied Item

Attributes

idx integer
subcontracting_order_id string required
main_item_code string
rm_item_code string
stock_uom string
conversion_factor number
reserve_warehouse string
bom_detail_no string
reference_name string
rate number
amount number
required_qty number
supplied_qty number
consumed_qty number
returned_qty number
total_supplied_qty number
stock_reserved_qty number

Endpoints

GET /api/subcontracting/subcontracting-order-supplied-item?parent_id={id}
POST /api/subcontracting/subcontracting-order-supplied-item
PATCH /api/subcontracting/subcontracting-order-supplied-item/{id}
DELETE /api/subcontracting/subcontracting-order-supplied-item/{id}
POST /api/subcontracting/subcontracting-order-supplied-item/reorder
Subcontracting Order Supplied Item object 
{
  "id": "subcontracting-order-supplied-item_abc123",
  "idx": 1,
  "subcontracting_order_id": "subcontracting_order_id_example",
  "main_item_code": "main_item_code_example",
  "rm_item_code": "rm_item_code_example",
  "stock_uom": "stock_uom_example",
  "conversion_factor": 1,
  "reserve_warehouse": "reserve_warehouse_example",
  "bom_detail_no": "bom_detail_no_example",
  "reference_name": "reference_name_example",
  "rate": 0,
  "amount": 0,
  "required_qty": 0,
  "supplied_qty": 0,
  "consumed_qty": 0,
  "returned_qty": 0,
  "total_supplied_qty": 0,
  "stock_reserved_qty": 0
}