The Delivery Note 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
company string required
posting_date string required
posting_time string required
set_posting_time boolean
Default: false
is_return boolean
Default: false
issue_credit_note boolean
Default: false
return_against string
po_no string
po_date string
shipping_address_name string
shipping_address string
contact_person string
contact_display string
contact_mobile string
contact_email string
customer_address string
tax_id string
address_display 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
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
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
tc_name string
terms string
transporter string
driver string
lr_no string
vehicle_no string
transporter_name string
driver_name string
lr_date string
project string
per_billed number
customer_group string
territory string
letter_head string
select_print_heading string
language string
print_without_amount boolean
Default: false
group_same_items boolean
Default: false
per_installed number
installation_status string
excise_page string
instructions string
auto_repeat string
sales_partner string
commission_rate number
total_commission number
is_internal_customer boolean
Default: false
inter_company_reference string
per_returned number
set_target_warehouse string
represents_company string
disable_rounded_total boolean
Default: false
dispatch_address_name string
dispatch_address string
amount_eligible_for_commission number
cost_center string
incoterm string
named_place string
delivery_trip string
utm_medium string
utm_content string
utm_source string
utm_campaign string
company_contact_person string
title string
The Delivery Note object
{
"id": "delivery-note_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",
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"is_return": false,
"issue_credit_note": false,
"return_against": "return_against_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "[email protected]",
"customer_address": "customer_address_example",
"tax_id": "tax_id_example",
"address_display": "address_display_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",
"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,
"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",
"tc_name": "tc_name_example",
"terms": "terms_example",
"transporter": "transporter_example",
"driver": "driver_example",
"lr_no": "lr_no_example",
"vehicle_no": "vehicle_no_example",
"transporter_name": "transporter_name_example",
"driver_name": "driver_name_example",
"lr_date": "2024-01-15",
"project": "project_example",
"per_billed": 0,
"customer_group": "customer_group_example",
"territory": "territory_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"print_without_amount": false,
"group_same_items": false,
"per_installed": 0,
"installation_status": "installation_status_example",
"excise_page": "excise_page_example",
"instructions": "instructions_example",
"auto_repeat": "auto_repeat_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"is_internal_customer": false,
"inter_company_reference": "Example Corp",
"per_returned": 0,
"set_target_warehouse": "set_target_warehouse_example",
"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,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"delivery_trip": "delivery_trip_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",
"title": "title_example"
} GET
/api/stock/delivery-note/{id} Retrieve a delivery note
Retrieves the details of an existing delivery note. Supply the unique delivery note ID that was returned from a previous request.
Path parameters
id string required
The identifier of the delivery note to retrieve.
Returns
Returns the delivery note object if a valid identifier was provided.
GET /api/stock/delivery-note/{id}
curl https://api.overplane.dev/api/stock/delivery-note/delivery-note_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "delivery-note_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",
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"is_return": false,
"issue_credit_note": false,
"return_against": "return_against_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "[email protected]",
"customer_address": "customer_address_example",
"tax_id": "tax_id_example",
"address_display": "address_display_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",
"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,
"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",
"tc_name": "tc_name_example",
"terms": "terms_example",
"transporter": "transporter_example",
"driver": "driver_example",
"lr_no": "lr_no_example",
"vehicle_no": "vehicle_no_example",
"transporter_name": "transporter_name_example",
"driver_name": "driver_name_example",
"lr_date": "2024-01-15",
"project": "project_example",
"per_billed": 0,
"customer_group": "customer_group_example",
"territory": "territory_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"print_without_amount": false,
"group_same_items": false,
"per_installed": 0,
"installation_status": "installation_status_example",
"excise_page": "excise_page_example",
"instructions": "instructions_example",
"auto_repeat": "auto_repeat_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"is_internal_customer": false,
"inter_company_reference": "Example Corp",
"per_returned": 0,
"set_target_warehouse": "set_target_warehouse_example",
"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,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"delivery_trip": "delivery_trip_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",
"title": "title_example"
} GET
/api/stock/delivery-note List all delivery notes
Returns a list of delivery notes. 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 delivery note objects.
GET /api/stock/delivery-note
curl https://api.overplane.dev/api/stock/delivery-note \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "delivery-note_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",
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"is_return": false,
"issue_credit_note": false,
"return_against": "return_against_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "[email protected]",
"customer_address": "customer_address_example",
"tax_id": "tax_id_example",
"address_display": "address_display_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",
"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,
"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",
"tc_name": "tc_name_example",
"terms": "terms_example",
"transporter": "transporter_example",
"driver": "driver_example",
"lr_no": "lr_no_example",
"vehicle_no": "vehicle_no_example",
"transporter_name": "transporter_name_example",
"driver_name": "driver_name_example",
"lr_date": "2024-01-15",
"project": "project_example",
"per_billed": 0,
"customer_group": "customer_group_example",
"territory": "territory_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"print_without_amount": false,
"group_same_items": false,
"per_installed": 0,
"installation_status": "installation_status_example",
"excise_page": "excise_page_example",
"instructions": "instructions_example",
"auto_repeat": "auto_repeat_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"is_internal_customer": false,
"inter_company_reference": "Example Corp",
"per_returned": 0,
"set_target_warehouse": "set_target_warehouse_example",
"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,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"delivery_trip": "delivery_trip_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",
"title": "title_example"
}
],
"has_more": false,
"total": 1
} POST
/api/stock/delivery-note Create a delivery note
Creates a new delivery note object.
Body parameters
status string
Default: draft
customer string required
customer_name string
company string required
posting_date string required
posting_time string required
set_posting_time boolean
Default: false
is_return boolean
Default: false
issue_credit_note boolean
Default: false
return_against string
po_no string
po_date string
shipping_address_name string
shipping_address string
contact_person string
contact_display string
contact_mobile string
contact_email string
customer_address string
tax_id string
address_display 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
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
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
tc_name string
terms string
transporter string
driver string
lr_no string
vehicle_no string
transporter_name string
driver_name string
lr_date string
project string
per_billed number
customer_group string
territory string
letter_head string
select_print_heading string
language string
print_without_amount boolean
Default: false
group_same_items boolean
Default: false
per_installed number
installation_status string
excise_page string
instructions string
auto_repeat string
sales_partner string
commission_rate number
total_commission number
is_internal_customer boolean
Default: false
inter_company_reference string
per_returned number
set_target_warehouse string
represents_company string
disable_rounded_total boolean
Default: false
dispatch_address_name string
dispatch_address string
amount_eligible_for_commission number
cost_center string
incoterm string
named_place string
delivery_trip string
utm_medium string
utm_content string
utm_source string
utm_campaign string
company_contact_person string
title string
Returns
Returns the newly created delivery note object if the call succeeded.
POST /api/stock/delivery-note
curl https://api.overplane.dev/api/stock/delivery-note \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"customer":"customer_example","company":"Example Corp","posting_date":"2024-01-15","posting_time":"posting_time_example","currency":"USD","conversion_rate":0,"selling_price_list":"selling_price_list_example","price_list_currency":"USD","plc_conversion_rate":0}' Response
{
"id": "delivery-note_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",
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"is_return": false,
"issue_credit_note": false,
"return_against": "return_against_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "[email protected]",
"customer_address": "customer_address_example",
"tax_id": "tax_id_example",
"address_display": "address_display_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",
"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,
"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",
"tc_name": "tc_name_example",
"terms": "terms_example",
"transporter": "transporter_example",
"driver": "driver_example",
"lr_no": "lr_no_example",
"vehicle_no": "vehicle_no_example",
"transporter_name": "transporter_name_example",
"driver_name": "driver_name_example",
"lr_date": "2024-01-15",
"project": "project_example",
"per_billed": 0,
"customer_group": "customer_group_example",
"territory": "territory_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"print_without_amount": false,
"group_same_items": false,
"per_installed": 0,
"installation_status": "installation_status_example",
"excise_page": "excise_page_example",
"instructions": "instructions_example",
"auto_repeat": "auto_repeat_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"is_internal_customer": false,
"inter_company_reference": "Example Corp",
"per_returned": 0,
"set_target_warehouse": "set_target_warehouse_example",
"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,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"delivery_trip": "delivery_trip_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",
"title": "title_example"
} PATCH
/api/stock/delivery-note/{id} Update a delivery note
Updates the specified delivery note 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 delivery note to update.
Body parameters
status string
Default: draft
customer string
customer_name string
company string
posting_date string
posting_time string
set_posting_time boolean
Default: false
is_return boolean
Default: false
issue_credit_note boolean
Default: false
return_against string
po_no string
po_date string
shipping_address_name string
shipping_address string
contact_person string
contact_display string
contact_mobile string
contact_email string
customer_address string
tax_id string
address_display 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
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
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
tc_name string
terms string
transporter string
driver string
lr_no string
vehicle_no string
transporter_name string
driver_name string
lr_date string
project string
per_billed number
customer_group string
territory string
letter_head string
select_print_heading string
language string
print_without_amount boolean
Default: false
group_same_items boolean
Default: false
per_installed number
installation_status string
excise_page string
instructions string
auto_repeat string
sales_partner string
commission_rate number
total_commission number
is_internal_customer boolean
Default: false
inter_company_reference string
per_returned number
set_target_warehouse string
represents_company string
disable_rounded_total boolean
Default: false
dispatch_address_name string
dispatch_address string
amount_eligible_for_commission number
cost_center string
incoterm string
named_place string
delivery_trip string
utm_medium string
utm_content string
utm_source string
utm_campaign string
company_contact_person string
title string
Returns
Returns the updated delivery note object.
PATCH /api/stock/delivery-note/{id}
curl https://api.overplane.dev/api/stock/delivery-note/delivery-note_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"status":"draft","customer":"customer_example"}' Response
{
"id": "delivery-note_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",
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"is_return": false,
"issue_credit_note": false,
"return_against": "return_against_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "[email protected]",
"customer_address": "customer_address_example",
"tax_id": "tax_id_example",
"address_display": "address_display_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",
"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,
"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",
"tc_name": "tc_name_example",
"terms": "terms_example",
"transporter": "transporter_example",
"driver": "driver_example",
"lr_no": "lr_no_example",
"vehicle_no": "vehicle_no_example",
"transporter_name": "transporter_name_example",
"driver_name": "driver_name_example",
"lr_date": "2024-01-15",
"project": "project_example",
"per_billed": 0,
"customer_group": "customer_group_example",
"territory": "territory_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"print_without_amount": false,
"group_same_items": false,
"per_installed": 0,
"installation_status": "installation_status_example",
"excise_page": "excise_page_example",
"instructions": "instructions_example",
"auto_repeat": "auto_repeat_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"is_internal_customer": false,
"inter_company_reference": "Example Corp",
"per_returned": 0,
"set_target_warehouse": "set_target_warehouse_example",
"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,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"delivery_trip": "delivery_trip_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",
"title": "title_example"
} DELETE
/api/stock/delivery-note/{id} Delete a delivery note
Permanently deletes a delivery note. This cannot be undone.
Path parameters
id string required
The identifier of the delivery note to delete.
Returns
Returns a confirmation that the delivery note has been deleted.
DELETE /api/stock/delivery-note/{id}
curl https://api.overplane.dev/api/stock/delivery-note/delivery-note_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "delivery-note_abc123",
"deleted": true
} POST
/api/stock/delivery-note/{id}/submit Submit a delivery note
Submits a draft delivery note, transitioning its status from draft to submitted.
Path parameters
id string required
The identifier of the delivery note to act on.
Returns
Returns the delivery note object with updated status.
POST /api/stock/delivery-note/{id}/submit
curl https://api.overplane.dev/api/stock/delivery-note/delivery-note_abc123/submit \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "delivery-note_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",
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"is_return": false,
"issue_credit_note": false,
"return_against": "return_against_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "[email protected]",
"customer_address": "customer_address_example",
"tax_id": "tax_id_example",
"address_display": "address_display_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",
"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,
"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",
"tc_name": "tc_name_example",
"terms": "terms_example",
"transporter": "transporter_example",
"driver": "driver_example",
"lr_no": "lr_no_example",
"vehicle_no": "vehicle_no_example",
"transporter_name": "transporter_name_example",
"driver_name": "driver_name_example",
"lr_date": "2024-01-15",
"project": "project_example",
"per_billed": 0,
"customer_group": "customer_group_example",
"territory": "territory_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"print_without_amount": false,
"group_same_items": false,
"per_installed": 0,
"installation_status": "installation_status_example",
"excise_page": "excise_page_example",
"instructions": "instructions_example",
"auto_repeat": "auto_repeat_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"is_internal_customer": false,
"inter_company_reference": "Example Corp",
"per_returned": 0,
"set_target_warehouse": "set_target_warehouse_example",
"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,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"delivery_trip": "delivery_trip_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",
"title": "title_example"
} POST
/api/stock/delivery-note/{id}/cancel Cancel a delivery note
Cancels a submitted delivery note, transitioning its status to cancelled.
Path parameters
id string required
The identifier of the delivery note to act on.
Returns
Returns the delivery note object with updated status.
POST /api/stock/delivery-note/{id}/cancel
curl https://api.overplane.dev/api/stock/delivery-note/delivery-note_abc123/cancel \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "delivery-note_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",
"company": "Example Corp",
"posting_date": "2024-01-15",
"posting_time": "posting_time_example",
"set_posting_time": false,
"is_return": false,
"issue_credit_note": false,
"return_against": "return_against_example",
"po_no": "po_no_example",
"po_date": "2024-01-15",
"shipping_address_name": "shipping_address_name_example",
"shipping_address": "shipping_address_example",
"contact_person": "contact_person_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "[email protected]",
"customer_address": "customer_address_example",
"tax_id": "tax_id_example",
"address_display": "address_display_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",
"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,
"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",
"tc_name": "tc_name_example",
"terms": "terms_example",
"transporter": "transporter_example",
"driver": "driver_example",
"lr_no": "lr_no_example",
"vehicle_no": "vehicle_no_example",
"transporter_name": "transporter_name_example",
"driver_name": "driver_name_example",
"lr_date": "2024-01-15",
"project": "project_example",
"per_billed": 0,
"customer_group": "customer_group_example",
"territory": "territory_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"print_without_amount": false,
"group_same_items": false,
"per_installed": 0,
"installation_status": "installation_status_example",
"excise_page": "excise_page_example",
"instructions": "instructions_example",
"auto_repeat": "auto_repeat_example",
"sales_partner": "sales_partner_example",
"commission_rate": 0,
"total_commission": 0,
"is_internal_customer": false,
"inter_company_reference": "Example Corp",
"per_returned": 0,
"set_target_warehouse": "set_target_warehouse_example",
"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,
"cost_center": "cost_center_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"delivery_trip": "delivery_trip_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",
"title": "title_example"
}Line items
Child objects that belong to this delivery note. These are accessed via the parent's ID.
Delivery Note Item
Attributes
idx integer
delivery_note_id string required
barcode string
item_code string required
item_name string required
customer_item_code string
description string
image string
image_view string
qty number required
stock_uom string required
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
weight_per_unit number
total_weight number
weight_uom string
warehouse string
target_warehouse string
quality_inspection string
actual_qty number
actual_batch_qty number
item_group string
brand string
item_tax_rate string
expense_account string
item_tax_template string
cost_center string
allow_zero_valuation_rate boolean
against_sales_order string
against_sales_invoice string
so_detail string
si_detail string
installed_qty number
billed_amt number
page_break boolean
project string
dn_detail string
returned_qty number
incoming_rate number
stock_uom_rate number
grant_commission boolean
pick_list_item string
purchase_order string
purchase_order_item string
has_item_scanned boolean
material_request string
material_request_item string
received_qty number
packed_qty number
serial_and_batch_bundle string
serial_no string
batch_no string
use_serial_batch_fields boolean
distributed_discount_amount number
company_total_stock number
against_pick_list string
Endpoints
GET
/api/stock/delivery-note-item?parent_id={id} POST
/api/stock/delivery-note-item PATCH
/api/stock/delivery-note-item/{id} DELETE
/api/stock/delivery-note-item/{id} POST
/api/stock/delivery-note-item/reorder Delivery Note Item object
{
"id": "delivery-note-item_abc123",
"idx": 1,
"delivery_note_id": "delivery_note_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": "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,
"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",
"actual_qty": 0,
"actual_batch_qty": 0,
"item_group": "item_group_example",
"brand": "brand_example",
"item_tax_rate": "item_tax_rate_example",
"expense_account": "expense_account_example",
"item_tax_template": "item_tax_template_example",
"cost_center": "cost_center_example",
"allow_zero_valuation_rate": false,
"against_sales_order": "against_sales_order_example",
"against_sales_invoice": "against_sales_invoice_example",
"so_detail": "so_detail_example",
"si_detail": "si_detail_example",
"installed_qty": 0,
"billed_amt": 0,
"page_break": false,
"project": "project_example",
"dn_detail": "dn_detail_example",
"returned_qty": 0,
"incoming_rate": 0,
"stock_uom_rate": 0,
"grant_commission": false,
"pick_list_item": "pick_list_item_example",
"purchase_order": "purchase_order_example",
"purchase_order_item": "purchase_order_item_example",
"has_item_scanned": false,
"material_request": "material_request_example",
"material_request_item": "material_request_item_example",
"received_qty": 0,
"packed_qty": 0,
"serial_and_batch_bundle": "serial_and_batch_bundle_example",
"serial_no": "serial_no_example",
"batch_no": "batch_no_example",
"use_serial_batch_fields": false,
"distributed_discount_amount": 0,
"company_total_stock": 0,
"against_pick_list": "against_pick_list_example"
}