Stock Entry

A stock movement: goods received, issued, moved between stores, or made from other goods.

Area: Stock and stores · Why it is here: openapi.yaml; api/README.md; guide chapter 05; recipe connected_app; sample S40; sample S45; the MCP server; the request collection; retail core · Fields: 53 · Submitted (booked) records: send docstatus: 1 to book it as you create it, or submit a draft with submit.

Read and write it

Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.

Read a list (only name unless you ask for fields):

curl -s "https://⟨site⟩/api/resource/Stock%20Entry?fields=%5B%22*%22%5D&limit_page_length=20" \
  -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Read one, with its tables:

curl -s "https://⟨site⟩/api/resource/Stock%20Entry/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one (the required fields first), if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/Stock%20Entry" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"naming_series": …, "stock_entry_type": …, "company": …, "items": …}'

Change one with PUT /api/resource/Stock%20Entry/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.

Samples that use it

s2_bins · s5_config_pack · s7_system_sync · s30_units_as_serials · s40_expiry_recall · s41_regulated_register · s45_restaurant_back_office

Fields

Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.

Field	Field name	Type	Required	Read-only	Hidden	Links to
Series	`naming_series`	Select	yes			one of: MAT-STE-.YYYY.-
Stock Entry Type	`stock_entry_type`	Link	yes			Stock Entry Type
Stock Entry (Outward GIT)	`outgoing_stock_entry`	Link		yes		Stock Entry
Purpose	`purpose`	Select		yes	yes	one of: Material Issue, Material Receipt, Material Transfer, Material Transfer for Manufacture, Material Consumption for Manufacture, Manufacture, Repack, Send to Subcontractor, Disassemble
Add to Transit	`add_to_transit`	Check
Work Order	`work_order`	Link				Work Order
Purchase Order	`purchase_order`	Link				Purchase Order
Subcontracting Order	`subcontracting_order`	Link				Subcontracting Order
Delivery Note No	`delivery_note_no`	Link				Delivery Note
Sales Invoice No	`sales_invoice_no`	Link				Sales Invoice
Pick List	`pick_list`	Link		yes		Pick List
Purchase Receipt No	`purchase_receipt_no`	Link				Purchase Receipt
Asset Repair	`asset_repair`	Link		yes		Asset Repair
Company	`company`	Link	yes			Company
Posting Date	`posting_date`	Date
Posting Time	`posting_time`	Time
Edit Posting Date and Time	`set_posting_time`	Check
Inspection Required	`inspection_required`	Check
Apply Putaway Rule	`apply_putaway_rule`	Check
From BOM	`from_bom`	Check
Use Multi-Level BOM	`use_multi_level_bom`	Check
BOM No	`bom_no`	Link				BOM
Finished Good Quantity	`fg_completed_qty`	Float
% Process Loss	`process_loss_percentage`	Percent
Process Loss Qty	`process_loss_qty`	Float
Default Source Warehouse	`from_warehouse`	Link				Warehouse
Source Warehouse Address Link	`source_warehouse_address`	Link				Address
Source Warehouse Address	`source_address_display`	Small Text		yes
Default Target Warehouse	`to_warehouse`	Link				Warehouse
Target Warehouse Address Link	`target_warehouse_address`	Link				Address
Target Warehouse Address	`target_address_display`	Small Text		yes
Scan Barcode	`scan_barcode`	Data
Items	`items`	Table	yes			Stock Entry Detail
Total Outgoing Value (Consumption)	`total_outgoing_value`	Currency		yes
Total Incoming Value (Receipt)	`total_incoming_value`	Currency		yes
Total Value Difference (Incoming - Outgoing)	`value_difference`	Currency		yes
Additional Costs	`additional_costs`	Table				Landed Cost Taxes and Charges
Total Additional Costs	`total_additional_costs`	Currency		yes
Supplier	`supplier`	Link				Supplier
Supplier Name	`supplier_name`	Data		yes
Supplier Address	`supplier_address`	Link				Address
Address	`address_display`	Small Text
Project	`project`	Link				Project
Print Heading	`select_print_heading`	Link				Print Heading
Letter Head	`letter_head`	Link				Letter Head
Is Opening	`is_opening`	Select				one of: No, Yes
Remarks	`remarks`	Text
Per Transferred	`per_transferred`	Percent		yes
Total Amount	`total_amount`	Currency		yes
Job Card	`job_card`	Link		yes		Job Card
Amended From	`amended_from`	Link		yes		Stock Entry
Credit Note	`credit_note`	Link			yes	Journal Entry
Is Return	`is_return`	Check		yes	yes

