Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Financial Management

RFQs

13 endpoints5 implementedAll modules →
  1. GET /rest/v1.0/rfqsList RFQs
  2. POST /rest/v1.0/rfqsCreate RFQ
  3. GET /rest/v1.0/rfqs/{id}Show RFQ
  4. PATCH /rest/v1.0/rfqs/{id}Update RFQ
  5. DELETE /rest/v1.0/rfqs/{id}Delete RFQ
  6. GET /rest/v1.0/rfqs/{rfq_id}/quotesList RFQ Quotes
  7. POST /rest/v1.0/rfqs/{rfq_id}/quotesCreate RFQ Quote
  8. GET /rest/v1.0/rfqs/{rfq_id}/quotes/{id}Show RFQ Quote
  9. PATCH /rest/v1.0/rfqs/{rfq_id}/quotes/{id}Update RFQ Quote
  10. GET /rest/v1.0/rfqs/{rfq_id}/responsesList RFQ Responses
  11. POST /rest/v1.0/rfqs/{rfq_id}/responsesCreate RFQ Response
  12. GET /rest/v1.0/rfqs/{rfq_id}/responses/{id}Show RFQ Response
  13. PATCH /rest/v1.0/rfqs/{rfq_id}/responses/{id}Update RFQ Response
GET /rest/v1.0/rfqs

List RFQs

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • contract_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[status]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • filters[commitment_contract_id]
    integerquery

Response · 200 · object[]

  • id
    integer
  • commitment_contract_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • due_date
    string (date)
  • estimated_amount
    number (float)
  • estimated_schedule_impact
    integer
  • estimated_status
    string
  • intent_to_quote
    boolean
  • number
    string
  • original_quote
    number (float)
  • position
    integer
  • private
    boolean
  • prostore_file_ids
    integer[]
  • status
    string
  • title
    string
  • updated_at
    string (date-time)
  • specification_section
    object
  • quotes
    object[]
  • responses
    object[]
  • potential_change_orders
    object
  • change_order_packages
    object
  • commitment_potential_change_orders
    object
  • commitment_change_order_packages
    object
  • created_by
    object
  • assigned
    object
  • location
    object
  • cost_code
    object
  • change_event
    object
  • currency_configuration
    object
POST /rest/v1.0/rfqs

Create RFQ

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired

Request body

  • project_id
    integerrequired
  • contract_id
    integerrequired
  • rfq
    objectrequired

Response · 201 · object

  • id
    integer
  • commitment_contract_id
    integer
  • created_at
    string (date-time)
  • due_date
    string (date)
  • estimated_amount
    number (float)
  • estimated_schedule_impact
    integer
  • estimated_status
    string
  • intent_to_quote
    boolean
  • number
    string
  • original_quote
    number (float)
  • position
    integer
  • private
    boolean
  • prostore_file_ids
    integer[]
  • status
    string
  • title
    string
  • updated_at
    string (date-time)
  • specification_section
    object
  • created_by
    object
  • assigned
    object
  • location
    object
  • cost_code
    object
  • currency_configuration
    object
GET /rest/v1.0/rfqs/{id}

Show RFQ

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired
  • contract_id
    integerqueryrequired

Response · 200 · object

  • id
    integer
  • commitment_contract_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • due_date
    string (date)
  • estimated_amount
    number (float)
  • estimated_schedule_impact
    integer
  • estimated_status
    string
  • intent_to_quote
    boolean
  • number
    string
  • original_quote
    number (float)
  • position
    integer
  • private
    boolean
  • prostore_file_ids
    integer[]
  • status
    string
  • title
    string
  • updated_at
    string (date-time)
  • specification_section
    object
  • quotes
    object[]
  • responses
    object[]
  • potential_change_orders
    object
  • change_order_packages
    object
  • commitment_potential_change_orders
    object
  • commitment_change_order_packages
    object
  • created_by
    object
  • assigned
    object
  • location
    object
  • cost_code
    object
  • change_event
    object
  • currency_configuration
    object
PATCH /rest/v1.0/rfqs/{id}

Update RFQ

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • contract_id
    integerrequired
  • rfq
    objectrequired

