The Serial No 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.

serial_no string required
item_code string required
item_name string
description string
item_group string
brand string
asset string
asset_status string
location string
employee string
maintenance_status string
warranty_period integer
warranty_expiry_date string
amc_expiry_date string
company string required
work_order string
warehouse string
batch_no string
purchase_rate number
status string
customer string
reference_doctype string
reference_name string
posting_date string
The Serial No object 
{
  "id": "serial-no_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "serial_no": "serial_no_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "item_group": "item_group_example",
  "brand": "brand_example",
  "asset": "asset_example",
  "asset_status": "asset_status_example",
  "location": "location_example",
  "employee": "employee_example",
  "maintenance_status": "maintenance_status_example",
  "warranty_period": 0,
  "warranty_expiry_date": "2024-01-15",
  "amc_expiry_date": "2024-01-15",
  "company": "Example Corp",
  "work_order": "work_order_example",
  "warehouse": "warehouse_example",
  "batch_no": "batch_no_example",
  "purchase_rate": 0,
  "status": "draft",
  "customer": "customer_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "posting_date": "2024-01-15"
}
GET /api/stock/serial-no/{id}

Retrieve a serial no

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

Path parameters

id string required

The identifier of the serial no to retrieve.

Returns

Returns the serial no object if a valid identifier was provided.

GET /api/stock/serial-no/{id} 
curl https://api.overplane.dev/api/stock/serial-no/serial-no_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "serial-no_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "serial_no": "serial_no_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "item_group": "item_group_example",
  "brand": "brand_example",
  "asset": "asset_example",
  "asset_status": "asset_status_example",
  "location": "location_example",
  "employee": "employee_example",
  "maintenance_status": "maintenance_status_example",
  "warranty_period": 0,
  "warranty_expiry_date": "2024-01-15",
  "amc_expiry_date": "2024-01-15",
  "company": "Example Corp",
  "work_order": "work_order_example",
  "warehouse": "warehouse_example",
  "batch_no": "batch_no_example",
  "purchase_rate": 0,
  "status": "draft",
  "customer": "customer_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "posting_date": "2024-01-15"
}
GET /api/stock/serial-no

List all serial nos

Returns a list of serial nos. 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 serial no objects.

GET /api/stock/serial-no 
curl https://api.overplane.dev/api/stock/serial-no \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "serial-no_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "serial_no": "serial_no_example",
      "item_code": "item_code_example",
      "item_name": "item_name_example",
      "description": "description_example",
      "item_group": "item_group_example",
      "brand": "brand_example",
      "asset": "asset_example",
      "asset_status": "asset_status_example",
      "location": "location_example",
      "employee": "employee_example",
      "maintenance_status": "maintenance_status_example",
      "warranty_period": 0,
      "warranty_expiry_date": "2024-01-15",
      "amc_expiry_date": "2024-01-15",
      "company": "Example Corp",
      "work_order": "work_order_example",
      "warehouse": "warehouse_example",
      "batch_no": "batch_no_example",
      "purchase_rate": 0,
      "status": "draft",
      "customer": "customer_example",
      "reference_doctype": "reference_doctype_example",
      "reference_name": "reference_name_example",
      "posting_date": "2024-01-15"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/serial-no

Create a serial no

Creates a new serial no object.

Body parameters

serial_no string required
item_code string required
item_name string
description string
item_group string
brand string
asset string
asset_status string
location string
employee string
maintenance_status string
warranty_period integer
warranty_expiry_date string
amc_expiry_date string
company string required
work_order string
warehouse string
batch_no string
purchase_rate number
status string
customer string
reference_doctype string
reference_name string
posting_date string

Returns

Returns the newly created serial no object if the call succeeded.

POST /api/stock/serial-no 
curl https://api.overplane.dev/api/stock/serial-no \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"serial_no":"serial_no_example","item_code":"item_code_example","company":"Example Corp"}'
Response 
{
  "id": "serial-no_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "serial_no": "serial_no_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "item_group": "item_group_example",
  "brand": "brand_example",
  "asset": "asset_example",
  "asset_status": "asset_status_example",
  "location": "location_example",
  "employee": "employee_example",
  "maintenance_status": "maintenance_status_example",
  "warranty_period": 0,
  "warranty_expiry_date": "2024-01-15",
  "amc_expiry_date": "2024-01-15",
  "company": "Example Corp",
  "work_order": "work_order_example",
  "warehouse": "warehouse_example",
  "batch_no": "batch_no_example",
  "purchase_rate": 0,
  "status": "draft",
  "customer": "customer_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "posting_date": "2024-01-15"
}
PATCH /api/stock/serial-no/{id}

Update a serial no

Updates the specified serial no 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 no to update.

Body parameters

serial_no string
item_code string
item_name string
description string
item_group string
brand string
asset string
asset_status string
location string
employee string
maintenance_status string
warranty_period integer
warranty_expiry_date string
amc_expiry_date string
company string
work_order string
warehouse string
batch_no string
purchase_rate number
status string
customer string
reference_doctype string
reference_name string
posting_date string

Returns

Returns the updated serial no object.

PATCH /api/stock/serial-no/{id} 
curl https://api.overplane.dev/api/stock/serial-no/serial-no_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"serial_no":"serial_no_example","item_code":"item_code_example"}'
Response 
{
  "id": "serial-no_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "serial_no": "serial_no_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "item_group": "item_group_example",
  "brand": "brand_example",
  "asset": "asset_example",
  "asset_status": "asset_status_example",
  "location": "location_example",
  "employee": "employee_example",
  "maintenance_status": "maintenance_status_example",
  "warranty_period": 0,
  "warranty_expiry_date": "2024-01-15",
  "amc_expiry_date": "2024-01-15",
  "company": "Example Corp",
  "work_order": "work_order_example",
  "warehouse": "warehouse_example",
  "batch_no": "batch_no_example",
  "purchase_rate": 0,
  "status": "draft",
  "customer": "customer_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "posting_date": "2024-01-15"
}
DELETE /api/stock/serial-no/{id}

Delete a serial no

Permanently deletes a serial no. This cannot be undone.

Path parameters

id string required

The identifier of the serial no to delete.

Returns

Returns a confirmation that the serial no has been deleted.

DELETE /api/stock/serial-no/{id} 
curl https://api.overplane.dev/api/stock/serial-no/serial-no_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "serial-no_abc123",
  "deleted": true
}