The Material Request 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: {material_request_type}

material_request_type string required

customer string

schedule_date string

company string required

scan_barcode string

transaction_date string required

per_ordered number

per_received number

letter_head string

select_print_heading string

tc_name string

terms string

job_card string

set_warehouse string

set_from_warehouse string

transfer_status string

work_order string

buying_price_list string

auto_created_via_reorder boolean

Default: false

The Material Request object

{
  "id": "material-request_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{material_request_type}",
  "material_request_type": "material_request_type_example",
  "customer": "customer_example",
  "schedule_date": "2024-01-15",
  "company": "Example Corp",
  "scan_barcode": "scan_barcode_example",
  "transaction_date": "2024-01-15",
  "per_ordered": 0,
  "per_received": 0,
  "letter_head": "letter_head_example",
  "select_print_heading": "select_print_heading_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "job_card": "job_card_example",
  "set_warehouse": "set_warehouse_example",
  "set_from_warehouse": "set_from_warehouse_example",
  "transfer_status": "transfer_status_example",
  "work_order": "work_order_example",
  "buying_price_list": "buying_price_list_example",
  "auto_created_via_reorder": false
}

GET /api/stock/material-request/{id}

Retrieve a material request

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

Path parameters

id string required

The identifier of the material request to retrieve.

Returns

Returns the material request object if a valid identifier was provided.

GET /api/stock/material-request/{id}

curl https://api.overplane.dev/api/stock/material-request/material-request_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "material-request_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{material_request_type}",
  "material_request_type": "material_request_type_example",
  "customer": "customer_example",
  "schedule_date": "2024-01-15",
  "company": "Example Corp",
  "scan_barcode": "scan_barcode_example",
  "transaction_date": "2024-01-15",
  "per_ordered": 0,
  "per_received": 0,
  "letter_head": "letter_head_example",
  "select_print_heading": "select_print_heading_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "job_card": "job_card_example",
  "set_warehouse": "set_warehouse_example",
  "set_from_warehouse": "set_from_warehouse_example",
  "transfer_status": "transfer_status_example",
  "work_order": "work_order_example",
  "buying_price_list": "buying_price_list_example",
  "auto_created_via_reorder": false
}

GET /api/stock/material-request

List all material requests

Returns a list of material requests. 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 material request objects.

GET /api/stock/material-request

curl https://api.overplane.dev/api/stock/material-request \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "material-request_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "title": "{material_request_type}",
      "material_request_type": "material_request_type_example",
      "customer": "customer_example",
      "schedule_date": "2024-01-15",
      "company": "Example Corp",
      "scan_barcode": "scan_barcode_example",
      "transaction_date": "2024-01-15",
      "per_ordered": 0,
      "per_received": 0,
      "letter_head": "letter_head_example",
      "select_print_heading": "select_print_heading_example",
      "tc_name": "tc_name_example",
      "terms": "terms_example",
      "job_card": "job_card_example",
      "set_warehouse": "set_warehouse_example",
      "set_from_warehouse": "set_from_warehouse_example",
      "transfer_status": "transfer_status_example",
      "work_order": "work_order_example",
      "buying_price_list": "buying_price_list_example",
      "auto_created_via_reorder": false
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/stock/material-request

Create a material request

Creates a new material request object.

Body parameters

status string

Default: draft

title string

Default: {material_request_type}

material_request_type string required

customer string

schedule_date string

company string required

scan_barcode string

transaction_date string required

per_ordered number

per_received number

letter_head string

select_print_heading string

tc_name string

terms string

job_card string

set_warehouse string

set_from_warehouse string

transfer_status string

work_order string

buying_price_list string

auto_created_via_reorder boolean

Default: false

Returns

Returns the newly created material request object if the call succeeded.

POST /api/stock/material-request

curl https://api.overplane.dev/api/stock/material-request \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"material_request_type":"material_request_type_example","company":"Example Corp","transaction_date":"2024-01-15"}'

Response

{
  "id": "material-request_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{material_request_type}",
  "material_request_type": "material_request_type_example",
  "customer": "customer_example",
  "schedule_date": "2024-01-15",
  "company": "Example Corp",
  "scan_barcode": "scan_barcode_example",
  "transaction_date": "2024-01-15",
  "per_ordered": 0,
  "per_received": 0,
  "letter_head": "letter_head_example",
  "select_print_heading": "select_print_heading_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "job_card": "job_card_example",
  "set_warehouse": "set_warehouse_example",
  "set_from_warehouse": "set_from_warehouse_example",
  "transfer_status": "transfer_status_example",
  "work_order": "work_order_example",
  "buying_price_list": "buying_price_list_example",
  "auto_created_via_reorder": false
}

PATCH /api/stock/material-request/{id}

Update a material request

Updates the specified material request 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 material request to update.

Body parameters

status string

Default: draft

title string

Default: {material_request_type}

material_request_type string

customer string

schedule_date string

company string

scan_barcode string

transaction_date string

per_ordered number

per_received number

letter_head string

select_print_heading string

tc_name string

terms string

job_card string

set_warehouse string

set_from_warehouse string

transfer_status string

work_order string

buying_price_list string

auto_created_via_reorder boolean

Default: false

Returns

Returns the updated material request object.

PATCH /api/stock/material-request/{id}

curl https://api.overplane.dev/api/stock/material-request/material-request_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","title":"{material_request_type}"}'

Response

{
  "id": "material-request_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{material_request_type}",
  "material_request_type": "material_request_type_example",
  "customer": "customer_example",
  "schedule_date": "2024-01-15",
  "company": "Example Corp",
  "scan_barcode": "scan_barcode_example",
  "transaction_date": "2024-01-15",
  "per_ordered": 0,
  "per_received": 0,
  "letter_head": "letter_head_example",
  "select_print_heading": "select_print_heading_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "job_card": "job_card_example",
  "set_warehouse": "set_warehouse_example",
  "set_from_warehouse": "set_from_warehouse_example",
  "transfer_status": "transfer_status_example",
  "work_order": "work_order_example",
  "buying_price_list": "buying_price_list_example",
  "auto_created_via_reorder": false
}

