The Serial And Batch Entry object
Attributes
id string
Unique identifier for the object.
idx integer
parent_id string required
parent_type string required
serial_no string
batch_no string
qty number
Default: 1
warehouse string
incoming_rate number
outgoing_rate number
stock_value_difference number
is_outward boolean
Default: false
stock_queue string
delivered_qty number
Default: 0
reference_for_reservation string
posting_datetime string
voucher_type string
voucher_no string
voucher_detail_no string
type_of_transaction string
is_cancelled boolean
Default: false
item_code string
The Serial And Batch Entry object
{
"id": "serial-and-batch-entry_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"serial_no": "serial_no_example",
"batch_no": "batch_no_example",
"qty": 1,
"warehouse": "warehouse_example",
"incoming_rate": 0,
"outgoing_rate": 0,
"stock_value_difference": 0,
"is_outward": false,
"stock_queue": "stock_queue_example",
"delivered_qty": 0,
"reference_for_reservation": "reference_for_reservation_example",
"posting_datetime": "2024-01-15",
"voucher_type": "voucher_type_example",
"voucher_no": "voucher_no_example",
"voucher_detail_no": "voucher_detail_no_example",
"type_of_transaction": "type_of_transaction_example",
"is_cancelled": false,
"item_code": "item_code_example"
} GET
/api/stock/serial-and-batch-entry?parent_id={id} List serial and batch entrys by parent
Returns all serial and batch entrys belonging to the specified parent.
Query parameters
parent_id string required
The ID of the parent to list children for.
Returns
A list of serial and batch entry objects belonging to the parent.
GET /api/stock/serial-and-batch-entry?parent_id={id}
curl https://api.overplane.dev/api/stock/serial-and-batch-entry?parent_id=parent_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "serial-and-batch-entry_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"serial_no": "serial_no_example",
"batch_no": "batch_no_example",
"qty": 1,
"warehouse": "warehouse_example",
"incoming_rate": 0,
"outgoing_rate": 0,
"stock_value_difference": 0,
"is_outward": false,
"stock_queue": "stock_queue_example",
"delivered_qty": 0,
"reference_for_reservation": "reference_for_reservation_example",
"posting_datetime": "2024-01-15",
"voucher_type": "voucher_type_example",
"voucher_no": "voucher_no_example",
"voucher_detail_no": "voucher_detail_no_example",
"type_of_transaction": "type_of_transaction_example",
"is_cancelled": false,
"item_code": "item_code_example"
}
],
"has_more": false,
"total": 1
} POST
/api/stock/serial-and-batch-entry Create a serial and batch entry
Creates a new serial and batch entry object.
Body parameters
idx integer
parent_id string required
parent_type string required
serial_no string
batch_no string
qty number
Default: 1
warehouse string
incoming_rate number
outgoing_rate number
stock_value_difference number
is_outward boolean
Default: false
stock_queue string
delivered_qty number
Default: 0
reference_for_reservation string
posting_datetime string
voucher_type string
voucher_no string
voucher_detail_no string
type_of_transaction string
is_cancelled boolean
Default: false
item_code string
Returns
Returns the newly created serial and batch entry object if the call succeeded.
POST /api/stock/serial-and-batch-entry
curl https://api.overplane.dev/api/stock/serial-and-batch-entry \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"parent_id":null,"parent_type":"parent_type_example"}' Response
{
"id": "serial-and-batch-entry_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"serial_no": "serial_no_example",
"batch_no": "batch_no_example",
"qty": 1,
"warehouse": "warehouse_example",
"incoming_rate": 0,
"outgoing_rate": 0,
"stock_value_difference": 0,
"is_outward": false,
"stock_queue": "stock_queue_example",
"delivered_qty": 0,
"reference_for_reservation": "reference_for_reservation_example",
"posting_datetime": "2024-01-15",
"voucher_type": "voucher_type_example",
"voucher_no": "voucher_no_example",
"voucher_detail_no": "voucher_detail_no_example",
"type_of_transaction": "type_of_transaction_example",
"is_cancelled": false,
"item_code": "item_code_example"
} PATCH
/api/stock/serial-and-batch-entry/{id} Update a serial and batch entry
Updates the specified serial and batch entry 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 serial and batch entry to update.
Body parameters
idx integer
parent_id string
parent_type string
serial_no string
batch_no string
qty number
Default: 1
warehouse string
incoming_rate number
outgoing_rate number
stock_value_difference number
is_outward boolean
Default: false
stock_queue string
delivered_qty number
Default: 0
reference_for_reservation string
posting_datetime string
voucher_type string
voucher_no string
voucher_detail_no string
type_of_transaction string
is_cancelled boolean
Default: false
item_code string
Returns
Returns the updated serial and batch entry object.
PATCH /api/stock/serial-and-batch-entry/{id}
curl https://api.overplane.dev/api/stock/serial-and-batch-entry/serial-and-batch-entry_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"idx":1,"parent_id":null}' Response
{
"id": "serial-and-batch-entry_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"serial_no": "serial_no_example",
"batch_no": "batch_no_example",
"qty": 1,
"warehouse": "warehouse_example",
"incoming_rate": 0,
"outgoing_rate": 0,
"stock_value_difference": 0,
"is_outward": false,
"stock_queue": "stock_queue_example",
"delivered_qty": 0,
"reference_for_reservation": "reference_for_reservation_example",
"posting_datetime": "2024-01-15",
"voucher_type": "voucher_type_example",
"voucher_no": "voucher_no_example",
"voucher_detail_no": "voucher_detail_no_example",
"type_of_transaction": "type_of_transaction_example",
"is_cancelled": false,
"item_code": "item_code_example"
} DELETE
/api/stock/serial-and-batch-entry/{id} Delete a serial and batch entry
Permanently deletes a serial and batch entry. This cannot be undone.
Path parameters
id string required
The identifier of the serial and batch entry to delete.
Returns
Returns a confirmation that the serial and batch entry has been deleted.
DELETE /api/stock/serial-and-batch-entry/{id}
curl https://api.overplane.dev/api/stock/serial-and-batch-entry/serial-and-batch-entry_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "serial-and-batch-entry_abc123",
"deleted": true
} POST
/api/stock/serial-and-batch-entry/reorder Reorder serial and batch entrys
Updates the sort order of serial and batch entrys within their parent by setting new index values.
Returns
Returns the reordered list.
POST /api/stock/serial-and-batch-entry/reorder
curl https://api.overplane.dev/api/stock/serial-and-batch-entry/reorder \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "serial-and-batch-entry_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"serial_no": "serial_no_example",
"batch_no": "batch_no_example",
"qty": 1,
"warehouse": "warehouse_example",
"incoming_rate": 0,
"outgoing_rate": 0,
"stock_value_difference": 0,
"is_outward": false,
"stock_queue": "stock_queue_example",
"delivered_qty": 0,
"reference_for_reservation": "reference_for_reservation_example",
"posting_datetime": "2024-01-15",
"voucher_type": "voucher_type_example",
"voucher_no": "voucher_no_example",
"voucher_detail_no": "voucher_detail_no_example",
"type_of_transaction": "type_of_transaction_example",
"is_cancelled": false,
"item_code": "item_code_example"
}