The Quotation 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
quotation_to string
Default: Customer
party_name string
customer_name string
company string required
transaction_date string required
valid_till string
order_type string
Default: Sales
customer_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email 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
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
coupon_code string
referral_sales_partner 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_in_words string
base_rounded_total number
grand_total number
rounding_adjustment number
rounded_total number
in_words string
payment_terms_template string
tc_name string
terms string
letter_head string
group_same_items boolean
Default: false
select_print_heading string
language string
auto_repeat string
order_lost_reason string
enq_det string
supplier_quotation string
opportunity string
company_address string
company_address_display string
scan_barcode string
incoterm string
named_place string
utm_campaign string
utm_source string
utm_medium string
utm_content string
disable_rounded_total boolean
Default: false
company_contact_person string
has_unit_price_items boolean
Default: false
title string
The Quotation object
{
"id": "quotation_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"quotation_to": "Customer",
"party_name": "party_name_example",
"customer_name": "customer_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"valid_till": "valid_till_example",
"order_type": "Sales",
"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]",
"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,
"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,
"coupon_code": "coupon_code_example",
"referral_sales_partner": "referral_sales_partner_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_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"auto_repeat": "auto_repeat_example",
"order_lost_reason": "order_lost_reason_example",
"enq_det": "enq_det_example",
"supplier_quotation": "supplier_quotation_example",
"opportunity": "opportunity_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"scan_barcode": "scan_barcode_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"disable_rounded_total": false,
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"title": "title_example"
} GET
/api/crm/quotation/{id} Retrieve a quotation
Retrieves the details of an existing quotation. Supply the unique quotation ID that was returned from a previous request.
Path parameters
id string required
The identifier of the quotation to retrieve.
Returns
Returns the quotation object if a valid identifier was provided.
GET /api/crm/quotation/{id}
curl https://api.overplane.dev/api/crm/quotation/quotation_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "quotation_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"quotation_to": "Customer",
"party_name": "party_name_example",
"customer_name": "customer_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"valid_till": "valid_till_example",
"order_type": "Sales",
"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]",
"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,
"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,
"coupon_code": "coupon_code_example",
"referral_sales_partner": "referral_sales_partner_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_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"auto_repeat": "auto_repeat_example",
"order_lost_reason": "order_lost_reason_example",
"enq_det": "enq_det_example",
"supplier_quotation": "supplier_quotation_example",
"opportunity": "opportunity_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"scan_barcode": "scan_barcode_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"disable_rounded_total": false,
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"title": "title_example"
} GET
/api/crm/quotation List all quotations
Returns a list of quotations. 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 quotation objects.
GET /api/crm/quotation
curl https://api.overplane.dev/api/crm/quotation \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "quotation_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"quotation_to": "Customer",
"party_name": "party_name_example",
"customer_name": "customer_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"valid_till": "valid_till_example",
"order_type": "Sales",
"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]",
"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,
"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,
"coupon_code": "coupon_code_example",
"referral_sales_partner": "referral_sales_partner_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_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"auto_repeat": "auto_repeat_example",
"order_lost_reason": "order_lost_reason_example",
"enq_det": "enq_det_example",
"supplier_quotation": "supplier_quotation_example",
"opportunity": "opportunity_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"scan_barcode": "scan_barcode_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"disable_rounded_total": false,
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"title": "title_example"
}
],
"has_more": false,
"total": 1
} POST
/api/crm/quotation Create a quotation
Creates a new quotation object.
Body parameters
status string
Default: draft
quotation_to string
Default: Customer
party_name string
customer_name string
company string required
transaction_date string required
valid_till string
order_type string
Default: Sales
customer_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email 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
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
coupon_code string
referral_sales_partner 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_in_words string
base_rounded_total number
grand_total number
rounding_adjustment number
rounded_total number
in_words string
payment_terms_template string
tc_name string
terms string
letter_head string
group_same_items boolean
Default: false
select_print_heading string
language string
auto_repeat string
order_lost_reason string
enq_det string
supplier_quotation string
opportunity string
company_address string
company_address_display string
scan_barcode string
incoterm string
named_place string
utm_campaign string
utm_source string
utm_medium string
utm_content string
disable_rounded_total boolean
Default: false
company_contact_person string
has_unit_price_items boolean
Default: false
title string
Returns
Returns the newly created quotation object if the call succeeded.
POST /api/crm/quotation
curl https://api.overplane.dev/api/crm/quotation \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"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": "quotation_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"quotation_to": "Customer",
"party_name": "party_name_example",
"customer_name": "customer_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"valid_till": "valid_till_example",
"order_type": "Sales",
"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]",
"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,
"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,
"coupon_code": "coupon_code_example",
"referral_sales_partner": "referral_sales_partner_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_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"auto_repeat": "auto_repeat_example",
"order_lost_reason": "order_lost_reason_example",
"enq_det": "enq_det_example",
"supplier_quotation": "supplier_quotation_example",
"opportunity": "opportunity_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"scan_barcode": "scan_barcode_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"disable_rounded_total": false,
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"title": "title_example"
} PATCH
/api/crm/quotation/{id} Update a quotation
Updates the specified quotation 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 quotation to update.
Body parameters
status string
Default: draft
quotation_to string
Default: Customer
party_name string
customer_name string
company string
transaction_date string
valid_till string
order_type string
Default: Sales
customer_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email 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
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
coupon_code string
referral_sales_partner 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_in_words string
base_rounded_total number
grand_total number
rounding_adjustment number
rounded_total number
in_words string
payment_terms_template string
tc_name string
terms string
letter_head string
group_same_items boolean
Default: false
select_print_heading string
language string
auto_repeat string
order_lost_reason string
enq_det string
supplier_quotation string
opportunity string
company_address string
company_address_display string
scan_barcode string
incoterm string
named_place string
utm_campaign string
utm_source string
utm_medium string
utm_content string
disable_rounded_total boolean
Default: false
company_contact_person string
has_unit_price_items boolean
Default: false
title string
Returns
Returns the updated quotation object.
PATCH /api/crm/quotation/{id}
curl https://api.overplane.dev/api/crm/quotation/quotation_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"status":"draft","quotation_to":"Customer"}' Response
{
"id": "quotation_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"quotation_to": "Customer",
"party_name": "party_name_example",
"customer_name": "customer_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"valid_till": "valid_till_example",
"order_type": "Sales",
"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]",
"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,
"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,
"coupon_code": "coupon_code_example",
"referral_sales_partner": "referral_sales_partner_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_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"auto_repeat": "auto_repeat_example",
"order_lost_reason": "order_lost_reason_example",
"enq_det": "enq_det_example",
"supplier_quotation": "supplier_quotation_example",
"opportunity": "opportunity_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"scan_barcode": "scan_barcode_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"disable_rounded_total": false,
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"title": "title_example"
} DELETE
/api/crm/quotation/{id} Delete a quotation
Permanently deletes a quotation. This cannot be undone.
Path parameters
id string required
The identifier of the quotation to delete.
Returns
Returns a confirmation that the quotation has been deleted.
DELETE /api/crm/quotation/{id}
curl https://api.overplane.dev/api/crm/quotation/quotation_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "quotation_abc123",
"deleted": true
} POST
/api/crm/quotation/{id}/submit Submit a quotation
Submits a draft quotation, transitioning its status from draft to submitted.
Path parameters
id string required
The identifier of the quotation to act on.
Returns
Returns the quotation object with updated status.
POST /api/crm/quotation/{id}/submit
curl https://api.overplane.dev/api/crm/quotation/quotation_abc123/submit \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "quotation_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"quotation_to": "Customer",
"party_name": "party_name_example",
"customer_name": "customer_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"valid_till": "valid_till_example",
"order_type": "Sales",
"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]",
"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,
"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,
"coupon_code": "coupon_code_example",
"referral_sales_partner": "referral_sales_partner_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_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"auto_repeat": "auto_repeat_example",
"order_lost_reason": "order_lost_reason_example",
"enq_det": "enq_det_example",
"supplier_quotation": "supplier_quotation_example",
"opportunity": "opportunity_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"scan_barcode": "scan_barcode_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"disable_rounded_total": false,
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"title": "title_example"
} POST
/api/crm/quotation/{id}/cancel Cancel a quotation
Cancels a submitted quotation, transitioning its status to cancelled.
Path parameters
id string required
The identifier of the quotation to act on.
Returns
Returns the quotation object with updated status.
POST /api/crm/quotation/{id}/cancel
curl https://api.overplane.dev/api/crm/quotation/quotation_abc123/cancel \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "quotation_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"quotation_to": "Customer",
"party_name": "party_name_example",
"customer_name": "customer_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"valid_till": "valid_till_example",
"order_type": "Sales",
"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]",
"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,
"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,
"coupon_code": "coupon_code_example",
"referral_sales_partner": "referral_sales_partner_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_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"in_words": "in_words_example",
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"letter_head": "letter_head_example",
"group_same_items": false,
"select_print_heading": "select_print_heading_example",
"language": "language_example",
"auto_repeat": "auto_repeat_example",
"order_lost_reason": "order_lost_reason_example",
"enq_det": "enq_det_example",
"supplier_quotation": "supplier_quotation_example",
"opportunity": "opportunity_example",
"company_address": "Example Corp",
"company_address_display": "Example Corp",
"scan_barcode": "scan_barcode_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"utm_campaign": "utm_campaign_example",
"utm_source": "utm_source_example",
"utm_medium": "utm_medium_example",
"utm_content": "utm_content_example",
"disable_rounded_total": false,
"company_contact_person": "Example Corp",
"has_unit_price_items": false,
"title": "title_example"
}Line items
Child objects that belong to this quotation. These are accessed via the parent's ID.
Quotation Item
Attributes
idx integer
quotation_id string required
item_code string
customer_item_code string
item_name string required
description 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
net_rate number
amount number
net_amount number
base_rate number
base_net_rate number
base_amount number
base_net_amount number
pricing_rules string
is_free_item boolean
weight_per_unit number
total_weight number
weight_uom string
warehouse string
projected_qty number
actual_qty number
prevdoc_doctype string
prevdoc_docname string
item_tax_rate string
item_tax_template string
page_break boolean
item_group string
brand string
additional_notes string
blanket_order string
blanket_order_rate number
against_blanket_order boolean
valuation_rate number
gross_profit number
stock_uom_rate number
is_alternative boolean
has_alternative_item boolean
distributed_discount_amount number
company_total_stock number
ordered_qty number
Endpoints
GET
/api/crm/quotation-item?parent_id={id} POST
/api/crm/quotation-item PATCH
/api/crm/quotation-item/{id} DELETE
/api/crm/quotation-item/{id} POST
/api/crm/quotation-item/reorder Quotation Item object
{
"id": "quotation-item_abc123",
"idx": 1,
"quotation_id": "quotation_id_example",
"item_code": "item_code_example",
"customer_item_code": "customer_item_code_example",
"item_name": "item_name_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,
"net_rate": 0,
"amount": 0,
"net_amount": 0,
"base_rate": 0,
"base_net_rate": 0,
"base_amount": 0,
"base_net_amount": 0,
"pricing_rules": "pricing_rules_example",
"is_free_item": false,
"weight_per_unit": 0,
"total_weight": 0,
"weight_uom": "weight_uom_example",
"warehouse": "warehouse_example",
"projected_qty": 0,
"actual_qty": 0,
"prevdoc_doctype": "prevdoc_doctype_example",
"prevdoc_docname": "prevdoc_docname_example",
"item_tax_rate": "item_tax_rate_example",
"item_tax_template": "item_tax_template_example",
"page_break": false,
"item_group": "item_group_example",
"brand": "brand_example",
"additional_notes": "additional_notes_example",
"blanket_order": "blanket_order_example",
"blanket_order_rate": 0,
"against_blanket_order": false,
"valuation_rate": 0,
"gross_profit": 0,
"stock_uom_rate": 0,
"is_alternative": false,
"has_alternative_item": false,
"distributed_discount_amount": 0,
"company_total_stock": 0,
"ordered_qty": 0
}Quotation Lost Reason Detail
Attributes
idx integer
quotation_id string required
lost_reason string
Endpoints
GET
/api/crm/quotation-lost-reason-detail?parent_id={id} POST
/api/crm/quotation-lost-reason-detail PATCH
/api/crm/quotation-lost-reason-detail/{id} DELETE
/api/crm/quotation-lost-reason-detail/{id} POST
/api/crm/quotation-lost-reason-detail/reorder Quotation Lost Reason Detail object
{
"id": "quotation-lost-reason-detail_abc123",
"idx": 1,
"quotation_id": "quotation_id_example",
"lost_reason": "lost_reason_example"
}