The POS Invoice 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
customer string
customer_name string
tax_id string
is_pos boolean
Default: true
pos_profile string
is_return boolean
Default: false
company string required
posting_date string required
posting_time string
set_posting_time boolean
Default: false
due_date string
return_against string
update_billed_amount_in_sales_order boolean
Default: false
project string
cost_center string
po_no string
po_date string
customer_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
territory string
shipping_address_name string
shipping_address string
company_address string
company_address_display string
currency string required
conversion_rate number required
selling_price_list string required
price_list_currency string required
plc_conversion_rate number required
ignore_pricing_rule boolean
Default: false
set_warehouse string
update_stock boolean
Default: false
scan_barcode string
total_billing_amount number
Default: 0
total_qty number
base_total number
base_net_total number required
total number
net_total number
total_net_weight number
taxes_and_charges string
shipping_rule string
tax_category string
other_charges_calculation string
base_total_taxes_and_charges number
total_taxes_and_charges number
loyalty_points integer
loyalty_amount number
redeem_loyalty_points boolean
Default: false
loyalty_program string
loyalty_redemption_account string
loyalty_redemption_cost_center string
apply_discount_on string
Default: Grand Total
base_discount_amount number
additional_discount_percentage number
discount_amount number
base_grand_total number required
base_rounding_adjustment number
base_rounded_total number
base_in_words string
grand_total number required
rounding_adjustment number
rounded_total number
in_words string
total_advance number
outstanding_amount number
allocate_advances_automatically boolean
Default: false
payment_terms_template string
cash_bank_account string
base_paid_amount number
paid_amount number
base_change_amount number
change_amount number
account_for_change_amount string
write_off_amount number
base_write_off_amount number
write_off_outstanding_amount_automatically boolean
Default: false
write_off_account string
write_off_cost_center string
tc_name string
terms string
letter_head string
group_same_items boolean
Default: false
language string
select_print_heading string
inter_company_invoice_reference string
customer_group string
is_discounted boolean
Default: false
debit_to string required
party_account_currency string
is_opening string
Default: No
remarks string
sales_partner string
commission_rate number
total_commission number
from_date string
to_date string
auto_repeat string
against_income_account string
consolidated_invoice string
coupon_code string
amount_eligible_for_commission number
update_billed_amount_in_delivery_note boolean
Default: true
utm_medium string
utm_campaign string
utm_source string
company_contact_person string
title string
The POS Invoice object
{
"id": "p-o-s-invoice_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"customer": "customer_example",
"customer_name": "customer_name_example",
"tax_id": "tax_id_example",
"is_pos": true,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"due_date": "2024-01-15",
"return_against": "return_against_example",
"update_billed_amount_in_sales_order": false,
"project": "project_example",
"cost_center": "cost_center_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"customer_address": "customer_address_example",
"address_display": "address_display_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"territory": "territory_example",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"currency": "USD",
"conversion_rate": 0,
"selling_price_list": "selling_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"update_stock": false,
"scan_barcode": "scan_barcode_example",
"total_billing_amount": 0,
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"tax_category": "tax_category_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_total_taxes_and_charges": 0,
"total_taxes_and_charges": 0,
"loyalty_points": 0,
"loyalty_amount": 0,
"redeem_loyalty_points": false,
"loyalty_program": "loyalty_program_example",
"loyalty_redemption_account": "loyalty_redemption_account_example",
"loyalty_redemption_cost_center": "loyalty_redemption_cost_center_example",
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_rounded_total": 0,
"base_in_words": "base_in_words_example",
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"total_advance": 0,
"outstanding_amount": 0,
"allocate_advances_automatically": false,
"payment_terms_template": "payment_terms_template_example",
"cash_bank_account": "cash_bank_account_example",
"base_paid_amount": 0,
"paid_amount": 0,
"base_change_amount": 0,
"change_amount": 0,
"account_for_change_amount": "account_for_change_amount_example",
"write_off_amount": 0,
"base_write_off_amount": 0,
"write_off_outstanding_amount_automatically": false,
"write_off_account": "write_off_account_example",
"write_off_cost_center": "write_off_cost_center_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"language": "language_example",
"select_print_heading": "select_print_heading_example",
"inter_company_invoice_reference": "Example Corp",
"customer_group": "customer_group_example",
"is_discounted": false,
"debit_to": "debit_to_example",
"party_account_currency": "USD",
"is_opening": "No",
"remarks": "remarks_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"against_income_account": "against_income_account_example",
"consolidated_invoice": "2024-01-15",
"coupon_code": "coupon_code_example",
"amount_eligible_for_commission": 0,
"update_billed_amount_in_delivery_note": true,
"utm_medium": "utm_medium_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"title": "title_example"
} GET
/api/accounts/p-o-s-invoice/{id} Retrieve a pos invoice
Retrieves the details of an existing pos invoice. Supply the unique pos invoice ID that was returned from a previous request.
Path parameters
id string required
The identifier of the pos invoice to retrieve.
Returns
Returns the pos invoice object if a valid identifier was provided.
GET /api/accounts/p-o-s-invoice/{id}
curl https://api.overplane.dev/api/accounts/p-o-s-invoice/p-o-s-invoice_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "p-o-s-invoice_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"customer": "customer_example",
"customer_name": "customer_name_example",
"tax_id": "tax_id_example",
"is_pos": true,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"due_date": "2024-01-15",
"return_against": "return_against_example",
"update_billed_amount_in_sales_order": false,
"project": "project_example",
"cost_center": "cost_center_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"customer_address": "customer_address_example",
"address_display": "address_display_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"territory": "territory_example",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"currency": "USD",
"conversion_rate": 0,
"selling_price_list": "selling_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"update_stock": false,
"scan_barcode": "scan_barcode_example",
"total_billing_amount": 0,
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"tax_category": "tax_category_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_total_taxes_and_charges": 0,
"total_taxes_and_charges": 0,
"loyalty_points": 0,
"loyalty_amount": 0,
"redeem_loyalty_points": false,
"loyalty_program": "loyalty_program_example",
"loyalty_redemption_account": "loyalty_redemption_account_example",
"loyalty_redemption_cost_center": "loyalty_redemption_cost_center_example",
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_rounded_total": 0,
"base_in_words": "base_in_words_example",
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"total_advance": 0,
"outstanding_amount": 0,
"allocate_advances_automatically": false,
"payment_terms_template": "payment_terms_template_example",
"cash_bank_account": "cash_bank_account_example",
"base_paid_amount": 0,
"paid_amount": 0,
"base_change_amount": 0,
"change_amount": 0,
"account_for_change_amount": "account_for_change_amount_example",
"write_off_amount": 0,
"base_write_off_amount": 0,
"write_off_outstanding_amount_automatically": false,
"write_off_account": "write_off_account_example",
"write_off_cost_center": "write_off_cost_center_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"language": "language_example",
"select_print_heading": "select_print_heading_example",
"inter_company_invoice_reference": "Example Corp",
"customer_group": "customer_group_example",
"is_discounted": false,
"debit_to": "debit_to_example",
"party_account_currency": "USD",
"is_opening": "No",
"remarks": "remarks_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"against_income_account": "against_income_account_example",
"consolidated_invoice": "2024-01-15",
"coupon_code": "coupon_code_example",
"amount_eligible_for_commission": 0,
"update_billed_amount_in_delivery_note": true,
"utm_medium": "utm_medium_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"title": "title_example"
} GET
/api/accounts/p-o-s-invoice List all pos invoices
Returns a list of pos invoices. 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 pos invoice objects.
GET /api/accounts/p-o-s-invoice
curl https://api.overplane.dev/api/accounts/p-o-s-invoice \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "p-o-s-invoice_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"customer": "customer_example",
"customer_name": "customer_name_example",
"tax_id": "tax_id_example",
"is_pos": true,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"due_date": "2024-01-15",
"return_against": "return_against_example",
"update_billed_amount_in_sales_order": false,
"project": "project_example",
"cost_center": "cost_center_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"customer_address": "customer_address_example",
"address_display": "address_display_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"territory": "territory_example",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"currency": "USD",
"conversion_rate": 0,
"selling_price_list": "selling_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"update_stock": false,
"scan_barcode": "scan_barcode_example",
"total_billing_amount": 0,
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"tax_category": "tax_category_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_total_taxes_and_charges": 0,
"total_taxes_and_charges": 0,
"loyalty_points": 0,
"loyalty_amount": 0,
"redeem_loyalty_points": false,
"loyalty_program": "loyalty_program_example",
"loyalty_redemption_account": "loyalty_redemption_account_example",
"loyalty_redemption_cost_center": "loyalty_redemption_cost_center_example",
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_rounded_total": 0,
"base_in_words": "base_in_words_example",
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"total_advance": 0,
"outstanding_amount": 0,
"allocate_advances_automatically": false,
"payment_terms_template": "payment_terms_template_example",
"cash_bank_account": "cash_bank_account_example",
"base_paid_amount": 0,
"paid_amount": 0,
"base_change_amount": 0,
"change_amount": 0,
"account_for_change_amount": "account_for_change_amount_example",
"write_off_amount": 0,
"base_write_off_amount": 0,
"write_off_outstanding_amount_automatically": false,
"write_off_account": "write_off_account_example",
"write_off_cost_center": "write_off_cost_center_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"language": "language_example",
"select_print_heading": "select_print_heading_example",
"inter_company_invoice_reference": "Example Corp",
"customer_group": "customer_group_example",
"is_discounted": false,
"debit_to": "debit_to_example",
"party_account_currency": "USD",
"is_opening": "No",
"remarks": "remarks_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"against_income_account": "against_income_account_example",
"consolidated_invoice": "2024-01-15",
"coupon_code": "coupon_code_example",
"amount_eligible_for_commission": 0,
"update_billed_amount_in_delivery_note": true,
"utm_medium": "utm_medium_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"title": "title_example"
}
],
"has_more": false,
"total": 1
} POST
/api/accounts/p-o-s-invoice Create a pos invoice
Creates a new pos invoice object.
Body parameters
status string
Default: draft
customer string
customer_name string
tax_id string
is_pos boolean
Default: true
pos_profile string
is_return boolean
Default: false
company string required
posting_date string required
posting_time string
set_posting_time boolean
Default: false
due_date string
return_against string
update_billed_amount_in_sales_order boolean
Default: false
project string
cost_center string
po_no string
po_date string
customer_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
territory string
shipping_address_name string
shipping_address string
company_address string
company_address_display string
currency string required
conversion_rate number required
selling_price_list string required
price_list_currency string required
plc_conversion_rate number required
ignore_pricing_rule boolean
Default: false
set_warehouse string
update_stock boolean
Default: false
scan_barcode string
total_billing_amount number
Default: 0
total_qty number
base_total number
base_net_total number required
total number
net_total number
total_net_weight number
taxes_and_charges string
shipping_rule string
tax_category string
other_charges_calculation string
base_total_taxes_and_charges number
total_taxes_and_charges number
loyalty_points integer
loyalty_amount number
redeem_loyalty_points boolean
Default: false
loyalty_program string
loyalty_redemption_account string
loyalty_redemption_cost_center string
apply_discount_on string
Default: Grand Total
base_discount_amount number
additional_discount_percentage number
discount_amount number
base_grand_total number required
base_rounding_adjustment number
base_rounded_total number
base_in_words string
grand_total number required
rounding_adjustment number
rounded_total number
in_words string
total_advance number
outstanding_amount number
allocate_advances_automatically boolean
Default: false
payment_terms_template string
cash_bank_account string
base_paid_amount number
paid_amount number
base_change_amount number
change_amount number
account_for_change_amount string
write_off_amount number
base_write_off_amount number
write_off_outstanding_amount_automatically boolean
Default: false
write_off_account string
write_off_cost_center string
tc_name string
terms string
letter_head string
group_same_items boolean
Default: false
language string
select_print_heading string
inter_company_invoice_reference string
customer_group string
is_discounted boolean
Default: false
debit_to string required
party_account_currency string
is_opening string
Default: No
remarks string
sales_partner string
commission_rate number
total_commission number
from_date string
to_date string
auto_repeat string
against_income_account string
consolidated_invoice string
coupon_code string
amount_eligible_for_commission number
update_billed_amount_in_delivery_note boolean
Default: true
utm_medium string
utm_campaign string
utm_source string
company_contact_person string
title string
Returns
Returns the newly created pos invoice object if the call succeeded.
POST /api/accounts/p-o-s-invoice
curl https://api.overplane.dev/api/accounts/p-o-s-invoice \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"company":"Example Corp","posting_date":"2024-01-15","currency":"USD","conversion_rate":0,"selling_price_list":"selling_price_list_example","price_list_currency":"USD","plc_conversion_rate":0,"base_net_total":0,"base_grand_total":0,"grand_total":0,"debit_to":"debit_to_example"}' Response
{
"id": "p-o-s-invoice_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"customer": "customer_example",
"customer_name": "customer_name_example",
"tax_id": "tax_id_example",
"is_pos": true,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"due_date": "2024-01-15",
"return_against": "return_against_example",
"update_billed_amount_in_sales_order": false,
"project": "project_example",
"cost_center": "cost_center_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"customer_address": "customer_address_example",
"address_display": "address_display_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"territory": "territory_example",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"currency": "USD",
"conversion_rate": 0,
"selling_price_list": "selling_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"update_stock": false,
"scan_barcode": "scan_barcode_example",
"total_billing_amount": 0,
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"tax_category": "tax_category_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_total_taxes_and_charges": 0,
"total_taxes_and_charges": 0,
"loyalty_points": 0,
"loyalty_amount": 0,
"redeem_loyalty_points": false,
"loyalty_program": "loyalty_program_example",
"loyalty_redemption_account": "loyalty_redemption_account_example",
"loyalty_redemption_cost_center": "loyalty_redemption_cost_center_example",
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_rounded_total": 0,
"base_in_words": "base_in_words_example",
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"total_advance": 0,
"outstanding_amount": 0,
"allocate_advances_automatically": false,
"payment_terms_template": "payment_terms_template_example",
"cash_bank_account": "cash_bank_account_example",
"base_paid_amount": 0,
"paid_amount": 0,
"base_change_amount": 0,
"change_amount": 0,
"account_for_change_amount": "account_for_change_amount_example",
"write_off_amount": 0,
"base_write_off_amount": 0,
"write_off_outstanding_amount_automatically": false,
"write_off_account": "write_off_account_example",
"write_off_cost_center": "write_off_cost_center_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"language": "language_example",
"select_print_heading": "select_print_heading_example",
"inter_company_invoice_reference": "Example Corp",
"customer_group": "customer_group_example",
"is_discounted": false,
"debit_to": "debit_to_example",
"party_account_currency": "USD",
"is_opening": "No",
"remarks": "remarks_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"against_income_account": "against_income_account_example",
"consolidated_invoice": "2024-01-15",
"coupon_code": "coupon_code_example",
"amount_eligible_for_commission": 0,
"update_billed_amount_in_delivery_note": true,
"utm_medium": "utm_medium_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"title": "title_example"
} PATCH
/api/accounts/p-o-s-invoice/{id} Update a pos invoice
Updates the specified pos invoice 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 to update.
Body parameters
status string
Default: draft
customer string
customer_name string
tax_id string
is_pos boolean
Default: true
pos_profile string
is_return boolean
Default: false
company string
posting_date string
posting_time string
set_posting_time boolean
Default: false
due_date string
return_against string
update_billed_amount_in_sales_order boolean
Default: false
project string
cost_center string
po_no string
po_date string
customer_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
territory string
shipping_address_name string
shipping_address string
company_address string
company_address_display string
currency string
conversion_rate number
selling_price_list string
price_list_currency string
plc_conversion_rate number
ignore_pricing_rule boolean
Default: false
set_warehouse string
update_stock boolean
Default: false
scan_barcode string
total_billing_amount number
Default: 0
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
taxes_and_charges string
shipping_rule string
tax_category string
other_charges_calculation string
base_total_taxes_and_charges number
total_taxes_and_charges number
loyalty_points integer
loyalty_amount number
redeem_loyalty_points boolean
Default: false
loyalty_program string
loyalty_redemption_account string
loyalty_redemption_cost_center string
apply_discount_on string
Default: Grand Total
base_discount_amount number
additional_discount_percentage number
discount_amount number
base_grand_total number
base_rounding_adjustment number
base_rounded_total number
base_in_words string
grand_total number
rounding_adjustment number
rounded_total number
in_words string
total_advance number
outstanding_amount number
allocate_advances_automatically boolean
Default: false
payment_terms_template string
cash_bank_account string
base_paid_amount number
paid_amount number
base_change_amount number
change_amount number
account_for_change_amount string
write_off_amount number
base_write_off_amount number
write_off_outstanding_amount_automatically boolean
Default: false
write_off_account string
write_off_cost_center string
tc_name string
terms string
letter_head string
group_same_items boolean
Default: false
language string
select_print_heading string
inter_company_invoice_reference string
customer_group string
is_discounted boolean
Default: false
debit_to string
party_account_currency string
is_opening string
Default: No
remarks string
sales_partner string
commission_rate number
total_commission number
from_date string
to_date string
auto_repeat string
against_income_account string
consolidated_invoice string
coupon_code string
amount_eligible_for_commission number
update_billed_amount_in_delivery_note boolean
Default: true
utm_medium string
utm_campaign string
utm_source string
company_contact_person string
title string
Returns
Returns the updated pos invoice object.
PATCH /api/accounts/p-o-s-invoice/{id}
curl https://api.overplane.dev/api/accounts/p-o-s-invoice/p-o-s-invoice_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"status":"draft","customer":"customer_example"}' Response
{
"id": "p-o-s-invoice_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"customer": "customer_example",
"customer_name": "customer_name_example",
"tax_id": "tax_id_example",
"is_pos": true,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"due_date": "2024-01-15",
"return_against": "return_against_example",
"update_billed_amount_in_sales_order": false,
"project": "project_example",
"cost_center": "cost_center_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"customer_address": "customer_address_example",
"address_display": "address_display_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"territory": "territory_example",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"currency": "USD",
"conversion_rate": 0,
"selling_price_list": "selling_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"update_stock": false,
"scan_barcode": "scan_barcode_example",
"total_billing_amount": 0,
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"tax_category": "tax_category_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_total_taxes_and_charges": 0,
"total_taxes_and_charges": 0,
"loyalty_points": 0,
"loyalty_amount": 0,
"redeem_loyalty_points": false,
"loyalty_program": "loyalty_program_example",
"loyalty_redemption_account": "loyalty_redemption_account_example",
"loyalty_redemption_cost_center": "loyalty_redemption_cost_center_example",
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_rounded_total": 0,
"base_in_words": "base_in_words_example",
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"total_advance": 0,
"outstanding_amount": 0,
"allocate_advances_automatically": false,
"payment_terms_template": "payment_terms_template_example",
"cash_bank_account": "cash_bank_account_example",
"base_paid_amount": 0,
"paid_amount": 0,
"base_change_amount": 0,
"change_amount": 0,
"account_for_change_amount": "account_for_change_amount_example",
"write_off_amount": 0,
"base_write_off_amount": 0,
"write_off_outstanding_amount_automatically": false,
"write_off_account": "write_off_account_example",
"write_off_cost_center": "write_off_cost_center_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"language": "language_example",
"select_print_heading": "select_print_heading_example",
"inter_company_invoice_reference": "Example Corp",
"customer_group": "customer_group_example",
"is_discounted": false,
"debit_to": "debit_to_example",
"party_account_currency": "USD",
"is_opening": "No",
"remarks": "remarks_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"against_income_account": "against_income_account_example",
"consolidated_invoice": "2024-01-15",
"coupon_code": "coupon_code_example",
"amount_eligible_for_commission": 0,
"update_billed_amount_in_delivery_note": true,
"utm_medium": "utm_medium_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"title": "title_example"
} DELETE
/api/accounts/p-o-s-invoice/{id} Delete a pos invoice
Permanently deletes a pos invoice. This cannot be undone.
Path parameters
id string required
The identifier of the pos invoice to delete.
Returns
Returns a confirmation that the pos invoice has been deleted.
DELETE /api/accounts/p-o-s-invoice/{id}
curl https://api.overplane.dev/api/accounts/p-o-s-invoice/p-o-s-invoice_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "p-o-s-invoice_abc123",
"deleted": true
} POST
/api/accounts/p-o-s-invoice/{id}/submit Submit a pos invoice
Submits a draft pos invoice, transitioning its status from draft to submitted.
Path parameters
id string required
The identifier of the pos invoice to act on.
Returns
Returns the pos invoice object with updated status.
POST /api/accounts/p-o-s-invoice/{id}/submit
curl https://api.overplane.dev/api/accounts/p-o-s-invoice/p-o-s-invoice_abc123/submit \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "p-o-s-invoice_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"customer": "customer_example",
"customer_name": "customer_name_example",
"tax_id": "tax_id_example",
"is_pos": true,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"due_date": "2024-01-15",
"return_against": "return_against_example",
"update_billed_amount_in_sales_order": false,
"project": "project_example",
"cost_center": "cost_center_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"customer_address": "customer_address_example",
"address_display": "address_display_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"territory": "territory_example",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"currency": "USD",
"conversion_rate": 0,
"selling_price_list": "selling_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"update_stock": false,
"scan_barcode": "scan_barcode_example",
"total_billing_amount": 0,
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"tax_category": "tax_category_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_total_taxes_and_charges": 0,
"total_taxes_and_charges": 0,
"loyalty_points": 0,
"loyalty_amount": 0,
"redeem_loyalty_points": false,
"loyalty_program": "loyalty_program_example",
"loyalty_redemption_account": "loyalty_redemption_account_example",
"loyalty_redemption_cost_center": "loyalty_redemption_cost_center_example",
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_rounded_total": 0,
"base_in_words": "base_in_words_example",
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"total_advance": 0,
"outstanding_amount": 0,
"allocate_advances_automatically": false,
"payment_terms_template": "payment_terms_template_example",
"cash_bank_account": "cash_bank_account_example",
"base_paid_amount": 0,
"paid_amount": 0,
"base_change_amount": 0,
"change_amount": 0,
"account_for_change_amount": "account_for_change_amount_example",
"write_off_amount": 0,
"base_write_off_amount": 0,
"write_off_outstanding_amount_automatically": false,
"write_off_account": "write_off_account_example",
"write_off_cost_center": "write_off_cost_center_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"language": "language_example",
"select_print_heading": "select_print_heading_example",
"inter_company_invoice_reference": "Example Corp",
"customer_group": "customer_group_example",
"is_discounted": false,
"debit_to": "debit_to_example",
"party_account_currency": "USD",
"is_opening": "No",
"remarks": "remarks_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"against_income_account": "against_income_account_example",
"consolidated_invoice": "2024-01-15",
"coupon_code": "coupon_code_example",
"amount_eligible_for_commission": 0,
"update_billed_amount_in_delivery_note": true,
"utm_medium": "utm_medium_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"title": "title_example"
} POST
/api/accounts/p-o-s-invoice/{id}/cancel Cancel a pos invoice
Cancels a submitted pos invoice, transitioning its status to cancelled.
Path parameters
id string required
The identifier of the pos invoice to act on.
Returns
Returns the pos invoice object with updated status.
POST /api/accounts/p-o-s-invoice/{id}/cancel
curl https://api.overplane.dev/api/accounts/p-o-s-invoice/p-o-s-invoice_abc123/cancel \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "p-o-s-invoice_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"customer": "customer_example",
"customer_name": "customer_name_example",
"tax_id": "tax_id_example",
"is_pos": true,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"due_date": "2024-01-15",
"return_against": "return_against_example",
"update_billed_amount_in_sales_order": false,
"project": "project_example",
"cost_center": "cost_center_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"customer_address": "customer_address_example",
"address_display": "address_display_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"territory": "territory_example",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"currency": "USD",
"conversion_rate": 0,
"selling_price_list": "selling_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"update_stock": false,
"scan_barcode": "scan_barcode_example",
"total_billing_amount": 0,
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"tax_category": "tax_category_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_total_taxes_and_charges": 0,
"total_taxes_and_charges": 0,
"loyalty_points": 0,
"loyalty_amount": 0,
"redeem_loyalty_points": false,
"loyalty_program": "loyalty_program_example",
"loyalty_redemption_account": "loyalty_redemption_account_example",
"loyalty_redemption_cost_center": "loyalty_redemption_cost_center_example",
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_rounded_total": 0,
"base_in_words": "base_in_words_example",
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"total_advance": 0,
"outstanding_amount": 0,
"allocate_advances_automatically": false,
"payment_terms_template": "payment_terms_template_example",
"cash_bank_account": "cash_bank_account_example",
"base_paid_amount": 0,
"paid_amount": 0,
"base_change_amount": 0,
"change_amount": 0,
"account_for_change_amount": "account_for_change_amount_example",
"write_off_amount": 0,
"base_write_off_amount": 0,
"write_off_outstanding_amount_automatically": false,
"write_off_account": "write_off_account_example",
"write_off_cost_center": "write_off_cost_center_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"language": "language_example",
"select_print_heading": "select_print_heading_example",
"inter_company_invoice_reference": "Example Corp",
"customer_group": "customer_group_example",
"is_discounted": false,
"debit_to": "debit_to_example",
"party_account_currency": "USD",
"is_opening": "No",
"remarks": "remarks_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"against_income_account": "against_income_account_example",
"consolidated_invoice": "2024-01-15",
"coupon_code": "coupon_code_example",
"amount_eligible_for_commission": 0,
"update_billed_amount_in_delivery_note": true,
"utm_medium": "utm_medium_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"title": "title_example"
}