The Subcontracting Inward 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: {customer_name}

sales_order string required
customer string required
customer_name string required
company string required
transaction_date string required
per_delivered number
per_produced number
per_process_loss number
set_delivery_warehouse string
customer_warehouse string required
per_returned number
per_raw_material_returned number
per_raw_material_received number
currency string
The Subcontracting Inward Order object 
{
  "id": "subcontracting-inward-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{customer_name}",
  "sales_order": "sales_order_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "per_delivered": 0,
  "per_produced": 0,
  "per_process_loss": 0,
  "set_delivery_warehouse": "set_delivery_warehouse_example",
  "customer_warehouse": "customer_warehouse_example",
  "per_returned": 0,
  "per_raw_material_returned": 0,
  "per_raw_material_received": 0,
  "currency": "USD"
}
GET /api/subcontracting/subcontracting-inward-order/{id}

Retrieve a subcontracting inward order

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

Path parameters

id string required

The identifier of the subcontracting inward order to retrieve.

Returns

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

GET /api/subcontracting/subcontracting-inward-order/{id} 
curl https://api.overplane.dev/api/subcontracting/subcontracting-inward-order/subcontracting-inward-order_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "subcontracting-inward-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{customer_name}",
  "sales_order": "sales_order_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "per_delivered": 0,
  "per_produced": 0,
  "per_process_loss": 0,
  "set_delivery_warehouse": "set_delivery_warehouse_example",
  "customer_warehouse": "customer_warehouse_example",
  "per_returned": 0,
  "per_raw_material_returned": 0,
  "per_raw_material_received": 0,
  "currency": "USD"
}
GET /api/subcontracting/subcontracting-inward-order

List all subcontracting inward orders

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

GET /api/subcontracting/subcontracting-inward-order 
curl https://api.overplane.dev/api/subcontracting/subcontracting-inward-order \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "subcontracting-inward-order_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "title": "{customer_name}",
      "sales_order": "sales_order_example",
      "customer": "customer_example",
      "customer_name": "customer_name_example",
      "company": "Example Corp",
      "transaction_date": "2024-01-15",
      "per_delivered": 0,
      "per_produced": 0,
      "per_process_loss": 0,
      "set_delivery_warehouse": "set_delivery_warehouse_example",
      "customer_warehouse": "customer_warehouse_example",
      "per_returned": 0,
      "per_raw_material_returned": 0,
      "per_raw_material_received": 0,
      "currency": "USD"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/subcontracting/subcontracting-inward-order

Create a subcontracting inward order

Creates a new subcontracting inward order object.

Body parameters

status string

Default: draft

title string

Default: {customer_name}

sales_order string required
customer string required
customer_name string required
company string required
transaction_date string required
per_delivered number
per_produced number
per_process_loss number
set_delivery_warehouse string
customer_warehouse string required
per_returned number
per_raw_material_returned number
per_raw_material_received number
currency string

Returns

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

POST /api/subcontracting/subcontracting-inward-order 
curl https://api.overplane.dev/api/subcontracting/subcontracting-inward-order \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"sales_order":"sales_order_example","customer":"customer_example","customer_name":"customer_name_example","company":"Example Corp","transaction_date":"2024-01-15","customer_warehouse":"customer_warehouse_example"}'
Response 
{
  "id": "subcontracting-inward-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{customer_name}",
  "sales_order": "sales_order_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "per_delivered": 0,
  "per_produced": 0,
  "per_process_loss": 0,
  "set_delivery_warehouse": "set_delivery_warehouse_example",
  "customer_warehouse": "customer_warehouse_example",
  "per_returned": 0,
  "per_raw_material_returned": 0,
  "per_raw_material_received": 0,
  "currency": "USD"
}
PATCH /api/subcontracting/subcontracting-inward-order/{id}

Update a subcontracting inward order

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

Body parameters

status string

Default: draft

title string

Default: {customer_name}