DELETE /api/stock/material-request/{id}

Delete a material request

Permanently deletes a material request. This cannot be undone.

Path parameters

id string required

The identifier of the material request to delete.

Returns

Returns a confirmation that the material request has been deleted.

DELETE /api/stock/material-request/{id}

curl https://api.overplane.dev/api/stock/material-request/material-request_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "material-request_abc123",
  "deleted": true
}

POST /api/stock/material-request/{id}/submit

Submit a material request

Submits a draft material request, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the material request to act on.

Returns

Returns the material request object with updated status.

POST /api/stock/material-request/{id}/submit

curl https://api.overplane.dev/api/stock/material-request/material-request_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "material-request_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{material_request_type}",
  "material_request_type": "material_request_type_example",
  "customer": "customer_example",
  "schedule_date": "2024-01-15",
  "company": "Example Corp",
  "scan_barcode": "scan_barcode_example",
  "transaction_date": "2024-01-15",
  "per_ordered": 0,
  "per_received": 0,
  "letter_head": "letter_head_example",
  "select_print_heading": "select_print_heading_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "job_card": "job_card_example",
  "set_warehouse": "set_warehouse_example",
  "set_from_warehouse": "set_from_warehouse_example",
  "transfer_status": "transfer_status_example",
  "work_order": "work_order_example",
  "buying_price_list": "buying_price_list_example",
  "auto_created_via_reorder": false
}

POST /api/stock/material-request/{id}/cancel

Cancel a material request

Cancels a submitted material request, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the material request to act on.

Returns

Returns the material request object with updated status.

POST /api/stock/material-request/{id}/cancel

curl https://api.overplane.dev/api/stock/material-request/material-request_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "material-request_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "{material_request_type}",
  "material_request_type": "material_request_type_example",
  "customer": "customer_example",
  "schedule_date": "2024-01-15",
  "company": "Example Corp",
  "scan_barcode": "scan_barcode_example",
  "transaction_date": "2024-01-15",
  "per_ordered": 0,
  "per_received": 0,
  "letter_head": "letter_head_example",
  "select_print_heading": "select_print_heading_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "job_card": "job_card_example",
  "set_warehouse": "set_warehouse_example",
  "set_from_warehouse": "set_from_warehouse_example",
  "transfer_status": "transfer_status_example",
  "work_order": "work_order_example",
  "buying_price_list": "buying_price_list_example",
  "auto_created_via_reorder": false
}

Line items

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

Material Request Item

Attributes

idx integer

material_request_id string required

item_code string required

item_name string

description string

image string

qty number required

uom string required

conversion_factor number required

stock_uom string required

warehouse string

schedule_date string required

rate number

amount number

stock_qty number

item_group string

brand string

lead_time_date string

sales_order string

sales_order_item string

project string

production_plan string

material_request_plan_item string

min_order_qty number

projected_qty number

actual_qty number

ordered_qty number

expense_account string

cost_center string

page_break boolean

received_qty number

manufacturer string

manufacturer_part_no string

from_warehouse string

bom_no string

job_card_item string

wip_composite_asset string

price_list_rate number

reorder_level number

reorder_qty number

projected_on_hand number

picked_qty number

transferred_qty number

packed_item string

Endpoints

GET /api/stock/material-request-item?parent_id={id}

POST /api/stock/material-request-item

PATCH /api/stock/material-request-item/{id}

DELETE /api/stock/material-request-item/{id}

POST /api/stock/material-request-item/reorder

Material Request Item object

{
  "id": "material-request-item_abc123",
  "idx": 1,
  "material_request_id": "material_request_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "image": "image_example",
  "qty": 0,
  "uom": "uom_example",
  "conversion_factor": 0,
  "stock_uom": "stock_uom_example",
  "warehouse": "warehouse_example",
  "schedule_date": "2024-01-15",
  "rate": 0,
  "amount": 0,
  "stock_qty": 0,
  "item_group": "item_group_example",
  "brand": "brand_example",
  "lead_time_date": "2024-01-15",
  "sales_order": "sales_order_example",
  "sales_order_item": "sales_order_item_example",
  "project": "project_example",
  "production_plan": "production_plan_example",
  "material_request_plan_item": "material_request_plan_item_example",
  "min_order_qty": 0,
  "projected_qty": 0,
  "actual_qty": 0,
  "ordered_qty": 0,
  "expense_account": "expense_account_example",
  "cost_center": "cost_center_example",
  "page_break": false,
  "received_qty": 0,
  "manufacturer": "manufacturer_example",
  "manufacturer_part_no": "manufacturer_part_no_example",
  "from_warehouse": "from_warehouse_example",
  "bom_no": "bom_no_example",
  "job_card_item": "job_card_item_example",
  "wip_composite_asset": "wip_composite_asset_example",
  "price_list_rate": 0,
  "reorder_level": 0,
  "reorder_qty": 0,
  "projected_on_hand": 0,
  "picked_qty": 0,
  "transferred_qty": 0,
  "packed_item": "packed_item_example"
}

The Material Request object

Attributes

Retrieve a material request

Path parameters

Returns

List all material requests

Query parameters

Returns

Create a material request

Body parameters

Returns

Update a material request

Path parameters

Body parameters

Returns

Delete a material request

Path parameters

Returns

Submit a material request

Path parameters

Returns

Cancel a material request

Path parameters

Returns

Line items

Material Request Item

Attributes

Endpoints

Coming Soon