The Sales 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 required
customer_name string
tax_id string
project string
is_pos boolean
Default: false
pos_profile string
is_return boolean
Default: false
company string required
cost_center string
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
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
is_consolidated boolean
Default: false
is_internal_customer boolean
Default: false
company_tax_id string
unrealized_profit_loss_account string
represents_company string
set_target_warehouse string
is_debit_note boolean
Default: false
disable_rounded_total boolean
Default: false
additional_discount_account string
dispatch_address_name string
dispatch_address string
ignore_default_payment_terms_template boolean
Default: false
total_billing_hours number
amount_eligible_for_commission number
subscription string
is_cash_or_non_trade_discount boolean
Default: false
incoterm string
named_place string
only_include_allocated_payments boolean
Default: false
use_company_roundoff_cost_center boolean
Default: false
update_billed_amount_in_delivery_note boolean
Default: true
dont_create_loyalty_points boolean
Default: false
coupon_code string
update_outstanding_for_self boolean
Default: true
utm_medium string
utm_content string
utm_campaign string
utm_source string
company_contact_person string
is_created_using_pos boolean
Default: false
pos_closing_entry string
has_subcontracted boolean
Default: false
apply_tds boolean
Default: false
tax_withholding_group string
ignore_tax_withholding_threshold boolean
Default: false
override_tax_withholding_entries boolean
Default: false
title string
signing_document_id string
The Sales Invoice object
{
"id": "sales-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",
"project": "project_example",
"is_pos": false,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"cost_center": "cost_center_example",
"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,
"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": "[email protected]",
"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",
"is_consolidated": false,
"is_internal_customer": false,
"company_tax_id": "Example Corp",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"represents_company": "Example Corp",
"set_target_warehouse": "set_target_warehouse_example",
"is_debit_note": false,
"disable_rounded_total": false,
"additional_discount_account": "additional_discount_account_example",
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"ignore_default_payment_terms_template": false,
"total_billing_hours": 0,
"amount_eligible_for_commission": 0,
"subscription": "subscription_example",
"is_cash_or_non_trade_discount": false,
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"only_include_allocated_payments": false,
"use_company_roundoff_cost_center": false,
"update_billed_amount_in_delivery_note": true,
"dont_create_loyalty_points": false,
"coupon_code": "coupon_code_example",
"update_outstanding_for_self": true,
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"is_created_using_pos": false,
"pos_closing_entry": "pos_closing_entry_example",
"has_subcontracted": false,
"apply_tds": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false,
"title": "title_example",
"signing_document_id": "signing_document_id_example"
} GET
/api/accounts/sales-invoice/{id} Retrieve a sales invoice
Retrieves the details of an existing sales invoice. Supply the unique sales invoice ID that was returned from a previous request.
Path parameters
id string required
The identifier of the sales invoice to retrieve.
Returns
Returns the sales invoice object if a valid identifier was provided.
GET /api/accounts/sales-invoice/{id}
curl https://api.overplane.dev/api/accounts/sales-invoice/sales-invoice_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "sales-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",
"project": "project_example",
"is_pos": false,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"cost_center": "cost_center_example",
"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,
"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": "[email protected]",
"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",
"is_consolidated": false,
"is_internal_customer": false,
"company_tax_id": "Example Corp",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"represents_company": "Example Corp",
"set_target_warehouse": "set_target_warehouse_example",
"is_debit_note": false,
"disable_rounded_total": false,
"additional_discount_account": "additional_discount_account_example",
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"ignore_default_payment_terms_template": false,
"total_billing_hours": 0,
"amount_eligible_for_commission": 0,
"subscription": "subscription_example",
"is_cash_or_non_trade_discount": false,
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"only_include_allocated_payments": false,
"use_company_roundoff_cost_center": false,
"update_billed_amount_in_delivery_note": true,
"dont_create_loyalty_points": false,
"coupon_code": "coupon_code_example",
"update_outstanding_for_self": true,
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"is_created_using_pos": false,
"pos_closing_entry": "pos_closing_entry_example",
"has_subcontracted": false,
"apply_tds": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false,
"title": "title_example",
"signing_document_id": "signing_document_id_example"
} GET
/api/accounts/sales-invoice List all sales invoices
Returns a list of sales 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 sales invoice objects.
GET /api/accounts/sales-invoice
curl https://api.overplane.dev/api/accounts/sales-invoice \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "sales-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",
"project": "project_example",
"is_pos": false,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"cost_center": "cost_center_example",
"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,
"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": "[email protected]",
"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",
"is_consolidated": false,
"is_internal_customer": false,
"company_tax_id": "Example Corp",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"represents_company": "Example Corp",
"set_target_warehouse": "set_target_warehouse_example",
"is_debit_note": false,
"disable_rounded_total": false,
"additional_discount_account": "additional_discount_account_example",
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"ignore_default_payment_terms_template": false,
"total_billing_hours": 0,
"amount_eligible_for_commission": 0,
"subscription": "subscription_example",
"is_cash_or_non_trade_discount": false,
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"only_include_allocated_payments": false,
"use_company_roundoff_cost_center": false,
"update_billed_amount_in_delivery_note": true,
"dont_create_loyalty_points": false,
"coupon_code": "coupon_code_example",
"update_outstanding_for_self": true,
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"is_created_using_pos": false,
"pos_closing_entry": "pos_closing_entry_example",
"has_subcontracted": false,
"apply_tds": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false,
"title": "title_example",
"signing_document_id": "signing_document_id_example"
}
],
"has_more": false,
"total": 1
} POST
/api/accounts/sales-invoice Create a sales invoice
Creates a new sales invoice object.
Body parameters
status string
Default: draft
customer string required
customer_name string
tax_id string
project string
is_pos boolean
Default: false
pos_profile string
is_return boolean
Default: false
company string required
cost_center string
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
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
is_consolidated boolean
Default: false
is_internal_customer boolean
Default: false
company_tax_id string
unrealized_profit_loss_account string
represents_company string
set_target_warehouse string
is_debit_note boolean
Default: false
disable_rounded_total boolean
Default: false
additional_discount_account string
dispatch_address_name string
dispatch_address string
ignore_default_payment_terms_template boolean
Default: false
total_billing_hours number
amount_eligible_for_commission number
subscription string
is_cash_or_non_trade_discount boolean
Default: false
incoterm string
named_place string
only_include_allocated_payments boolean
Default: false
use_company_roundoff_cost_center boolean
Default: false
update_billed_amount_in_delivery_note boolean
Default: true
dont_create_loyalty_points boolean
Default: false
coupon_code string
update_outstanding_for_self boolean
Default: true
utm_medium string
utm_content string
utm_campaign string
utm_source string
company_contact_person string
is_created_using_pos boolean
Default: false
pos_closing_entry string
has_subcontracted boolean
Default: false
apply_tds boolean
Default: false
tax_withholding_group string
ignore_tax_withholding_threshold boolean
Default: false
override_tax_withholding_entries boolean
Default: false
title string
signing_document_id string
Returns
Returns the newly created sales invoice object if the call succeeded.
POST /api/accounts/sales-invoice
curl https://api.overplane.dev/api/accounts/sales-invoice \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"customer":"customer_example","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": "sales-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",
"project": "project_example",
"is_pos": false,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"cost_center": "cost_center_example",
"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,
"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": "[email protected]",
"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",
"is_consolidated": false,
"is_internal_customer": false,
"company_tax_id": "Example Corp",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"represents_company": "Example Corp",
"set_target_warehouse": "set_target_warehouse_example",
"is_debit_note": false,
"disable_rounded_total": false,
"additional_discount_account": "additional_discount_account_example",
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"ignore_default_payment_terms_template": false,
"total_billing_hours": 0,
"amount_eligible_for_commission": 0,
"subscription": "subscription_example",
"is_cash_or_non_trade_discount": false,
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"only_include_allocated_payments": false,
"use_company_roundoff_cost_center": false,
"update_billed_amount_in_delivery_note": true,
"dont_create_loyalty_points": false,
"coupon_code": "coupon_code_example",
"update_outstanding_for_self": true,
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"is_created_using_pos": false,
"pos_closing_entry": "pos_closing_entry_example",
"has_subcontracted": false,
"apply_tds": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false,
"title": "title_example",
"signing_document_id": "signing_document_id_example"
} PATCH
/api/accounts/sales-invoice/{id} Update a sales invoice
Updates the specified sales 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 sales invoice to update.
Body parameters
status string
Default: draft
customer string
customer_name string
tax_id string
project string
is_pos boolean
Default: false
pos_profile string
is_return boolean
Default: false
company string
cost_center 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
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
is_consolidated boolean
Default: false
is_internal_customer boolean
Default: false
company_tax_id string
unrealized_profit_loss_account string
represents_company string
set_target_warehouse string
is_debit_note boolean
Default: false
disable_rounded_total boolean
Default: false
additional_discount_account string
dispatch_address_name string
dispatch_address string
ignore_default_payment_terms_template boolean
Default: false
total_billing_hours number
amount_eligible_for_commission number
subscription string
is_cash_or_non_trade_discount boolean
Default: false
incoterm string
named_place string
only_include_allocated_payments boolean
Default: false
use_company_roundoff_cost_center boolean
Default: false
update_billed_amount_in_delivery_note boolean
Default: true
dont_create_loyalty_points boolean
Default: false
coupon_code string
update_outstanding_for_self boolean
Default: true
utm_medium string
utm_content string
utm_campaign string
utm_source string
company_contact_person string
is_created_using_pos boolean
Default: false
pos_closing_entry string
has_subcontracted boolean
Default: false
apply_tds boolean
Default: false
tax_withholding_group string
ignore_tax_withholding_threshold boolean
Default: false
override_tax_withholding_entries boolean
Default: false
title string
signing_document_id string
Returns
Returns the updated sales invoice object.
PATCH /api/accounts/sales-invoice/{id}
curl https://api.overplane.dev/api/accounts/sales-invoice/sales-invoice_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"status":"draft","customer":"customer_example"}' Response
{
"id": "sales-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",
"project": "project_example",
"is_pos": false,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"cost_center": "cost_center_example",
"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,
"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": "[email protected]",
"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",
"is_consolidated": false,
"is_internal_customer": false,
"company_tax_id": "Example Corp",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"represents_company": "Example Corp",
"set_target_warehouse": "set_target_warehouse_example",
"is_debit_note": false,
"disable_rounded_total": false,
"additional_discount_account": "additional_discount_account_example",
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"ignore_default_payment_terms_template": false,
"total_billing_hours": 0,
"amount_eligible_for_commission": 0,
"subscription": "subscription_example",
"is_cash_or_non_trade_discount": false,
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"only_include_allocated_payments": false,
"use_company_roundoff_cost_center": false,
"update_billed_amount_in_delivery_note": true,
"dont_create_loyalty_points": false,
"coupon_code": "coupon_code_example",
"update_outstanding_for_self": true,
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"is_created_using_pos": false,
"pos_closing_entry": "pos_closing_entry_example",
"has_subcontracted": false,
"apply_tds": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false,
"title": "title_example",
"signing_document_id": "signing_document_id_example"
} DELETE
/api/accounts/sales-invoice/{id} Delete a sales invoice
Permanently deletes a sales invoice. This cannot be undone.
Path parameters
id string required
The identifier of the sales invoice to delete.
Returns
Returns a confirmation that the sales invoice has been deleted.
DELETE /api/accounts/sales-invoice/{id}
curl https://api.overplane.dev/api/accounts/sales-invoice/sales-invoice_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "sales-invoice_abc123",
"deleted": true
} POST
/api/accounts/sales-invoice/{id}/submit Submit a sales invoice
Submits a draft sales invoice, transitioning its status from draft to submitted.
Path parameters
id string required
The identifier of the sales invoice to act on.
Returns
Returns the sales invoice object with updated status.
POST /api/accounts/sales-invoice/{id}/submit
curl https://api.overplane.dev/api/accounts/sales-invoice/sales-invoice_abc123/submit \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "sales-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",
"project": "project_example",
"is_pos": false,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"cost_center": "cost_center_example",
"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,
"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": "[email protected]",
"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",
"is_consolidated": false,
"is_internal_customer": false,
"company_tax_id": "Example Corp",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"represents_company": "Example Corp",
"set_target_warehouse": "set_target_warehouse_example",
"is_debit_note": false,
"disable_rounded_total": false,
"additional_discount_account": "additional_discount_account_example",
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"ignore_default_payment_terms_template": false,
"total_billing_hours": 0,
"amount_eligible_for_commission": 0,
"subscription": "subscription_example",
"is_cash_or_non_trade_discount": false,
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"only_include_allocated_payments": false,
"use_company_roundoff_cost_center": false,
"update_billed_amount_in_delivery_note": true,
"dont_create_loyalty_points": false,
"coupon_code": "coupon_code_example",
"update_outstanding_for_self": true,
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"is_created_using_pos": false,
"pos_closing_entry": "pos_closing_entry_example",
"has_subcontracted": false,
"apply_tds": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false,
"title": "title_example",
"signing_document_id": "signing_document_id_example"
} POST
/api/accounts/sales-invoice/{id}/cancel Cancel a sales invoice
Cancels a submitted sales invoice, transitioning its status to cancelled.
Path parameters
id string required
The identifier of the sales invoice to act on.
Returns
Returns the sales invoice object with updated status.
POST /api/accounts/sales-invoice/{id}/cancel
curl https://api.overplane.dev/api/accounts/sales-invoice/sales-invoice_abc123/cancel \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "sales-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",
"project": "project_example",
"is_pos": false,
"pos_profile": "pos_profile_example",
"is_return": false,
"company": "Example Corp",
"cost_center": "cost_center_example",
"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,
"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": "[email protected]",
"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",
"is_consolidated": false,
"is_internal_customer": false,
"company_tax_id": "Example Corp",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"represents_company": "Example Corp",
"set_target_warehouse": "set_target_warehouse_example",
"is_debit_note": false,
"disable_rounded_total": false,
"additional_discount_account": "additional_discount_account_example",
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"ignore_default_payment_terms_template": false,
"total_billing_hours": 0,
"amount_eligible_for_commission": 0,
"subscription": "subscription_example",
"is_cash_or_non_trade_discount": false,
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"only_include_allocated_payments": false,
"use_company_roundoff_cost_center": false,
"update_billed_amount_in_delivery_note": true,
"dont_create_loyalty_points": false,
"coupon_code": "coupon_code_example",
"update_outstanding_for_self": true,
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"company_contact_person": "Example Corp",
"is_created_using_pos": false,
"pos_closing_entry": "pos_closing_entry_example",
"has_subcontracted": false,
"apply_tds": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false,
"title": "title_example",
"signing_document_id": "signing_document_id_example"
}Line items
Child objects that belong to this sales invoice. These are accessed via the parent's ID.
Sales Invoice Item
Attributes
idx integer
sales_invoice_id string required
barcode string
item_code string
item_name string required
customer_item_code string
description string
image_view string
image 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
base_rate number required
base_amount number required
pricing_rules string
is_free_item boolean
net_rate number
net_amount number
base_net_rate number
base_net_amount number
delivered_by_supplier boolean
income_account string required
expense_account string
item_tax_template string
cost_center string required
deferred_revenue_account string
service_stop_date string
enable_deferred_revenue boolean
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
serial_no string
item_group string
brand 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
is_fixed_asset boolean
asset string
page_break boolean
finance_book string
project string
sales_invoice_item string
incoming_rate number
stock_uom_rate number
discount_account string
grant_commission boolean
purchase_order string
purchase_order_item string
has_item_scanned boolean
serial_and_batch_bundle string
use_serial_batch_fields boolean
distributed_discount_amount number
company_total_stock number
pos_invoice_item string
pos_invoice string
scio_detail string
tax_withholding_category string
apply_tds boolean
Endpoints
GET
/api/accounts/sales-invoice-item?parent_id={id} POST
/api/accounts/sales-invoice-item PATCH
/api/accounts/sales-invoice-item/{id} DELETE
/api/accounts/sales-invoice-item/{id} POST
/api/accounts/sales-invoice-item/reorder Sales Invoice Item object
{
"id": "sales-invoice-item_abc123",
"idx": 1,
"sales_invoice_id": "sales_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",
"image_view": "image_view_example",
"image": "image_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,
"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",
"expense_account": "expense_account_example",
"item_tax_template": "item_tax_template_example",
"cost_center": "cost_center_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_group": "item_group_example",
"brand": "brand_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,
"is_fixed_asset": false,
"asset": "asset_example",
"page_break": false,
"finance_book": "finance_book_example",
"project": "project_example",
"sales_invoice_item": "sales_invoice_item_example",
"incoming_rate": 0,
"stock_uom_rate": 0,
"discount_account": "discount_account_example",
"grant_commission": false,
"purchase_order": "purchase_order_example",
"purchase_order_item": "purchase_order_item_example",
"has_item_scanned": false,
"serial_and_batch_bundle": "serial_and_batch_bundle_example",
"use_serial_batch_fields": false,
"distributed_discount_amount": 0,
"company_total_stock": 0,
"pos_invoice_item": "pos_invoice_item_example",
"pos_invoice": "pos_invoice_example",
"scio_detail": "scio_detail_example",
"tax_withholding_category": "tax_withholding_category_example",
"apply_tds": true
}