Table: Landed Cost Taxes and Charges

The rows of additional_costs. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Read-only	Links to
Expense Account	`expense_account`	Link			Account
Account Currency	`account_currency`	Link		yes	Currency
Exchange Rate	`exchange_rate`	Float
Description	`description`	Small Text	yes
Amount	`amount`	Currency	yes
Amount (Company Currency)	`base_amount`	Currency		yes
Has Corrective Cost	`has_corrective_cost`	Check		yes

Table: Stock Entry Detail

The rows of items. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Read-only	Hidden	Links to
Barcode	`barcode`	Data
Has Item Scanned	`has_item_scanned`	Check		yes
Source Warehouse	`s_warehouse`	Link				Warehouse
Target Warehouse	`t_warehouse`	Link				Warehouse
Item Code	`item_code`	Link	yes			Item
Item Name	`item_name`	Data		yes
Is Finished Item	`is_finished_item`	Check
Is Scrap Item	`is_scrap_item`	Check
Quality Inspection	`quality_inspection`	Link				Quality Inspection
Subcontracted Item	`subcontracted_item`	Link				Item
Description	`description`	Text Editor
Item Group	`item_group`	Data
Image	`image`	Attach			yes
Qty	`qty`	Float	yes
Qty as per Stock UOM	`transfer_qty`	Float	yes	yes
Retain Sample	`retain_sample`	Check		yes
UOM	`uom`	Link	yes			UOM
Stock UOM	`stock_uom`	Link	yes	yes		UOM
Conversion Factor	`conversion_factor`	Float	yes
Sample Quantity	`sample_quantity`	Int
Basic Rate (as per Stock UOM)	`basic_rate`	Currency
Additional Cost	`additional_cost`	Currency		yes
Valuation Rate	`valuation_rate`	Currency		yes
Allow Zero Valuation Rate	`allow_zero_valuation_rate`	Check
Set Basic Rate Manually	`set_basic_rate_manually`	Check
Basic Amount	`basic_amount`	Currency		yes
Amount	`amount`	Currency		yes
Use Serial No / Batch Fields	`use_serial_batch_fields`	Check
Serial and Batch Bundle	`serial_and_batch_bundle`	Link				Serial and Batch Bundle
Has Serial Expiry (added by iVendNext)	`custom_has_serial_expiry`	Check			yes
Serial Expiry Date (added by iVendNext)	`custom_serial_expiry_date`	Date
Serial No	`serial_no`	Text
Batch No	`batch_no`	Link				Batch
Difference Account	`expense_account`	Link				Account
Cost Center	`cost_center`	Link				Cost Center
Project	`project`	Link				Project
Actual Qty (at source/target)	`actual_qty`	Float		yes
Transferred Qty	`transferred_qty`	Float		yes
BOM No	`bom_no`	Link			yes	BOM
Allow Alternative Item	`allow_alternative_item`	Check		yes
Material Request	`material_request`	Link		yes	yes	Material Request
Material Request Item	`material_request_item`	Link		yes	yes	Material Request Item
Original Item	`original_item`	Link		yes	yes	Item
Against Stock Entry	`against_stock_entry`	Link		yes		Stock Entry
Stock Entry Child	`ste_detail`	Data		yes
PO Supplied Item	`po_detail`	Data		yes	yes
SCO Supplied Item	`sco_rm_detail`	Data		yes	yes
Putaway Rule	`putaway_rule`	Link		yes		Putaway Rule
Reference Purchase Receipt	`reference_purchase_receipt`	Link		yes		Purchase Receipt
Job Card Item	`job_card_item`	Data		yes	yes

All record types · What you can use

This record type in the kit