sales_order string
customer string
customer_name string
company string
transaction_date string
per_delivered number
per_produced number
per_process_loss number
set_delivery_warehouse string
customer_warehouse string
per_returned number
per_raw_material_returned number
per_raw_material_received number
currency string

Returns

Returns the updated subcontracting inward order object.

PATCH /api/subcontracting/subcontracting-inward-order/{id} 
curl https://api.overplane.dev/api/subcontracting/subcontracting-inward-order/subcontracting-inward-order_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","title":"{customer_name}"}'
Response 
{
  "id": "subcontracting-inward-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{customer_name}",
  "sales_order": "sales_order_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "per_delivered": 0,
  "per_produced": 0,
  "per_process_loss": 0,
  "set_delivery_warehouse": "set_delivery_warehouse_example",
  "customer_warehouse": "customer_warehouse_example",
  "per_returned": 0,
  "per_raw_material_returned": 0,
  "per_raw_material_received": 0,
  "currency": "USD"
}
DELETE /api/subcontracting/subcontracting-inward-order/{id}

Delete a subcontracting inward order

Permanently deletes a subcontracting inward order. This cannot be undone.

Path parameters

id string required

The identifier of the subcontracting inward order to delete.

Returns

Returns a confirmation that the subcontracting inward order has been deleted.

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

Submit a subcontracting inward order

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

Path parameters

id string required

The identifier of the subcontracting inward order to act on.

Returns

Returns the subcontracting inward order object with updated status.

POST /api/subcontracting/subcontracting-inward-order/{id}/submit 
curl https://api.overplane.dev/api/subcontracting/subcontracting-inward-order/subcontracting-inward-order_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "subcontracting-inward-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{customer_name}",
  "sales_order": "sales_order_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "per_delivered": 0,
  "per_produced": 0,
  "per_process_loss": 0,
  "set_delivery_warehouse": "set_delivery_warehouse_example",
  "customer_warehouse": "customer_warehouse_example",
  "per_returned": 0,
  "per_raw_material_returned": 0,
  "per_raw_material_received": 0,
  "currency": "USD"
}
POST /api/subcontracting/subcontracting-inward-order/{id}/cancel

Cancel a subcontracting inward order

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

Path parameters

id string required

The identifier of the subcontracting inward order to act on.

Returns

Returns the subcontracting inward order object with updated status.

POST /api/subcontracting/subcontracting-inward-order/{id}/cancel 
curl https://api.overplane.dev/api/subcontracting/subcontracting-inward-order/subcontracting-inward-order_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "subcontracting-inward-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{customer_name}",
  "sales_order": "sales_order_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "company": "Example Corp",
  "transaction_date": "2024-01-15",
  "per_delivered": 0,
  "per_produced": 0,
  "per_process_loss": 0,
  "set_delivery_warehouse": "set_delivery_warehouse_example",
  "customer_warehouse": "customer_warehouse_example",
  "per_returned": 0,
  "per_raw_material_returned": 0,
  "per_raw_material_received": 0,
  "currency": "USD"
}

Line items

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

Subcontracting Inward Order Item

Attributes

idx integer
subcontracting_inward_order_id string required
item_code string required
item_name string required
qty number
stock_uom string required
conversion_factor number
bom string required
include_exploded_items boolean
delivered_qty number
returned_qty number
sales_order_item string
subcontracting_conversion_factor number
produced_qty number
process_loss_qty number
delivery_warehouse string required

Endpoints

GET /api/subcontracting/subcontracting-inward-order-item?parent_id={id}
POST /api/subcontracting/subcontracting-inward-order-item
PATCH /api/subcontracting/subcontracting-inward-order-item/{id}
DELETE /api/subcontracting/subcontracting-inward-order-item/{id}
POST /api/subcontracting/subcontracting-inward-order-item/reorder
Subcontracting Inward Order Item object 
{
  "id": "subcontracting-inward-order-item_abc123",
  "idx": 1,
  "subcontracting_inward_order_id": "subcontracting_inward_order_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "qty": 1,
  "stock_uom": "stock_uom_example",
  "conversion_factor": 1,
  "bom": "bom_example",
  "include_exploded_items": false,
  "delivered_qty": 0,
  "returned_qty": 0,
  "sales_order_item": "sales_order_item_example",
  "subcontracting_conversion_factor": 0,
  "produced_qty": 0,
  "process_loss_qty": 0,
  "delivery_warehouse": "delivery_warehouse_example"
}

