The Purchase Receipt Item Supplied object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
main_item_code string
rm_item_code string
description string
batch_no string
serial_no string
required_qty number
consumed_qty number required
stock_uom string
rate number
amount number
conversion_factor number
current_stock number
reference_name string
bom_detail_no string
item_name string
purchase_order string
The Purchase Receipt Item Supplied object 
{
  "id": "purchase-receipt-item-supplied_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "main_item_code": "main_item_code_example",
  "rm_item_code": "rm_item_code_example",
  "description": "description_example",
  "batch_no": "batch_no_example",
  "serial_no": "serial_no_example",
  "required_qty": 0,
  "consumed_qty": 0,
  "stock_uom": "stock_uom_example",
  "rate": 0,
  "amount": 0,
  "conversion_factor": 0,
  "current_stock": 0,
  "reference_name": "reference_name_example",
  "bom_detail_no": "bom_detail_no_example",
  "item_name": "item_name_example",
  "purchase_order": "purchase_order_example"
}
GET /api/buying/purchase-receipt-item-supplied?parent_id={id}

List purchase receipt item supplieds by parent

Returns all purchase receipt item supplieds belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of purchase receipt item supplied objects belonging to the parent.

GET /api/buying/purchase-receipt-item-supplied?parent_id={id} 
curl https://api.overplane.dev/api/buying/purchase-receipt-item-supplied?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "purchase-receipt-item-supplied_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "main_item_code": "main_item_code_example",
      "rm_item_code": "rm_item_code_example",
      "description": "description_example",
      "batch_no": "batch_no_example",
      "serial_no": "serial_no_example",
      "required_qty": 0,
      "consumed_qty": 0,
      "stock_uom": "stock_uom_example",
      "rate": 0,
      "amount": 0,
      "conversion_factor": 0,
      "current_stock": 0,
      "reference_name": "reference_name_example",
      "bom_detail_no": "bom_detail_no_example",
      "item_name": "item_name_example",
      "purchase_order": "purchase_order_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/purchase-receipt-item-supplied

Create a purchase receipt item supplied

Creates a new purchase receipt item supplied object.

Body parameters

idx integer
parent_id string required
parent_type string required
main_item_code string
rm_item_code string
description string
batch_no string
serial_no string
required_qty number
consumed_qty number required
stock_uom string
rate number
amount number
conversion_factor number
current_stock number
reference_name string
bom_detail_no string
item_name string
purchase_order string

Returns

Returns the newly created purchase receipt item supplied object if the call succeeded.

POST /api/buying/purchase-receipt-item-supplied 
curl https://api.overplane.dev/api/buying/purchase-receipt-item-supplied \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example","consumed_qty":0}'
Response 
{
  "id": "purchase-receipt-item-supplied_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "main_item_code": "main_item_code_example",
  "rm_item_code": "rm_item_code_example",
  "description": "description_example",
  "batch_no": "batch_no_example",
  "serial_no": "serial_no_example",
  "required_qty": 0,
  "consumed_qty": 0,
  "stock_uom": "stock_uom_example",
  "rate": 0,
  "amount": 0,
  "conversion_factor": 0,
  "current_stock": 0,
  "reference_name": "reference_name_example",
  "bom_detail_no": "bom_detail_no_example",
  "item_name": "item_name_example",
  "purchase_order": "purchase_order_example"
}
PATCH /api/buying/purchase-receipt-item-supplied/{id}

Update a purchase receipt item supplied

Updates the specified purchase receipt item supplied 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 purchase receipt item supplied to update.

Body parameters

idx integer
parent_id string
parent_type string
main_item_code string
rm_item_code string
description string
batch_no string
serial_no string
required_qty number
consumed_qty number
stock_uom string
rate number
amount number
conversion_factor number
current_stock number
reference_name string
bom_detail_no string
item_name string
purchase_order string

Returns

Returns the updated purchase receipt item supplied object.

PATCH /api/buying/purchase-receipt-item-supplied/{id} 
curl https://api.overplane.dev/api/buying/purchase-receipt-item-supplied/purchase-receipt-item-supplied_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "purchase-receipt-item-supplied_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "main_item_code": "main_item_code_example",
  "rm_item_code": "rm_item_code_example",
  "description": "description_example",
  "batch_no": "batch_no_example",
  "serial_no": "serial_no_example",
  "required_qty": 0,
  "consumed_qty": 0,
  "stock_uom": "stock_uom_example",
  "rate": 0,
  "amount": 0,
  "conversion_factor": 0,
  "current_stock": 0,
  "reference_name": "reference_name_example",
  "bom_detail_no": "bom_detail_no_example",
  "item_name": "item_name_example",
  "purchase_order": "purchase_order_example"
}
DELETE /api/buying/purchase-receipt-item-supplied/{id}

Delete a purchase receipt item supplied

Permanently deletes a purchase receipt item supplied. This cannot be undone.

Path parameters

id string required

The identifier of the purchase receipt item supplied to delete.

Returns

Returns a confirmation that the purchase receipt item supplied has been deleted.

DELETE /api/buying/purchase-receipt-item-supplied/{id} 
curl https://api.overplane.dev/api/buying/purchase-receipt-item-supplied/purchase-receipt-item-supplied_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "purchase-receipt-item-supplied_abc123",
  "deleted": true
}
POST /api/buying/purchase-receipt-item-supplied/reorder

Reorder purchase receipt item supplieds

Updates the sort order of purchase receipt item supplieds within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/buying/purchase-receipt-item-supplied/reorder 
curl https://api.overplane.dev/api/buying/purchase-receipt-item-supplied/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "purchase-receipt-item-supplied_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "main_item_code": "main_item_code_example",
  "rm_item_code": "rm_item_code_example",
  "description": "description_example",
  "batch_no": "batch_no_example",
  "serial_no": "serial_no_example",
  "required_qty": 0,
  "consumed_qty": 0,
  "stock_uom": "stock_uom_example",
  "rate": 0,
  "amount": 0,
  "conversion_factor": 0,
  "current_stock": 0,
  "reference_name": "reference_name_example",
  "bom_detail_no": "bom_detail_no_example",
  "item_name": "item_name_example",
  "purchase_order": "purchase_order_example"
}