The Request For 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

company string required
vendor string
transaction_date string required
email_template string
message_for_supplier string

Default: Please supply the specified items at the best possible rates

tc_name string
terms string
select_print_heading string
letter_head string
opportunity string
schedule_date string
incoterm string
named_place string
send_attached_files boolean

Default: true

send_document_print boolean

Default: false

billing_address string
billing_address_display string
has_unit_price_items boolean

Default: false

subject string

Default: Request for Quotation

mfs_html string
use_html boolean

Default: false

shipping_address string
shipping_address_display string
title string
The Request For Quotation object 
{
  "id": "request-for-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "vendor": "vendor_example",
  "transaction_date": "2024-01-15",
  "email_template": "user@example.com",
  "message_for_supplier": "Please supply the specified items at the best possible rates",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "opportunity": "opportunity_example",
  "schedule_date": "2024-01-15",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "send_attached_files": true,
  "send_document_print": false,
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "has_unit_price_items": false,
  "subject": "Request for Quotation",
  "mfs_html": "mfs_html_example",
  "use_html": false,
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "title": "title_example"
}
GET /api/buying/request-for-quotation/{id}

Retrieve a request for quotation

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

Path parameters

id string required

The identifier of the request for quotation to retrieve.

Returns

Returns the request for quotation object if a valid identifier was provided.

GET /api/buying/request-for-quotation/{id} 
curl https://api.overplane.dev/api/buying/request-for-quotation/request-for-quotation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "request-for-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "vendor": "vendor_example",
  "transaction_date": "2024-01-15",
  "email_template": "user@example.com",
  "message_for_supplier": "Please supply the specified items at the best possible rates",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "opportunity": "opportunity_example",
  "schedule_date": "2024-01-15",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "send_attached_files": true,
  "send_document_print": false,
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "has_unit_price_items": false,
  "subject": "Request for Quotation",
  "mfs_html": "mfs_html_example",
  "use_html": false,
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "title": "title_example"
}
GET /api/buying/request-for-quotation

List all request for quotations

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

GET /api/buying/request-for-quotation 
curl https://api.overplane.dev/api/buying/request-for-quotation \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "request-for-quotation_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "vendor": "vendor_example",
      "transaction_date": "2024-01-15",
      "email_template": "user@example.com",
      "message_for_supplier": "Please supply the specified items at the best possible rates",
      "tc_name": "tc_name_example",
      "terms": "terms_example",
      "select_print_heading": "select_print_heading_example",
      "letter_head": "letter_head_example",
      "opportunity": "opportunity_example",
      "schedule_date": "2024-01-15",
      "incoterm": "incoterm_example",
      "named_place": "named_place_example",
      "send_attached_files": true,
      "send_document_print": false,
      "billing_address": "billing_address_example",
      "billing_address_display": "billing_address_display_example",
      "has_unit_price_items": false,
      "subject": "Request for Quotation",
      "mfs_html": "mfs_html_example",
      "use_html": false,
      "shipping_address": "shipping_address_example",
      "shipping_address_display": "shipping_address_display_example",
      "title": "title_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/request-for-quotation

Create a request for quotation

Creates a new request for quotation object.

Body parameters

status string

Default: draft

company string required
vendor string
transaction_date string required
email_template string
message_for_supplier string

Default: Please supply the specified items at the best possible rates

tc_name string
terms string
select_print_heading string
letter_head string
opportunity string
schedule_date string
incoterm string
named_place string
send_attached_files boolean

Default: true

send_document_print boolean

Default: false

billing_address string
billing_address_display string
has_unit_price_items boolean

Default: false

subject string

Default: Request for Quotation

mfs_html string
use_html boolean

Default: false

shipping_address string
shipping_address_display string
title string

Returns

Returns the newly created request for quotation object if the call succeeded.

POST /api/buying/request-for-quotation 
curl https://api.overplane.dev/api/buying/request-for-quotation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","transaction_date":"2024-01-15"}'
Response 
{
  "id": "request-for-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "vendor": "vendor_example",
  "transaction_date": "2024-01-15",
  "email_template": "user@example.com",
  "message_for_supplier": "Please supply the specified items at the best possible rates",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "opportunity": "opportunity_example",
  "schedule_date": "2024-01-15",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "send_attached_files": true,
  "send_document_print": false,
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "has_unit_price_items": false,
  "subject": "Request for Quotation",
  "mfs_html": "mfs_html_example",
  "use_html": false,
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "title": "title_example"
}
PATCH /api/buying/request-for-quotation/{id}

Update a request for quotation

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

Body parameters

status string

Default: draft

company string
vendor string
transaction_date string
email_template string
message_for_supplier string

Default: Please supply the specified items at the best possible rates

tc_name string
terms string
select_print_heading string
letter_head string
opportunity string
schedule_date string
incoterm string
named_place string
send_attached_files boolean

Default: true

send_document_print boolean

Default: false

billing_address string
billing_address_display string
has_unit_price_items boolean

Default: false

subject string

Default: Request for Quotation

mfs_html string
use_html boolean

Default: false