Subcontracting Inward Order Received Item

Attributes

idx integer
subcontracting_inward_order_id string required
main_item_code string required
rm_item_code string required
stock_uom string required
bom_detail_no string
reference_name string required
required_qty number
received_qty number
consumed_qty number
returned_qty number
work_order_qty number
is_customer_provided_item boolean
warehouse string
billed_qty number
is_additional_item boolean
rate number

Endpoints

GET /api/subcontracting/subcontracting-inward-order-received-item?parent_id={id}
POST /api/subcontracting/subcontracting-inward-order-received-item
PATCH /api/subcontracting/subcontracting-inward-order-received-item/{id}
DELETE /api/subcontracting/subcontracting-inward-order-received-item/{id}
POST /api/subcontracting/subcontracting-inward-order-received-item/reorder
Subcontracting Inward Order Received Item object 
{
  "id": "subcontracting-inward-order-received-item_abc123",
  "idx": 1,
  "subcontracting_inward_order_id": "subcontracting_inward_order_id_example",
  "main_item_code": "main_item_code_example",
  "rm_item_code": "rm_item_code_example",
  "stock_uom": "stock_uom_example",
  "bom_detail_no": "bom_detail_no_example",
  "reference_name": "reference_name_example",
  "required_qty": 0,
  "received_qty": 0,
  "consumed_qty": 0,
  "returned_qty": 0,
  "work_order_qty": 0,
  "is_customer_provided_item": false,
  "warehouse": "warehouse_example",
  "billed_qty": 0,
  "is_additional_item": false,
  "rate": 0
}

Subcontracting Inward Order Secondary Item

Attributes

idx integer
subcontracting_inward_order_id string required
item_code string required
stock_uom string required
reference_name string required
produced_qty number
delivered_qty number
fg_item_code string required
warehouse string required
type string required

Endpoints

GET /api/subcontracting/subcontracting-inward-order-secondary-item?parent_id={id}
POST /api/subcontracting/subcontracting-inward-order-secondary-item
PATCH /api/subcontracting/subcontracting-inward-order-secondary-item/{id}
DELETE /api/subcontracting/subcontracting-inward-order-secondary-item/{id}
POST /api/subcontracting/subcontracting-inward-order-secondary-item/reorder
Subcontracting Inward Order Secondary Item object 
{
  "id": "subcontracting-inward-order-secondary-item_abc123",
  "idx": 1,
  "subcontracting_inward_order_id": "subcontracting_inward_order_id_example",
  "item_code": "item_code_example",
  "stock_uom": "stock_uom_example",
  "reference_name": "reference_name_example",
  "produced_qty": 0,
  "delivered_qty": 0,
  "fg_item_code": "fg_item_code_example",
  "warehouse": "warehouse_example",
  "type": "type_example"
}

Subcontracting Inward Order Service Item

Attributes

idx integer
subcontracting_inward_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
sales_order_item string
uom string required

Endpoints

GET /api/subcontracting/subcontracting-inward-order-service-item?parent_id={id}
POST /api/subcontracting/subcontracting-inward-order-service-item
PATCH /api/subcontracting/subcontracting-inward-order-service-item/{id}
DELETE /api/subcontracting/subcontracting-inward-order-service-item/{id}
POST /api/subcontracting/subcontracting-inward-order-service-item/reorder
Subcontracting Inward Order Service Item object 
{
  "id": "subcontracting-inward-order-service-item_abc123",
  "idx": 1,
  "subcontracting_inward_order_id": "subcontracting_inward_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,
  "sales_order_item": "sales_order_item_example",
  "uom": "uom_example"
}