The POS Invoice Item object
Attributes
id string
Unique identifier for the object.
idx integer
pos_invoice_id string required
barcode string
item_code string
item_name string required
customer_item_code string
description string
item_group string
brand string
image string
image_view string
qty number
stock_uom string
uom string required
conversion_factor number required
stock_qty number
price_list_rate number
base_price_list_rate number
margin_type string
margin_rate_or_amount number
rate_with_margin number
discount_percentage number
discount_amount number
base_rate_with_margin number
rate number required
amount number required
item_tax_template string
base_rate number required
base_amount number required
pricing_rules string
is_free_item boolean
Default: false
net_rate number
net_amount number
base_net_rate number
base_net_amount number
delivered_by_supplier boolean
Default: false
income_account string required
is_fixed_asset boolean
Default: false
asset string
finance_book string
expense_account string
deferred_revenue_account string
service_stop_date string
enable_deferred_revenue boolean
Default: false
service_start_date string
service_end_date string
weight_per_unit number
total_weight number
weight_uom string
warehouse string
target_warehouse string
quality_inspection string
batch_no string
allow_zero_valuation_rate boolean
Default: false
serial_no string
item_tax_rate string
actual_batch_qty number
actual_qty number
sales_order string
so_detail string
delivery_note string
dn_detail string
delivered_qty number
cost_center string required
page_break boolean
Default: false
project string
pos_invoice_item string
grant_commission boolean
Default: false
has_item_scanned boolean
Default: false
serial_and_batch_bundle string
use_serial_batch_fields boolean
Default: false
distributed_discount_amount number
The POS Invoice Item object
{
"id": "p-o-s-invoice-item_abc123",
"idx": 1,
"pos_invoice_id": "pos_invoice_id_example",
"barcode": "barcode_example",
"item_code": "item_code_example",
"item_name": "item_name_example",
"customer_item_code": "customer_item_code_example",
"description": "description_example",
"item_group": "item_group_example",
"brand": "brand_example",
"image": "image_example",
"image_view": "image_view_example",
"qty": 0,
"stock_uom": "stock_uom_example",
"uom": "uom_example",
"conversion_factor": 0,
"stock_qty": 0,
"price_list_rate": 0,
"base_price_list_rate": 0,
"margin_type": "margin_type_example",
"margin_rate_or_amount": 0,
"rate_with_margin": 0,
"discount_percentage": 0,
"discount_amount": 0,
"base_rate_with_margin": 0,
"rate": 0,
"amount": 0,
"item_tax_template": "item_tax_template_example",
"base_rate": 0,
"base_amount": 0,
"pricing_rules": "pricing_rules_example",
"is_free_item": false,
"net_rate": 0,
"net_amount": 0,
"base_net_rate": 0,
"base_net_amount": 0,
"delivered_by_supplier": false,
"income_account": "income_account_example",
"is_fixed_asset": false,
"asset": "asset_example",
"finance_book": "finance_book_example",
"expense_account": "expense_account_example",
"deferred_revenue_account": "deferred_revenue_account_example",
"service_stop_date": "2024-01-15",
"enable_deferred_revenue": false,
"service_start_date": "2024-01-15",
"service_end_date": "2024-01-15",
"weight_per_unit": 0,
"total_weight": 0,
"weight_uom": "weight_uom_example",
"warehouse": "warehouse_example",
"target_warehouse": "target_warehouse_example",
"quality_inspection": "quality_inspection_example",
"batch_no": "batch_no_example",
"allow_zero_valuation_rate": false,
"serial_no": "serial_no_example",
"item_tax_rate": "item_tax_rate_example",
"actual_batch_qty": 0,
"actual_qty": 0,
"sales_order": "sales_order_example",
"so_detail": "so_detail_example",
"delivery_note": "delivery_note_example",
"dn_detail": "dn_detail_example",
"delivered_qty": 0,
"cost_center": "cost_center_example",
"page_break": false,
"project": "project_example",
"pos_invoice_item": "pos_invoice_item_example",
"grant_commission": false,
"has_item_scanned": false,
"serial_and_batch_bundle": "serial_and_batch_bundle_example",
"use_serial_batch_fields": false,
"distributed_discount_amount": 0
} GET
/api/accounts/p-o-s-invoice-item?parent_id={id} List pos invoice items by parent
Returns all pos invoice items belonging to the specified parent.
Query parameters
parent_id string required
The ID of the parent to list children for.
Returns
A list of pos invoice item objects belonging to the parent.
GET /api/accounts/p-o-s-invoice-item?parent_id={id}
curl https://api.overplane.dev/api/accounts/p-o-s-invoice-item?parent_id=parent_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "p-o-s-invoice-item_abc123",
"idx": 1,
"pos_invoice_id": "pos_invoice_id_example",
"barcode": "barcode_example",
"item_code": "item_code_example",
"item_name": "item_name_example",
"customer_item_code": "customer_item_code_example",
"description": "description_example",
"item_group": "item_group_example",
"brand": "brand_example",
"image": "image_example",
"image_view": "image_view_example",
"qty": 0,
"stock_uom": "stock_uom_example",
"uom": "uom_example",
"conversion_factor": 0,
"stock_qty": 0,
"price_list_rate": 0,
"base_price_list_rate": 0,
"margin_type": "margin_type_example",
"margin_rate_or_amount": 0,
"rate_with_margin": 0,
"discount_percentage": 0,
"discount_amount": 0,
"base_rate_with_margin": 0,
"rate": 0,
"amount": 0,
"item_tax_template": "item_tax_template_example",
"base_rate": 0,
"base_amount": 0,
"pricing_rules": "pricing_rules_example",
"is_free_item": false,
"net_rate": 0,
"net_amount": 0,
"base_net_rate": 0,
"base_net_amount": 0,
"delivered_by_supplier": false,
"income_account": "income_account_example",
"is_fixed_asset": false,
"asset": "asset_example",
"finance_book": "finance_book_example",
"expense_account": "expense_account_example",
"deferred_revenue_account": "deferred_revenue_account_example",
"service_stop_date": "2024-01-15",
"enable_deferred_revenue": false,
"service_start_date": "2024-01-15",
"service_end_date": "2024-01-15",
"weight_per_unit": 0,
"total_weight": 0,
"weight_uom": "weight_uom_example",
"warehouse": "warehouse_example",
"target_warehouse": "target_warehouse_example",
"quality_inspection": "quality_inspection_example",
"batch_no": "batch_no_example",
"allow_zero_valuation_rate": false,
"serial_no": "serial_no_example",
"item_tax_rate": "item_tax_rate_example",
"actual_batch_qty": 0,
"actual_qty": 0,
"sales_order": "sales_order_example",
"so_detail": "so_detail_example",
"delivery_note": "delivery_note_example",
"dn_detail": "dn_detail_example",
"delivered_qty": 0,
"cost_center": "cost_center_example",
"page_break": false,
"project": "project_example",
"pos_invoice_item": "pos_invoice_item_example",
"grant_commission": false,
"has_item_scanned": false,
"serial_and_batch_bundle": "serial_and_batch_bundle_example",
"use_serial_batch_fields": false,
"distributed_discount_amount": 0
}
],
"has_more": false,
"total": 1
} POST
/api/accounts/p-o-s-invoice-item Create a pos invoice item
Creates a new pos invoice item object.
Body parameters
idx integer
pos_invoice_id string required
barcode string
item_code string
item_name string required
customer_item_code string
description string
item_group string
brand string
image string
image_view string
qty number
stock_uom string
uom string required
conversion_factor number required
stock_qty number
price_list_rate number
base_price_list_rate number
margin_type string
margin_rate_or_amount number
rate_with_margin number
discount_percentage number
discount_amount number
base_rate_with_margin number
rate number required
amount number required
item_tax_template string
base_rate number required
base_amount number required
pricing_rules string
is_free_item boolean
Default: false
net_rate number
net_amount number
base_net_rate number
base_net_amount number
delivered_by_supplier boolean
Default: false
income_account string required
is_fixed_asset boolean
Default: false
asset string
finance_book string
expense_account string
deferred_revenue_account string
service_stop_date string
enable_deferred_revenue boolean
Default: false
service_start_date string
service_end_date string
weight_per_unit number
total_weight number
weight_uom string
warehouse string
target_warehouse string
quality_inspection string
batch_no string
allow_zero_valuation_rate boolean
Default: false
serial_no string
item_tax_rate string
actual_batch_qty number
actual_qty number
sales_order string
so_detail string
delivery_note string
dn_detail string
delivered_qty number
cost_center string required
page_break boolean
Default: false
project string
pos_invoice_item string
grant_commission boolean
Default: false
has_item_scanned boolean
Default: false
serial_and_batch_bundle string
use_serial_batch_fields boolean
Default: false
distributed_discount_amount number
Returns
Returns the newly created pos invoice item object if the call succeeded.
POST /api/accounts/p-o-s-invoice-item
curl https://api.overplane.dev/api/accounts/p-o-s-invoice-item \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"pos_invoice_id":"pos_invoice_id_example","item_name":"item_name_example","uom":"uom_example","conversion_factor":0,"rate":0,"amount":0,"base_rate":0,"base_amount":0,"income_account":"income_account_example","cost_center":"cost_center_example"}' Response
{
"id": "p-o-s-invoice-item_abc123",
"idx": 1,
"pos_invoice_id": "pos_invoice_id_example",
"barcode": "barcode_example",
"item_code": "item_code_example",
"item_name": "item_name_example",
"customer_item_code": "customer_item_code_example",
"description": "description_example",
"item_group": "item_group_example",
"brand": "brand_example",
"image": "image_example",
"image_view": "image_view_example",
"qty": 0,
"stock_uom": "stock_uom_example",
"uom": "uom_example",
"conversion_factor": 0,
"stock_qty": 0,
"price_list_rate": 0,
"base_price_list_rate": 0,
"margin_type": "margin_type_example",
"margin_rate_or_amount": 0,
"rate_with_margin": 0,
"discount_percentage": 0,
"discount_amount": 0,
"base_rate_with_margin": 0,
"rate": 0,
"amount": 0,
"item_tax_template": "item_tax_template_example",
"base_rate": 0,
"base_amount": 0,
"pricing_rules": "pricing_rules_example",
"is_free_item": false,
"net_rate": 0,
"net_amount": 0,
"base_net_rate": 0,
"base_net_amount": 0,
"delivered_by_supplier": false,
"income_account": "income_account_example",
"is_fixed_asset": false,
"asset": "asset_example",
"finance_book": "finance_book_example",
"expense_account": "expense_account_example",
"deferred_revenue_account": "deferred_revenue_account_example",
"service_stop_date": "2024-01-15",
"enable_deferred_revenue": false,
"service_start_date": "2024-01-15",
"service_end_date": "2024-01-15",
"weight_per_unit": 0,
"total_weight": 0,
"weight_uom": "weight_uom_example",
"warehouse": "warehouse_example",
"target_warehouse": "target_warehouse_example",
"quality_inspection": "quality_inspection_example",
"batch_no": "batch_no_example",
"allow_zero_valuation_rate": false,
"serial_no": "serial_no_example",
"item_tax_rate": "item_tax_rate_example",
"actual_batch_qty": 0,
"actual_qty": 0,
"sales_order": "sales_order_example",
"so_detail": "so_detail_example",
"delivery_note": "delivery_note_example",
"dn_detail": "dn_detail_example",
"delivered_qty": 0,
"cost_center": "cost_center_example",
"page_break": false,
"project": "project_example",
"pos_invoice_item": "pos_invoice_item_example",
"grant_commission": false,
"has_item_scanned": false,
"serial_and_batch_bundle": "serial_and_batch_bundle_example",
"use_serial_batch_fields": false,
"distributed_discount_amount": 0
} PATCH
/api/accounts/p-o-s-invoice-item/{id} Update a pos invoice item
Updates the specified pos invoice item 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 pos invoice item to update.
Body parameters
idx integer
pos_invoice_id string
barcode string
item_code string
item_name string
customer_item_code string
description string
item_group string
brand string
image string
image_view string
qty number
stock_uom string
uom string
conversion_factor number
stock_qty number
price_list_rate number
base_price_list_rate number
margin_type string
margin_rate_or_amount number
rate_with_margin number
discount_percentage number
discount_amount number
base_rate_with_margin number
rate number
amount number
item_tax_template string
base_rate number
base_amount number
pricing_rules string
is_free_item boolean
Default: false
net_rate number
net_amount number
base_net_rate number
base_net_amount number
delivered_by_supplier boolean
Default: false
income_account string
is_fixed_asset boolean
Default: false
asset string
finance_book string
expense_account string
deferred_revenue_account string
service_stop_date string
enable_deferred_revenue boolean
Default: false
service_start_date string
service_end_date string
weight_per_unit number
total_weight number
weight_uom string
warehouse string
target_warehouse string
quality_inspection string
batch_no string
allow_zero_valuation_rate boolean
Default: false
serial_no string
item_tax_rate string
actual_batch_qty number
actual_qty number
sales_order string
so_detail string
delivery_note string
dn_detail string
delivered_qty number
cost_center string
page_break boolean
Default: false
project string
pos_invoice_item string
grant_commission boolean
Default: false
has_item_scanned boolean
Default: false
serial_and_batch_bundle string
use_serial_batch_fields boolean
Default: false
distributed_discount_amount number
Returns
Returns the updated pos invoice item object.
PATCH /api/accounts/p-o-s-invoice-item/{id}
curl https://api.overplane.dev/api/accounts/p-o-s-invoice-item/p-o-s-invoice-item_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"idx":1,"pos_invoice_id":"pos_invoice_id_example"}' Response
{
"id": "p-o-s-invoice-item_abc123",
"idx": 1,
"pos_invoice_id": "pos_invoice_id_example",
"barcode": "barcode_example",
"item_code": "item_code_example",
"item_name": "item_name_example",
"customer_item_code": "customer_item_code_example",
"description": "description_example",
"item_group": "item_group_example",
"brand": "brand_example",
"image": "image_example",
"image_view": "image_view_example",
"qty": 0,
"stock_uom": "stock_uom_example",
"uom": "uom_example",
"conversion_factor": 0,
"stock_qty": 0,
"price_list_rate": 0,
"base_price_list_rate": 0,
"margin_type": "margin_type_example",
"margin_rate_or_amount": 0,
"rate_with_margin": 0,
"discount_percentage": 0,
"discount_amount": 0,
"base_rate_with_margin": 0,
"rate": 0,
"amount": 0,
"item_tax_template": "item_tax_template_example",
"base_rate": 0,
"base_amount": 0,
"pricing_rules": "pricing_rules_example",
"is_free_item": false,
"net_rate": 0,
"net_amount": 0,
"base_net_rate": 0,
"base_net_amount": 0,
"delivered_by_supplier": false,
"income_account": "income_account_example",
"is_fixed_asset": false,
"asset": "asset_example",
"finance_book": "finance_book_example",
"expense_account": "expense_account_example",
"deferred_revenue_account": "deferred_revenue_account_example",
"service_stop_date": "2024-01-15",
"enable_deferred_revenue": false,
"service_start_date": "2024-01-15",
"service_end_date": "2024-01-15",
"weight_per_unit": 0,
"total_weight": 0,
"weight_uom": "weight_uom_example",
"warehouse": "warehouse_example",
"target_warehouse": "target_warehouse_example",
"quality_inspection": "quality_inspection_example",
"batch_no": "batch_no_example",
"allow_zero_valuation_rate": false,
"serial_no": "serial_no_example",
"item_tax_rate": "item_tax_rate_example",
"actual_batch_qty": 0,
"actual_qty": 0,
"sales_order": "sales_order_example",
"so_detail": "so_detail_example",
"delivery_note": "delivery_note_example",
"dn_detail": "dn_detail_example",
"delivered_qty": 0,
"cost_center": "cost_center_example",
"page_break": false,
"project": "project_example",
"pos_invoice_item": "pos_invoice_item_example",
"grant_commission": false,
"has_item_scanned": false,
"serial_and_batch_bundle": "serial_and_batch_bundle_example",
"use_serial_batch_fields": false,
"distributed_discount_amount": 0
} DELETE
/api/accounts/p-o-s-invoice-item/{id} Delete a pos invoice item
Permanently deletes a pos invoice item. This cannot be undone.
Path parameters
id string required
The identifier of the pos invoice item to delete.
Returns
Returns a confirmation that the pos invoice item has been deleted.
DELETE /api/accounts/p-o-s-invoice-item/{id}
curl https://api.overplane.dev/api/accounts/p-o-s-invoice-item/p-o-s-invoice-item_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "p-o-s-invoice-item_abc123",
"deleted": true
} POST
/api/accounts/p-o-s-invoice-item/reorder Reorder pos invoice items
Updates the sort order of pos invoice items within their parent by setting new index values.
Returns
Returns the reordered list.
POST /api/accounts/p-o-s-invoice-item/reorder
curl https://api.overplane.dev/api/accounts/p-o-s-invoice-item/reorder \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "p-o-s-invoice-item_abc123",
"idx": 1,
"pos_invoice_id": "pos_invoice_id_example",
"barcode": "barcode_example",
"item_code": "item_code_example",
"item_name": "item_name_example",
"customer_item_code": "customer_item_code_example",
"description": "description_example",
"item_group": "item_group_example",
"brand": "brand_example",
"image": "image_example",
"image_view": "image_view_example",
"qty": 0,
"stock_uom": "stock_uom_example",
"uom": "uom_example",
"conversion_factor": 0,
"stock_qty": 0,
"price_list_rate": 0,
"base_price_list_rate": 0,
"margin_type": "margin_type_example",
"margin_rate_or_amount": 0,
"rate_with_margin": 0,
"discount_percentage": 0,
"discount_amount": 0,
"base_rate_with_margin": 0,
"rate": 0,
"amount": 0,
"item_tax_template": "item_tax_template_example",
"base_rate": 0,
"base_amount": 0,
"pricing_rules": "pricing_rules_example",
"is_free_item": false,
"net_rate": 0,
"net_amount": 0,
"base_net_rate": 0,
"base_net_amount": 0,
"delivered_by_supplier": false,
"income_account": "income_account_example",
"is_fixed_asset": false,
"asset": "asset_example",
"finance_book": "finance_book_example",
"expense_account": "expense_account_example",
"deferred_revenue_account": "deferred_revenue_account_example",
"service_stop_date": "2024-01-15",
"enable_deferred_revenue": false,
"service_start_date": "2024-01-15",
"service_end_date": "2024-01-15",
"weight_per_unit": 0,
"total_weight": 0,
"weight_uom": "weight_uom_example",
"warehouse": "warehouse_example",
"target_warehouse": "target_warehouse_example",
"quality_inspection": "quality_inspection_example",
"batch_no": "batch_no_example",
"allow_zero_valuation_rate": false,
"serial_no": "serial_no_example",
"item_tax_rate": "item_tax_rate_example",
"actual_batch_qty": 0,
"actual_qty": 0,
"sales_order": "sales_order_example",
"so_detail": "so_detail_example",
"delivery_note": "delivery_note_example",
"dn_detail": "dn_detail_example",
"delivered_qty": 0,
"cost_center": "cost_center_example",
"page_break": false,
"project": "project_example",
"pos_invoice_item": "pos_invoice_item_example",
"grant_commission": false,
"has_item_scanned": false,
"serial_and_batch_bundle": "serial_and_batch_bundle_example",
"use_serial_batch_fields": false,
"distributed_discount_amount": 0
}