The Stock Reconciliation 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

company string required
purpose string required
posting_date string required
posting_time string required
set_posting_time boolean

Default: false

expense_account string
cost_center string
difference_amount number
scan_barcode string
scan_mode boolean

Default: false

set_warehouse string
The Stock Reconciliation object 
{
  "id": "stock-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "expense_account": "expense_account_example",
  "cost_center": "cost_center_example",
  "difference_amount": 0,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "set_warehouse": "set_warehouse_example"
}
GET /api/stock/stock-reconciliation/{id}

Retrieve a stock reconciliation

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

Path parameters

id string required

The identifier of the stock reconciliation to retrieve.

Returns

Returns the stock reconciliation object if a valid identifier was provided.

GET /api/stock/stock-reconciliation/{id} 
curl https://api.overplane.dev/api/stock/stock-reconciliation/stock-reconciliation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "stock-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "expense_account": "expense_account_example",
  "cost_center": "cost_center_example",
  "difference_amount": 0,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "set_warehouse": "set_warehouse_example"
}
GET /api/stock/stock-reconciliation

List all stock reconciliations

Returns a list of stock reconciliations. 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 reconciliation objects.

GET /api/stock/stock-reconciliation 
curl https://api.overplane.dev/api/stock/stock-reconciliation \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "stock-reconciliation_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "purpose": "purpose_example",
      "posting_date": "2024-01-15",
      "posting_time": "posting_time_example",
      "set_posting_time": false,
      "expense_account": "expense_account_example",
      "cost_center": "cost_center_example",
      "difference_amount": 0,
      "scan_barcode": "scan_barcode_example",
      "scan_mode": false,
      "set_warehouse": "set_warehouse_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/stock-reconciliation

Create a stock reconciliation

Creates a new stock reconciliation object.

Body parameters

status string

Default: draft

company string required
purpose string required
posting_date string required
posting_time string required
set_posting_time boolean

Default: false

expense_account string
cost_center string
difference_amount number
scan_barcode string
scan_mode boolean

Default: false

set_warehouse string

Returns

Returns the newly created stock reconciliation object if the call succeeded.

POST /api/stock/stock-reconciliation 
curl https://api.overplane.dev/api/stock/stock-reconciliation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","purpose":"purpose_example","posting_date":"2024-01-15","posting_time":"posting_time_example"}'
Response 
{
  "id": "stock-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "expense_account": "expense_account_example",
  "cost_center": "cost_center_example",
  "difference_amount": 0,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "set_warehouse": "set_warehouse_example"
}
PATCH /api/stock/stock-reconciliation/{id}

Update a stock reconciliation

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

Body parameters

status string

Default: draft

company string
purpose string
posting_date string
posting_time string
set_posting_time boolean

Default: false

expense_account string
cost_center string
difference_amount number
scan_barcode string
scan_mode boolean

Default: false

set_warehouse string

Returns

Returns the updated stock reconciliation object.

PATCH /api/stock/stock-reconciliation/{id} 
curl https://api.overplane.dev/api/stock/stock-reconciliation/stock-reconciliation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "stock-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "expense_account": "expense_account_example",
  "cost_center": "cost_center_example",
  "difference_amount": 0,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "set_warehouse": "set_warehouse_example"
}
DELETE /api/stock/stock-reconciliation/{id}

Delete a stock reconciliation

Permanently deletes a stock reconciliation. This cannot be undone.

Path parameters

id string required

The identifier of the stock reconciliation to delete.

Returns

Returns a confirmation that the stock reconciliation has been deleted.

DELETE /api/stock/stock-reconciliation/{id} 
curl https://api.overplane.dev/api/stock/stock-reconciliation/stock-reconciliation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "stock-reconciliation_abc123",
  "deleted": true
}
POST /api/stock/stock-reconciliation/{id}/submit

Submit a stock reconciliation

Submits a draft stock reconciliation, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the stock reconciliation to act on.

Returns

Returns the stock reconciliation object with updated status.

POST /api/stock/stock-reconciliation/{id}/submit 
curl https://api.overplane.dev/api/stock/stock-reconciliation/stock-reconciliation_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "stock-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "expense_account": "expense_account_example",
  "cost_center": "cost_center_example",
  "difference_amount": 0,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "set_warehouse": "set_warehouse_example"
}
POST /api/stock/stock-reconciliation/{id}/cancel

Cancel a stock reconciliation

Cancels a submitted stock reconciliation, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the stock reconciliation to act on.

Returns

Returns the stock reconciliation object with updated status.

POST /api/stock/stock-reconciliation/{id}/cancel 
curl https://api.overplane.dev/api/stock/stock-reconciliation/stock-reconciliation_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "stock-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "expense_account": "expense_account_example",
  "cost_center": "cost_center_example",
  "difference_amount": 0,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "set_warehouse": "set_warehouse_example"
}

Line items

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

Stock Reconciliation Item

Attributes

idx integer
stock_reconciliation_id string required
barcode string
item_code string required
item_name string
warehouse string required
qty number
stock_uom string
valuation_rate number
amount number
serial_no string
current_qty number
current_serial_no string
current_valuation_rate number
current_amount number
quantity_difference string
amount_difference number
batch_no string
allow_zero_valuation_rate boolean
has_item_scanned string
serial_and_batch_bundle string
current_serial_and_batch_bundle string
item_group string
use_serial_batch_fields boolean
reconcile_all_serial_batch boolean

Endpoints

GET /api/stock/stock-reconciliation-item?parent_id={id}
POST /api/stock/stock-reconciliation-item
PATCH /api/stock/stock-reconciliation-item/{id}
DELETE /api/stock/stock-reconciliation-item/{id}
POST /api/stock/stock-reconciliation-item/reorder
Stock Reconciliation Item object 
{
  "id": "stock-reconciliation-item_abc123",
  "idx": 1,
  "stock_reconciliation_id": "stock_reconciliation_id_example",
  "barcode": "barcode_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "warehouse": "warehouse_example",
  "qty": 0,
  "stock_uom": "stock_uom_example",
  "valuation_rate": 0,
  "amount": 0,
  "serial_no": "serial_no_example",
  "current_qty": 0,
  "current_serial_no": "current_serial_no_example",
  "current_valuation_rate": 0,
  "current_amount": 0,
  "quantity_difference": "quantity_difference_example",
  "amount_difference": 0,
  "batch_no": "batch_no_example",
  "allow_zero_valuation_rate": false,
  "has_item_scanned": "has_item_scanned_example",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "current_serial_and_batch_bundle": "current_serial_and_batch_bundle_example",
  "item_group": "item_group_example",
  "use_serial_batch_fields": false,
  "reconcile_all_serial_batch": false
}