The Supplier 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

title string
supplier string required
supplier_name string
transaction_date string required
company string required
supplier_address string
contact_person string
address_display string
contact_display string
contact_mobile string
contact_email string
currency string required
conversion_rate number required
buying_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_taxes_and_charges_added number
base_taxes_and_charges_deducted number
base_total_taxes_and_charges number
taxes_and_charges_added number
taxes_and_charges_deducted 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_in_words string
base_rounded_total number
grand_total number
rounding_adjustment number
rounded_total number
in_words string
disable_rounded_total boolean

Default: false

tc_name string
terms string
select_print_heading string
group_same_items boolean

Default: false

letter_head string
language string
auto_repeat string
is_subcontracted boolean

Default: false

opportunity string
valid_till string
quotation_number string
incoterm string
named_place string
shipping_address string
shipping_address_display string
billing_address string
billing_address_display string
cost_center string
project string
has_unit_price_items boolean

Default: false

The Supplier Quotation object
{
  "id": "supplier-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "transaction_date": "2024-01-15",
  "company": "Example Corp",
  "supplier_address": "supplier_address_example",
  "contact_person": "contact_person_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_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_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 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_in_words": "base_in_words_example",
  "base_rounded_total": 0,
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "disable_rounded_total": false,
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "group_same_items": false,
  "letter_head": "letter_head_example",
  "language": "language_example",
  "auto_repeat": "auto_repeat_example",
  "is_subcontracted": false,
  "opportunity": "opportunity_example",
  "valid_till": "valid_till_example",
  "quotation_number": "quotation_number_example",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "has_unit_price_items": false
}
GET /api/buying/supplier-quotation/{id}

Retrieve a supplier quotation

Retrieves the details of an existing supplier quotation. Supply the unique supplier quotation ID that was returned from a previous request.

Path parameters

id string required

The identifier of the supplier quotation to retrieve.

Returns

Returns the supplier quotation object if a valid identifier was provided.

GET /api/buying/supplier-quotation/{id}
curl https://api.overplane.dev/api/buying/supplier-quotation/supplier-quotation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response
{
  "id": "supplier-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "transaction_date": "2024-01-15",
  "company": "Example Corp",
  "supplier_address": "supplier_address_example",
  "contact_person": "contact_person_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_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_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 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_in_words": "base_in_words_example",
  "base_rounded_total": 0,
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "disable_rounded_total": false,
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "group_same_items": false,
  "letter_head": "letter_head_example",
  "language": "language_example",
  "auto_repeat": "auto_repeat_example",
  "is_subcontracted": false,
  "opportunity": "opportunity_example",
  "valid_till": "valid_till_example",
  "quotation_number": "quotation_number_example",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "has_unit_price_items": false
}
GET /api/buying/supplier-quotation

List all supplier quotations

Returns a list of supplier 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 supplier quotation objects.

GET /api/buying/supplier-quotation
curl https://api.overplane.dev/api/buying/supplier-quotation \
  -H "Authorization: Bearer sk_test_..."
