The Stock Closing Balance 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.

item_code string
warehouse string
posting_date string
posting_time string
posting_datetime string
actual_qty number
valuation_rate number
stock_value number
company string
stock_uom string
stock_value_difference number
item_name string
item_group string
stock_closing_entry string
inventory_dimension_key string
batch_no string
fifo_queue string
The Stock Closing Balance object 
{
  "id": "stock-closing-balance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "warehouse": "warehouse_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "posting_datetime": "2024-01-15",
  "actual_qty": 0,
  "valuation_rate": 0,
  "stock_value": 0,
  "company": "Example Corp",
  "stock_uom": "stock_uom_example",
  "stock_value_difference": 0,
  "item_name": "item_name_example",
  "item_group": "item_group_example",
  "stock_closing_entry": "stock_closing_entry_example",
  "inventory_dimension_key": "inventory_dimension_key_example",
  "batch_no": "batch_no_example",
  "fifo_queue": "fifo_queue_example"
}
GET /api/stock/stock-closing-balance/{id}

Retrieve a stock closing balance

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

Path parameters

id string required

The identifier of the stock closing balance to retrieve.

Returns

Returns the stock closing balance object if a valid identifier was provided.

GET /api/stock/stock-closing-balance/{id} 
curl https://api.overplane.dev/api/stock/stock-closing-balance/stock-closing-balance_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "stock-closing-balance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "warehouse": "warehouse_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "posting_datetime": "2024-01-15",
  "actual_qty": 0,
  "valuation_rate": 0,
  "stock_value": 0,
  "company": "Example Corp",
  "stock_uom": "stock_uom_example",
  "stock_value_difference": 0,
  "item_name": "item_name_example",
  "item_group": "item_group_example",
  "stock_closing_entry": "stock_closing_entry_example",
  "inventory_dimension_key": "inventory_dimension_key_example",
  "batch_no": "batch_no_example",
  "fifo_queue": "fifo_queue_example"
}
GET /api/stock/stock-closing-balance

List all stock closing balances

Returns a list of stock closing balances. 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 stock closing balance objects.

GET /api/stock/stock-closing-balance 
curl https://api.overplane.dev/api/stock/stock-closing-balance \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "stock-closing-balance_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "item_code": "item_code_example",
      "warehouse": "warehouse_example",
      "posting_date": "2024-01-15",
      "posting_time": "posting_time_example",
      "posting_datetime": "2024-01-15",
      "actual_qty": 0,
      "valuation_rate": 0,
      "stock_value": 0,
      "company": "Example Corp",
      "stock_uom": "stock_uom_example",
      "stock_value_difference": 0,
      "item_name": "item_name_example",
      "item_group": "item_group_example",
      "stock_closing_entry": "stock_closing_entry_example",
      "inventory_dimension_key": "inventory_dimension_key_example",
      "batch_no": "batch_no_example",
      "fifo_queue": "fifo_queue_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/stock-closing-balance

Create a stock closing balance

Creates a new stock closing balance object.

Body parameters

item_code string
warehouse string
posting_date string
posting_time string
posting_datetime string
actual_qty number
valuation_rate number
stock_value number
company string
stock_uom string
stock_value_difference number
item_name string
item_group string
stock_closing_entry string
inventory_dimension_key string
batch_no string
fifo_queue string

Returns

Returns the newly created stock closing balance object if the call succeeded.

POST /api/stock/stock-closing-balance 
curl https://api.overplane.dev/api/stock/stock-closing-balance \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "stock-closing-balance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "warehouse": "warehouse_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "posting_datetime": "2024-01-15",
  "actual_qty": 0,
  "valuation_rate": 0,
  "stock_value": 0,
  "company": "Example Corp",
  "stock_uom": "stock_uom_example",
  "stock_value_difference": 0,
  "item_name": "item_name_example",
  "item_group": "item_group_example",
  "stock_closing_entry": "stock_closing_entry_example",
  "inventory_dimension_key": "inventory_dimension_key_example",
  "batch_no": "batch_no_example",
  "fifo_queue": "fifo_queue_example"
}
PATCH /api/stock/stock-closing-balance/{id}

Update a stock closing balance

Updates the specified stock closing balance 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 stock closing balance to update.

Body parameters

item_code string
warehouse string
posting_date string
posting_time string
posting_datetime string
actual_qty number
valuation_rate number
stock_value number
company string
stock_uom string
stock_value_difference number
item_name string
item_group string
stock_closing_entry string
inventory_dimension_key string
batch_no string
fifo_queue string

Returns

Returns the updated stock closing balance object.

PATCH /api/stock/stock-closing-balance/{id} 
curl https://api.overplane.dev/api/stock/stock-closing-balance/stock-closing-balance_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"item_code":"item_code_example","warehouse":"warehouse_example"}'
Response 
{
  "id": "stock-closing-balance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "warehouse": "warehouse_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "posting_datetime": "2024-01-15",
  "actual_qty": 0,
  "valuation_rate": 0,
  "stock_value": 0,
  "company": "Example Corp",
  "stock_uom": "stock_uom_example",
  "stock_value_difference": 0,
  "item_name": "item_name_example",
  "item_group": "item_group_example",
  "stock_closing_entry": "stock_closing_entry_example",
  "inventory_dimension_key": "inventory_dimension_key_example",
  "batch_no": "batch_no_example",
  "fifo_queue": "fifo_queue_example"
}
DELETE /api/stock/stock-closing-balance/{id}

Delete a stock closing balance

Permanently deletes a stock closing balance. This cannot be undone.

Path parameters

id string required

The identifier of the stock closing balance to delete.

Returns

Returns a confirmation that the stock closing balance has been deleted.

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