shipping_address string
shipping_address_display string
title string

Returns

Returns the updated request for quotation object.

PATCH /api/buying/request-for-quotation/{id} 
curl https://api.overplane.dev/api/buying/request-for-quotation/request-for-quotation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "request-for-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "vendor": "vendor_example",
  "transaction_date": "2024-01-15",
  "email_template": "user@example.com",
  "message_for_supplier": "Please supply the specified items at the best possible rates",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "opportunity": "opportunity_example",
  "schedule_date": "2024-01-15",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "send_attached_files": true,
  "send_document_print": false,
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "has_unit_price_items": false,
  "subject": "Request for Quotation",
  "mfs_html": "mfs_html_example",
  "use_html": false,
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "title": "title_example"
}
DELETE /api/buying/request-for-quotation/{id}

Delete a request for quotation

Permanently deletes a request for quotation. This cannot be undone.

Path parameters

id string required

The identifier of the request for quotation to delete.

Returns

Returns a confirmation that the request for quotation has been deleted.

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

Submit a request for quotation

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

Path parameters

id string required

The identifier of the request for quotation to act on.

Returns

Returns the request for quotation object with updated status.

POST /api/buying/request-for-quotation/{id}/submit 
curl https://api.overplane.dev/api/buying/request-for-quotation/request-for-quotation_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "request-for-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "vendor": "vendor_example",
  "transaction_date": "2024-01-15",
  "email_template": "user@example.com",
  "message_for_supplier": "Please supply the specified items at the best possible rates",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "opportunity": "opportunity_example",
  "schedule_date": "2024-01-15",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "send_attached_files": true,
  "send_document_print": false,
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "has_unit_price_items": false,
  "subject": "Request for Quotation",
  "mfs_html": "mfs_html_example",
  "use_html": false,
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "title": "title_example"
}
POST /api/buying/request-for-quotation/{id}/cancel

Cancel a request for quotation

Cancels a submitted request for quotation, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the request for quotation to act on.

Returns

Returns the request for quotation object with updated status.

POST /api/buying/request-for-quotation/{id}/cancel 
curl https://api.overplane.dev/api/buying/request-for-quotation/request-for-quotation_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "request-for-quotation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "vendor": "vendor_example",
  "transaction_date": "2024-01-15",
  "email_template": "user@example.com",
  "message_for_supplier": "Please supply the specified items at the best possible rates",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "select_print_heading": "select_print_heading_example",
  "letter_head": "letter_head_example",
  "opportunity": "opportunity_example",
  "schedule_date": "2024-01-15",
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "send_attached_files": true,
  "send_document_print": false,
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "has_unit_price_items": false,
  "subject": "Request for Quotation",
  "mfs_html": "mfs_html_example",
  "use_html": false,
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "title": "title_example"
}

Line items

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

Request For Quotation Item

Attributes

idx integer
request_for_quotation_id string required
item_code string required
supplier_part_no string
item_name string
description string
image string
image_view string
qty number required
schedule_date string required
uom string required
warehouse string
project_name string
material_request string
material_request_item string
brand string
item_group string
page_break boolean
stock_uom string required
conversion_factor number required
stock_qty number

Endpoints

GET /api/buying/request-for-quotation-item?parent_id={id}
POST /api/buying/request-for-quotation-item
PATCH /api/buying/request-for-quotation-item/{id}
DELETE /api/buying/request-for-quotation-item/{id}
POST /api/buying/request-for-quotation-item/reorder
Request For Quotation Item object 
{
  "id": "request-for-quotation-item_abc123",
  "idx": 1,
  "request_for_quotation_id": "request_for_quotation_id_example",
  "item_code": "item_code_example",
  "supplier_part_no": "supplier_part_no_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "qty": 0,
  "schedule_date": "2024-01-15",
  "uom": "uom_example",
  "warehouse": "warehouse_example",
  "project_name": "project_name_example",
  "material_request": "material_request_example",
  "material_request_item": "material_request_item_example",
  "brand": "brand_example",
  "item_group": "item_group_example",
  "page_break": false,
  "stock_uom": "stock_uom_example",
  "conversion_factor": 0,
  "stock_qty": 0
}

Request For Quotation Supplier

Attributes

idx integer
request_for_quotation_id string required
send_email boolean
email_sent boolean
supplier string required
contact string
quote_status string
supplier_name string
email_id string

Endpoints

GET /api/buying/request-for-quotation-supplier?parent_id={id}
POST /api/buying/request-for-quotation-supplier
PATCH /api/buying/request-for-quotation-supplier/{id}
DELETE /api/buying/request-for-quotation-supplier/{id}
POST /api/buying/request-for-quotation-supplier/reorder
Request For Quotation Supplier object 
{
  "id": "request-for-quotation-supplier_abc123",
  "idx": 1,
  "request_for_quotation_id": "request_for_quotation_id_example",
  "send_email": true,
  "email_sent": false,
  "supplier": "supplier_example",
  "contact": "contact_example",
  "quote_status": "quote_status_example",
  "supplier_name": "supplier_name_example",
  "email_id": "user@example.com"
}