Response · 200 · object

  • id
    integer
  • commitment_contract_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • due_date
    string (date)
  • estimated_amount
    number (float)
  • estimated_schedule_impact
    integer
  • estimated_status
    string
  • intent_to_quote
    boolean
  • number
    string
  • original_quote
    number (float)
  • position
    integer
  • private
    boolean
  • prostore_file_ids
    integer[]
  • status
    string
  • title
    string
  • updated_at
    string (date-time)
  • specification_section
    object
  • quotes
    object[]
  • responses
    object[]
  • potential_change_orders
    object
  • change_order_packages
    object
  • commitment_potential_change_orders
    object
  • commitment_change_order_packages
    object
  • created_by
    object
  • assigned
    object
  • location
    object
  • cost_code
    object
  • change_event
    object
  • currency_configuration
    object
DELETE /rest/v1.0/rfqs/{id}

Delete RFQ

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired
  • contract_id
    integerqueryrequired

Response · 200

No response body.

GET /rest/v1.0/rfqs/{rfq_id}/quotes

List RFQ Quotes

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • rfq_id
    integerpathrequired
  • project_id
    integerqueryrequired
  • contract_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • commitment_quote_number
    string
  • cost
    number (float)
  • schedule_impact
    integer
  • request_for_quote_id
    integer
  • attachments_count
    integer
  • import_origin_id
    string
  • created_by_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • prostore_file_ids
    integer[]
  • created_by
    object
  • attachments
    object[]
POST /rest/v1.0/rfqs/{rfq_id}/quotes

Create RFQ Quote

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • rfq_id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • contract_id
    integerrequired
  • rfq_quote
    objectrequired

Response · 201 · object

  • id
    integer
  • commitment_quote_number
    string
  • cost
    number (float)
  • schedule_impact
    integer
  • request_for_quote_id
    integer
  • attachments_count
    integer
  • import_origin_id
    string
  • created_by_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • prostore_file_ids
    integer[]
  • created_by
    object
  • attachments
    object[]
GET /rest/v1.0/rfqs/{rfq_id}/quotes/{id}

Show RFQ Quote

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • rfq_id
    integerpathrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired
  • contract_id
    integerqueryrequired

Response · 200 · object

  • id
    integer
  • commitment_quote_number
    string
  • cost
    number (float)
  • schedule_impact
    integer
  • request_for_quote_id
    integer
  • attachments_count
    integer
  • import_origin_id
    string
  • created_by_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • prostore_file_ids
    integer[]
  • created_by
    object
  • attachments
    object[]
PATCH /rest/v1.0/rfqs/{rfq_id}/quotes/{id}

Update RFQ Quote

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • rfq_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • contract_id
    integerrequired
  • rfq_quote
    objectrequired

Response · 200 · object

  • id
    integer
  • commitment_quote_number
    string
  • cost
    number (float)
  • schedule_impact
    integer
  • request_for_quote_id
    integer
  • attachments_count
    integer
  • import_origin_id
    string
  • created_by_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • prostore_file_ids
    integer[]
  • created_by
    object
  • attachments
    object[]
GET /rest/v1.0/rfqs/{rfq_id}/responses

List RFQ Responses

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • rfq_id
    integerpathrequired
  • project_id
    integerqueryrequired
  • contract_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • comment
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • prostore_file_ids
    integer[]
  • created_by
    object
  • attachments
    object[]
POST /rest/v1.0/rfqs/{rfq_id}/responses

Create RFQ Response

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • rfq_id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • contract_id
    integerrequired
  • rfq_response
    objectrequired

Response · 201 · object

  • id
    integer
  • comment
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • prostore_file_ids
    integer[]
  • created_by
    object
  • attachments
    object[]
GET /rest/v1.0/rfqs/{rfq_id}/responses/{id}

Show RFQ Response

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • rfq_id
    integerpathrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired
  • contract_id
    integerqueryrequired

Response · 200 · object

  • id
    integer
  • comment
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • prostore_file_ids
    integer[]
  • created_by
    object
  • attachments
    object[]
PATCH /rest/v1.0/rfqs/{rfq_id}/responses/{id}

Update RFQ Response

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • rfq_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • contract_id
    integerrequired
  • rfq_response
    objectrequired

Response · 200 · object

  • id
    integer
  • comment
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • prostore_file_ids
    integer[]
  • created_by
    object
  • attachments
    object[]

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file