The Sales Order 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
order_type string
Default: Sales
company string required
transaction_date string required
delivery_date string
po_no string
po_date string
tax_id string
customer_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
company_address_display string
company_address string
shipping_address_name string
shipping_address string
customer_group string
territory 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
scan_barcode string
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
tax_category string
shipping_rule string
taxes_and_charges string
other_charges_calculation string
base_total_taxes_and_charges number
total_taxes_and_charges number
loyalty_points integer
loyalty_amount number
coupon_code 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
advance_paid number
payment_terms_template string
tc_name string
terms string
inter_company_order_reference string
project string
party_account_currency string
language string
letter_head string
select_print_heading string
group_same_items boolean
Default: false
delivery_status string
per_delivered number
per_billed number
billing_status string
sales_partner string
commission_rate number
total_commission number
from_date string
to_date string
auto_repeat string
contact_phone string
skip_delivery_note boolean
Default: false
is_internal_customer boolean
Default: false
represents_company string
disable_rounded_total boolean
Default: false
dispatch_address_name string
dispatch_address string
amount_eligible_for_commission number
per_picked number
cost_center string
incoterm string
named_place string
reserve_stock boolean
Default: false
advance_payment_status string
utm_medium string
utm_content string
utm_source string
utm_campaign string
company_contact_person string
has_unit_price_items boolean
Default: false
is_subcontracted boolean
Default: false
transaction_time string
ignore_default_payment_terms_template boolean
Default: false
title string
The Sales Order object
{
"id": "sales-order_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",
"order_type": "Sales",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"delivery_date": "2024-01-15",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"tax_id": "tax_id_example",
"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]",
"company_address_display": "Example Corp",
"company_address": "Example Corp",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"customer_group": "customer_group_example",
"territory": "territory_example",
"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",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"tax_category": "tax_category_example",
"shipping_rule": "shipping_rule_example",
"taxes_and_charges": "taxes_and_charges_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,
"coupon_code": "coupon_code_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",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"inter_company_order_reference": "Example Corp",
"project": "project_example",
"party_account_currency": "USD",
"language": "language_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"delivery_status": "delivery_status_example",
"per_delivered": 0,
"per_billed": 0,
"billing_status": "billing_status_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",
"contact_phone": "contact_phone_example",
"skip_delivery_note": false,
"is_internal_customer": false,
"represents_company": "Example Corp",
"disable_rounded_total": false,
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"amount_eligible_for_commission": 0,
"per_picked": 0,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"reserve_stock": false,
"advance_payment_status": "advance_payment_status_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_source": "utm_source_example",
"utm_campaign": "utm_campaign_example",
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"is_subcontracted": false,
"transaction_time": "transaction_time_example",
"ignore_default_payment_terms_template": false,
"title": "title_example"
} GET
/api/crm/sales-order/{id} Retrieve a sales order
Retrieves the details of an existing sales order. Supply the unique sales order ID that was returned from a previous request.
Path parameters
id string required
The identifier of the sales order to retrieve.
Returns
Returns the sales order object if a valid identifier was provided.
GET /api/crm/sales-order/{id}
curl https://api.overplane.dev/api/crm/sales-order/sales-order_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "sales-order_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",
"order_type": "Sales",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"delivery_date": "2024-01-15",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"tax_id": "tax_id_example",
"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]",
"company_address_display": "Example Corp",
"company_address": "Example Corp",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"customer_group": "customer_group_example",
"territory": "territory_example",
"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",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"tax_category": "tax_category_example",
"shipping_rule": "shipping_rule_example",
"taxes_and_charges": "taxes_and_charges_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,
"coupon_code": "coupon_code_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",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"inter_company_order_reference": "Example Corp",
"project": "project_example",
"party_account_currency": "USD",
"language": "language_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"delivery_status": "delivery_status_example",
"per_delivered": 0,
"per_billed": 0,
"billing_status": "billing_status_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",
"contact_phone": "contact_phone_example",
"skip_delivery_note": false,
"is_internal_customer": false,
"represents_company": "Example Corp",
"disable_rounded_total": false,
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"amount_eligible_for_commission": 0,
"per_picked": 0,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"reserve_stock": false,
"advance_payment_status": "advance_payment_status_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_source": "utm_source_example",
"utm_campaign": "utm_campaign_example",
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"is_subcontracted": false,
"transaction_time": "transaction_time_example",
"ignore_default_payment_terms_template": false,
"title": "title_example"
} GET
/api/crm/sales-order List all sales orders
Returns a list of sales orders. 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 order objects.
GET /api/crm/sales-order
curl https://api.overplane.dev/api/crm/sales-order \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "sales-order_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",
"order_type": "Sales",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"delivery_date": "2024-01-15",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"tax_id": "tax_id_example",
"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]",
"company_address_display": "Example Corp",
"company_address": "Example Corp",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"customer_group": "customer_group_example",
"territory": "territory_example",
"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",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"tax_category": "tax_category_example",
"shipping_rule": "shipping_rule_example",
"taxes_and_charges": "taxes_and_charges_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,
"coupon_code": "coupon_code_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",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"inter_company_order_reference": "Example Corp",
"project": "project_example",
"party_account_currency": "USD",
"language": "language_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"delivery_status": "delivery_status_example",
"per_delivered": 0,
"per_billed": 0,
"billing_status": "billing_status_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",
"contact_phone": "contact_phone_example",
"skip_delivery_note": false,
"is_internal_customer": false,
"represents_company": "Example Corp",
"disable_rounded_total": false,
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"amount_eligible_for_commission": 0,
"per_picked": 0,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"reserve_stock": false,
"advance_payment_status": "advance_payment_status_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_source": "utm_source_example",
"utm_campaign": "utm_campaign_example",
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"is_subcontracted": false,
"transaction_time": "transaction_time_example",
"ignore_default_payment_terms_template": false,
"title": "title_example"
}
],
"has_more": false,
"total": 1
} POST
/api/crm/sales-order Create a sales order
Creates a new sales order object.
Body parameters
status string
Default: draft
customer string required
customer_name string
order_type string
Default: Sales
company string required
transaction_date string required
delivery_date string
po_no string
po_date string
tax_id string
customer_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
company_address_display string
company_address string
shipping_address_name string
shipping_address string
customer_group string
territory 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
scan_barcode string
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
tax_category string
shipping_rule string
taxes_and_charges string
other_charges_calculation string
base_total_taxes_and_charges number
total_taxes_and_charges number
loyalty_points integer
loyalty_amount number
coupon_code 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
advance_paid number
payment_terms_template string
tc_name string
terms string
inter_company_order_reference string
project string
party_account_currency string
language string
letter_head string
select_print_heading string
group_same_items boolean
Default: false
delivery_status string
per_delivered number
per_billed number
billing_status string
sales_partner string
commission_rate number
total_commission number
from_date string
to_date string
auto_repeat string
contact_phone string
skip_delivery_note boolean
Default: false
is_internal_customer boolean
Default: false
represents_company string
disable_rounded_total boolean
Default: false
dispatch_address_name string
dispatch_address string
amount_eligible_for_commission number
per_picked number
cost_center string
incoterm string
named_place string
reserve_stock boolean
Default: false
advance_payment_status string
utm_medium string
utm_content string
utm_source string
utm_campaign string
company_contact_person string
has_unit_price_items boolean
Default: false
is_subcontracted boolean
Default: false
transaction_time string
ignore_default_payment_terms_template boolean
Default: false
title string
Returns
Returns the newly created sales order object if the call succeeded.
POST /api/crm/sales-order
curl https://api.overplane.dev/api/crm/sales-order \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"customer":"customer_example","company":"Example Corp","transaction_date":"2024-01-15","currency":"USD","conversion_rate":0,"selling_price_list":"selling_price_list_example","price_list_currency":"USD","plc_conversion_rate":0}' Response
{
"id": "sales-order_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",
"order_type": "Sales",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"delivery_date": "2024-01-15",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"tax_id": "tax_id_example",
"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]",
"company_address_display": "Example Corp",
"company_address": "Example Corp",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"customer_group": "customer_group_example",
"territory": "territory_example",
"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",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"tax_category": "tax_category_example",
"shipping_rule": "shipping_rule_example",
"taxes_and_charges": "taxes_and_charges_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,
"coupon_code": "coupon_code_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",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"inter_company_order_reference": "Example Corp",
"project": "project_example",
"party_account_currency": "USD",
"language": "language_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"delivery_status": "delivery_status_example",
"per_delivered": 0,
"per_billed": 0,
"billing_status": "billing_status_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",
"contact_phone": "contact_phone_example",
"skip_delivery_note": false,
"is_internal_customer": false,
"represents_company": "Example Corp",
"disable_rounded_total": false,
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"amount_eligible_for_commission": 0,
"per_picked": 0,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"reserve_stock": false,
"advance_payment_status": "advance_payment_status_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_source": "utm_source_example",
"utm_campaign": "utm_campaign_example",
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"is_subcontracted": false,
"transaction_time": "transaction_time_example",
"ignore_default_payment_terms_template": false,
"title": "title_example"
} PATCH
/api/crm/sales-order/{id} Update a sales order
Updates the specified sales order 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 order to update.
Body parameters
status string
Default: draft
customer string
customer_name string
order_type string
Default: Sales
company string
transaction_date string
delivery_date string
po_no string
po_date string
tax_id string
customer_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
company_address_display string
company_address string
shipping_address_name string
shipping_address string
customer_group string
territory 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
scan_barcode string
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
tax_category string
shipping_rule string
taxes_and_charges string
other_charges_calculation string
base_total_taxes_and_charges number
total_taxes_and_charges number
loyalty_points integer
loyalty_amount number
coupon_code 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
advance_paid number
payment_terms_template string
tc_name string
terms string
inter_company_order_reference string
project string
party_account_currency string
language string
letter_head string
select_print_heading string
group_same_items boolean
Default: false
delivery_status string
per_delivered number
per_billed number
billing_status string
sales_partner string
commission_rate number
total_commission number
from_date string
to_date string
auto_repeat string
contact_phone string
skip_delivery_note boolean
Default: false
is_internal_customer boolean
Default: false
represents_company string
disable_rounded_total boolean
Default: false
dispatch_address_name string
dispatch_address string
amount_eligible_for_commission number
per_picked number
cost_center string
incoterm string
named_place string
reserve_stock boolean
Default: false
advance_payment_status string
utm_medium string
utm_content string
utm_source string
utm_campaign string
company_contact_person string
has_unit_price_items boolean
Default: false
is_subcontracted boolean
Default: false
transaction_time string
ignore_default_payment_terms_template boolean
Default: false
title string
Returns
Returns the updated sales order object.
PATCH /api/crm/sales-order/{id}
curl https://api.overplane.dev/api/crm/sales-order/sales-order_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"status":"draft","customer":"customer_example"}' Response
{
"id": "sales-order_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",
"order_type": "Sales",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"delivery_date": "2024-01-15",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"tax_id": "tax_id_example",
"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]",
"company_address_display": "Example Corp",
"company_address": "Example Corp",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"customer_group": "customer_group_example",
"territory": "territory_example",
"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",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"tax_category": "tax_category_example",
"shipping_rule": "shipping_rule_example",
"taxes_and_charges": "taxes_and_charges_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,
"coupon_code": "coupon_code_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",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"inter_company_order_reference": "Example Corp",
"project": "project_example",
"party_account_currency": "USD",
"language": "language_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"delivery_status": "delivery_status_example",
"per_delivered": 0,
"per_billed": 0,
"billing_status": "billing_status_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",
"contact_phone": "contact_phone_example",
"skip_delivery_note": false,
"is_internal_customer": false,
"represents_company": "Example Corp",
"disable_rounded_total": false,
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"amount_eligible_for_commission": 0,
"per_picked": 0,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"reserve_stock": false,
"advance_payment_status": "advance_payment_status_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_source": "utm_source_example",
"utm_campaign": "utm_campaign_example",
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"is_subcontracted": false,
"transaction_time": "transaction_time_example",
"ignore_default_payment_terms_template": false,
"title": "title_example"
} DELETE
/api/crm/sales-order/{id} Delete a sales order
Permanently deletes a sales order. This cannot be undone.
Path parameters
id string required
The identifier of the sales order to delete.
Returns
Returns a confirmation that the sales order has been deleted.
DELETE /api/crm/sales-order/{id}
curl https://api.overplane.dev/api/crm/sales-order/sales-order_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "sales-order_abc123",
"deleted": true
} POST
/api/crm/sales-order/{id}/submit Submit a sales order
Submits a draft sales order, transitioning its status from draft to submitted.
Path parameters
id string required
The identifier of the sales order to act on.
Returns
Returns the sales order object with updated status.
POST /api/crm/sales-order/{id}/submit
curl https://api.overplane.dev/api/crm/sales-order/sales-order_abc123/submit \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "sales-order_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",
"order_type": "Sales",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"delivery_date": "2024-01-15",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"tax_id": "tax_id_example",
"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]",
"company_address_display": "Example Corp",
"company_address": "Example Corp",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"customer_group": "customer_group_example",
"territory": "territory_example",
"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",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"tax_category": "tax_category_example",
"shipping_rule": "shipping_rule_example",
"taxes_and_charges": "taxes_and_charges_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,
"coupon_code": "coupon_code_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",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"inter_company_order_reference": "Example Corp",
"project": "project_example",
"party_account_currency": "USD",
"language": "language_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"delivery_status": "delivery_status_example",
"per_delivered": 0,
"per_billed": 0,
"billing_status": "billing_status_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",
"contact_phone": "contact_phone_example",
"skip_delivery_note": false,
"is_internal_customer": false,
"represents_company": "Example Corp",
"disable_rounded_total": false,
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"amount_eligible_for_commission": 0,
"per_picked": 0,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"reserve_stock": false,
"advance_payment_status": "advance_payment_status_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_source": "utm_source_example",
"utm_campaign": "utm_campaign_example",
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"is_subcontracted": false,
"transaction_time": "transaction_time_example",
"ignore_default_payment_terms_template": false,
"title": "title_example"
} POST
/api/crm/sales-order/{id}/cancel Cancel a sales order
Cancels a submitted sales order, transitioning its status to cancelled.
Path parameters
id string required
The identifier of the sales order to act on.
Returns
Returns the sales order object with updated status.
POST /api/crm/sales-order/{id}/cancel
curl https://api.overplane.dev/api/crm/sales-order/sales-order_abc123/cancel \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "sales-order_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",
"order_type": "Sales",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"delivery_date": "2024-01-15",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"tax_id": "tax_id_example",
"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]",
"company_address_display": "Example Corp",
"company_address": "Example Corp",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"customer_group": "customer_group_example",
"territory": "territory_example",
"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",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"tax_category": "tax_category_example",
"shipping_rule": "shipping_rule_example",
"taxes_and_charges": "taxes_and_charges_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,
"coupon_code": "coupon_code_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",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"inter_company_order_reference": "Example Corp",
"project": "project_example",
"party_account_currency": "USD",
"language": "language_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"delivery_status": "delivery_status_example",
"per_delivered": 0,
"per_billed": 0,
"billing_status": "billing_status_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",
"contact_phone": "contact_phone_example",
"skip_delivery_note": false,
"is_internal_customer": false,
"represents_company": "Example Corp",
"disable_rounded_total": false,
"dispatch_address_name": "dispatch_address_name_example",
"dispatch_address": "dispatch_address_example",
"amount_eligible_for_commission": 0,
"per_picked": 0,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"reserve_stock": false,
"advance_payment_status": "advance_payment_status_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"utm_source": "utm_source_example",
"utm_campaign": "utm_campaign_example",
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"is_subcontracted": false,
"transaction_time": "transaction_time_example",
"ignore_default_payment_terms_template": false,
"title": "title_example"
}Line items
Child objects that belong to this sales order. These are accessed via the parent's ID.
Sales Order Item
Attributes
idx integer
sales_order_id string required
item_code string required
customer_item_code string
ensure_delivery_based_on_produced_serial_no boolean
item_name string required
description string
delivery_date string
image string
image_view string
qty number required
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
amount number
base_rate number
base_amount number
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
supplier string
weight_per_unit number
total_weight number
weight_uom string
warehouse string
target_warehouse string
prevdoc_docname string
brand string
item_group string
billed_amt number
valuation_rate number
gross_profit number
blanket_order string
blanket_order_rate number
projected_qty number
actual_qty number
ordered_qty number
delivered_qty number
work_order_qty number
returned_qty number
item_tax_template string
page_break boolean
planned_qty number
produced_qty number
item_tax_rate string
transaction_date string
additional_notes string
against_blanket_order boolean
bom_no string
stock_uom_rate number
grant_commission boolean
picked_qty number
purchase_order string
purchase_order_item string
quotation_item string
material_request string
material_request_item string
reserve_stock boolean
stock_reserved_qty number
production_plan_qty number
is_stock_item boolean
distributed_discount_amount number
company_total_stock number
cost_center string
project string
subcontracted_qty number
fg_item string
fg_item_qty number
requested_qty number
Endpoints
GET
/api/crm/sales-order-item?parent_id={id} POST
/api/crm/sales-order-item PATCH
/api/crm/sales-order-item/{id} DELETE
/api/crm/sales-order-item/{id} POST
/api/crm/sales-order-item/reorder Sales Order Item object
{
"id": "sales-order-item_abc123",
"idx": 1,
"sales_order_id": "sales_order_id_example",
"item_code": "item_code_example",
"customer_item_code": "customer_item_code_example",
"ensure_delivery_based_on_produced_serial_no": false,
"item_name": "item_name_example",
"description": "description_example",
"delivery_date": "2024-01-15",
"image": "image_example",
"image_view": "image_view_example",
"qty": 0,
"stock_uom": "stock_uom_example",
"uom": "uom_example",
"conversion_factor": 0,
"stock_qty": 0,
"price_list_rate": 0,
"base_price_list_rate": 0,
"margin_type": "margin_type_example",
"margin_rate_or_amount": 0,
"rate_with_margin": 0,
"discount_percentage": 0,
"discount_amount": 0,
"base_rate_with_margin": 0,
"rate": 0,
"amount": 0,
"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,
"supplier": "supplier_example",
"weight_per_unit": 0,
"total_weight": 0,
"weight_uom": "weight_uom_example",
"warehouse": "warehouse_example",
"target_warehouse": "target_warehouse_example",
"prevdoc_docname": "prevdoc_docname_example",
"brand": "brand_example",
"item_group": "item_group_example",
"billed_amt": 0,
"valuation_rate": 0,
"gross_profit": 0,
"blanket_order": "blanket_order_example",
"blanket_order_rate": 0,
"projected_qty": 0,
"actual_qty": 0,
"ordered_qty": 0,
"delivered_qty": 0,
"work_order_qty": 0,
"returned_qty": 0,
"item_tax_template": "item_tax_template_example",
"page_break": false,
"planned_qty": 0,
"produced_qty": 0,
"item_tax_rate": "item_tax_rate_example",
"transaction_date": "2024-01-15",
"additional_notes": "additional_notes_example",
"against_blanket_order": false,
"bom_no": "bom_no_example",
"stock_uom_rate": 0,
"grant_commission": false,
"picked_qty": 0,
"purchase_order": "purchase_order_example",
"purchase_order_item": "purchase_order_item_example",
"quotation_item": "quotation_item_example",
"material_request": "material_request_example",
"material_request_item": "material_request_item_example",
"reserve_stock": true,
"stock_reserved_qty": 0,
"production_plan_qty": 0,
"is_stock_item": false,
"distributed_discount_amount": 0,
"company_total_stock": 0,
"cost_center": "cost_center_example",
"project": "project_example",
"subcontracted_qty": 0,
"fg_item": "fg_item_example",
"fg_item_qty": 0,
"requested_qty": 0
}