Response
{
  "data": [
    {
      "id": "supplier-quotation_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "title": "title_example",
      "supplier": "supplier_example",
      "supplier_name": "supplier_name_example",
      "transaction_date": "2024-01-15",
      "company": "Example Corp",
      "supplier_address": "supplier_address_example",
      "contact_person": "contact_person_example",
      "address_display": "address_display_example",
      "contact_display": "contact_display_example",
      "contact_mobile": "contact_mobile_example",
      "contact_email": "user@example.com",
      "currency": "USD",
      "conversion_rate": 0,
      "buying_price_list": "buying_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_taxes_and_charges_added": 0,
      "base_taxes_and_charges_deducted": 0,
      "base_total_taxes_and_charges": 0,
      "taxes_and_charges_added": 0,
      "taxes_and_charges_deducted": 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_in_words": "base_in_words_example",
      "base_rounded_total": 0,
      "grand_total": 0,
      "rounding_adjustment": 0,
      "rounded_total": 0,
      "in_words": "in_words_example",
      "disable_rounded_total": false,
      "tc_name": "tc_name_example",
      "terms": "terms_example",
      "select_print_heading": "select_print_heading_example",
      "group_same_items": false,
      "letter_head": "letter_head_example",
      "language": "language_example",
      "auto_repeat": "auto_repeat_example",
      "is_subcontracted": false,
      "opportunity": "opportunity_example",
      "valid_till": "valid_till_example",
      "quotation_number": "quotation_number_example",
      "incoterm": "incoterm_example",
      "named_place": "named_place_example",
      "shipping_address": "shipping_address_example",
      "shipping_address_display": "shipping_address_display_example",
      "billing_address": "billing_address_example",
      "billing_address_display": "billing_address_display_example",
      "cost_center": "cost_center_example",
      "project": "project_example",
      "has_unit_price_items": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/supplier-quotation

Create a supplier quotation

Creates a new supplier quotation object.

Body parameters

status string

Default: draft

title string
supplier string required
supplier_name string
transaction_date string required
company string required
supplier_address string
contact_person string
address_display string
contact_display string
contact_mobile string
contact_email string
currency string required
conversion_rate number required
buying_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_taxes_and_charges_added number
base_taxes_and_charges_deducted number
base_total_taxes_and_charges number
taxes_and_charges_added number
taxes_and_charges_deducted 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_in_words string
base_rounded_total number
grand_total number
rounding_adjustment number
rounded_total number
in_words string
disable_rounded_total boolean

Default: false

tc_name string
terms string
select_print_heading string
group_same_items boolean

Default: false

letter_head string
language string
auto_repeat string
is_subcontracted boolean

Default: false

opportunity string
valid_till string
quotation_number string
incoterm string
named_place string
shipping_address string
shipping_address_display string
billing_address string
billing_address_display string
cost_center string
project string
has_unit_price_items boolean

Default: false

Returns

Returns the newly created supplier quotation object if the call succeeded.

POST /api/buying/supplier-quotation
curl https://api.overplane.dev/api/buying/supplier-quotation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"supplier":"supplier_example","transaction_date":"2024-01-15","company":"Example Corp","currency":"USD","conversion_rate":0}'
Response
{
  "id": "supplier-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "transaction_date": "2024-01-15",
  "company": "Example Corp",
  "supplier_address": "supplier_address_example",
  "contact_person": "contact_person_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_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_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 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_in_words": "base_in_words_example",
  "base_rounded_total": 0,
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "disable_rounded_total": false,
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "group_same_items": false,
  "letter_head": "letter_head_example",
  "language": "language_example",
  "auto_repeat": "auto_repeat_example",
  "is_subcontracted": false,
  "opportunity": "opportunity_example",
  "valid_till": "valid_till_example",
  "quotation_number": "quotation_number_example",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "has_unit_price_items": false
}
PATCH /api/buying/supplier-quotation/{id}

Update a supplier quotation

Updates the specified supplier 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 supplier quotation to update.

Body parameters

status string

Default: draft

title string
supplier string
supplier_name string
transaction_date string
company string
supplier_address string
contact_person string
address_display string
contact_display string
contact_mobile string
contact_email string
currency string
conversion_rate number
buying_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_taxes_and_charges_added number
base_taxes_and_charges_deducted number
base_total_taxes_and_charges number
taxes_and_charges_added number
taxes_and_charges_deducted 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_in_words string
base_rounded_total number
grand_total number
rounding_adjustment number
rounded_total number
in_words string
disable_rounded_total boolean

Default: false

tc_name string
terms string
select_print_heading string
group_same_items boolean

Default: false

letter_head string
language string
auto_repeat string
is_subcontracted boolean

Default: false

opportunity string
valid_till string
quotation_number string
incoterm string
named_place string
shipping_address string
shipping_address_display string
billing_address string
billing_address_display string
cost_center string
project string
has_unit_price_items boolean

Default: false

Returns

Returns the updated supplier quotation object.

PATCH /api/buying/supplier-quotation/{id}
curl https://api.overplane.dev/api/buying/supplier-quotation/supplier-quotation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","title":"title_example"}'
Response
{
  "id": "supplier-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "transaction_date": "2024-01-15",
  "company": "Example Corp",
  "supplier_address": "supplier_address_example",
  "contact_person": "contact_person_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_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_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 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_in_words": "base_in_words_example",
  "base_rounded_total": 0,
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "disable_rounded_total": false,
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "group_same_items": false,
  "letter_head": "letter_head_example",
  "language": "language_example",
  "auto_repeat": "auto_repeat_example",
  "is_subcontracted": false,
  "opportunity": "opportunity_example",
  "valid_till": "valid_till_example",
  "quotation_number": "quotation_number_example",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "has_unit_price_items": false
}
DELETE /api/buying/supplier-quotation/{id}

Delete a supplier quotation

Permanently deletes a supplier quotation. This cannot be undone.

Path parameters

id string required

The identifier of the supplier quotation to delete.

Returns

Returns a confirmation that the supplier quotation has been deleted.

DELETE /api/buying/supplier-quotation/{id}
curl https://api.overplane.dev/api/buying/supplier-quotation/supplier-quotation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response
{
  "id": "supplier-quotation_abc123",
  "deleted": true
}
POST /api/buying/supplier-quotation/{id}/submit

Submit a supplier quotation

Submits a draft supplier quotation, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the supplier quotation to act on.

Returns

Returns the supplier quotation object with updated status.

POST /api/buying/supplier-quotation/{id}/submit
curl https://api.overplane.dev/api/buying/supplier-quotation/supplier-quotation_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response
{
  "id": "supplier-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "transaction_date": "2024-01-15",
  "company": "Example Corp",
  "supplier_address": "supplier_address_example",
  "contact_person": "contact_person_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_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_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 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_in_words": "base_in_words_example",
  "base_rounded_total": 0,
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "disable_rounded_total": false,
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "group_same_items": false,
  "letter_head": "letter_head_example",
  "language": "language_example",
  "auto_repeat": "auto_repeat_example",
  "is_subcontracted": false,
  "opportunity": "opportunity_example",
  "valid_till": "valid_till_example",
  "quotation_number": "quotation_number_example",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "has_unit_price_items": false
}
POST /api/buying/supplier-quotation/{id}/cancel

Cancel a supplier quotation

Cancels a submitted supplier quotation, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the supplier quotation to act on.

Returns

Returns the supplier quotation object with updated status.

POST /api/buying/supplier-quotation/{id}/cancel
curl https://api.overplane.dev/api/buying/supplier-quotation/supplier-quotation_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response
{
  "id": "supplier-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "transaction_date": "2024-01-15",
  "company": "Example Corp",
  "supplier_address": "supplier_address_example",
  "contact_person": "contact_person_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_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_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 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_in_words": "base_in_words_example",
  "base_rounded_total": 0,
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "disable_rounded_total": false,
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "group_same_items": false,
  "letter_head": "letter_head_example",
  "language": "language_example",
  "auto_repeat": "auto_repeat_example",
  "is_subcontracted": false,
  "opportunity": "opportunity_example",
  "valid_till": "valid_till_example",
  "quotation_number": "quotation_number_example",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "has_unit_price_items": false
}

Line items

Child objects that belong to this supplier quotation. These are accessed via the parent's ID.

Supplier Quotation Item

Attributes

idx integer
supplier_quotation_id string required
item_code string required
supplier_part_no string
item_name string
lead_time_days integer
description string
image string
image_view string
qty number required
stock_uom string required
price_list_rate number
discount_percentage number
discount_amount number
uom string required
conversion_factor number required
stock_qty number
base_price_list_rate number
rate number
amount number
base_rate number required
base_amount number required
pricing_rules string
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
project string
prevdoc_doctype string
material_request string
sales_order string
request_for_quotation string
item_tax_template string
material_request_item string
request_for_quotation_item string
brand string
item_group string
item_tax_rate string
page_break boolean
manufacturer string
manufacturer_part_no string
is_free_item boolean
expected_delivery_date string
cost_center string
distributed_discount_amount number
margin_type string
margin_rate_or_amount number
rate_with_margin number

Endpoints

GET /api/buying/supplier-quotation-item?parent_id={id}
POST /api/buying/supplier-quotation-item
PATCH /api/buying/supplier-quotation-item/{id}
DELETE /api/buying/supplier-quotation-item/{id}
POST /api/buying/supplier-quotation-item/reorder
Supplier Quotation Item object
{
  "id": "supplier-quotation-item_abc123",
  "idx": 1,
  "supplier_quotation_id": "supplier_quotation_id_example",
  "item_code": "item_code_example",
  "supplier_part_no": "supplier_part_no_example",
  "item_name": "item_name_example",
  "lead_time_days": 0,
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "qty": 0,
  "stock_uom": "stock_uom_example",
  "price_list_rate": 0,
  "discount_percentage": 0,
  "discount_amount": 0,
  "uom": "uom_example",
  "conversion_factor": 0,
  "stock_qty": 0,
  "base_price_list_rate": 0,
  "rate": 0,
  "amount": 0,
  "base_rate": 0,
  "base_amount": 0,
  "pricing_rules": "pricing_rules_example",
  "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",
  "project": "project_example",
  "prevdoc_doctype": "prevdoc_doctype_example",
  "material_request": "material_request_example",
  "sales_order": "sales_order_example",
  "request_for_quotation": "request_for_quotation_example",
  "item_tax_template": "item_tax_template_example",
  "material_request_item": "material_request_item_example",
  "request_for_quotation_item": "request_for_quotation_item_example",
  "brand": "brand_example",
  "item_group": "item_group_example",
  "item_tax_rate": "item_tax_rate_example",
  "page_break": false,
  "manufacturer": "manufacturer_example",
  "manufacturer_part_no": "manufacturer_part_no_example",
  "is_free_item": false,
  "expected_delivery_date": "2024-01-15",
  "cost_center": "cost_center_example",
  "distributed_discount_amount": 0,
  "margin_type": "margin_type_example",
  "margin_rate_or_amount": 0,
  "rate_with_margin": 0
}