Change Orders

List Change Order Packages

Parameters

• OS-Company-Id

  integerheaderrequired
• project_id

  integerqueryrequired
• contract_id

  integerquery
• filters[id]

  integer[]query
• filters[created_at]

  string (date)query
• filters[updated_at]

  string (date)query
• filters[reviewed_at]

  stringquery
• filters[due_date]

  stringquery
• filters[include_deleted]

  stringquery
• filters[invoiced_date]

  stringquery
• filters[paid_date]

  stringquery
• filters[signed_change_order_received_date]

  stringquery
• page

  integerquery
• per_page

  integerquery

Response · 200 · object[]

• id

  integer
• contract

  object
• contract_id

  integer
• created_at

  string (date-time)
• created_by_id

  integer
• deleted_at

  string (date-time)
• due_date

  string (date)
• executed

  boolean
• invoiced_date

  string (date)
• number

  string
• origin_code

  string
• origin_data

  string
• origin_id

  string
• paid_date

  string (date)
• reviewed_at

  string (date-time)
• signed_change_order_received_date

  string (date)
• status

  string
• title

  string
• updated_at

  string (date-time)
• revision

  integer
• grand_total

  string
• designated_reviewer

  object
• currency_configuration

  object
• custom_fields

  object

Create Change Order Package

Parameters

• OS-Company-Id

  integerheaderrequired

Request body

• project_id

  integerrequired
• contract_id

  integerrequired
• change_order

  objectrequired

Response · 201 · object

• id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• due_date

  string (date)
• executed

  boolean
• grand_total

  string
• invoiced_date

  string (date)
• number

  string
• origin_code

  string
• origin_data

  string
• origin_id

  string
• paid_date

  string (date)
• position

  integer
• private

  boolean
• review_notes

  string
• reviewed_at

  string (date-time)
• revised_substantial_completion_date

  string (date)
• revision

  integer
• schedule_impact_amount

  integer
• signed_change_order_received_date

  string (date)
• status

  string
• title

  string
• type

  string
• updated_at

  string (date-time)
• creator

  object
• designated_reviewer

  object
• reviewer

  object
• attachments

  object[]
• line_items

  object[]
• currency_configuration

  object
• custom_fields

  object

Show Change Order Package

Parameters

• OS-Company-Id

  integerheaderrequired
• id

  integerpathrequired
• project_id

  integerqueryrequired
• contract_id

  integerquery

Response · 200 · object

• id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• due_date

  string (date)
• executed

  boolean
• grand_total

  string
• invoiced_date

  string (date)
• number

  string
• origin_code

  string
• origin_data

  string
• origin_id

  string
• paid_date

  string (date)
• position

  integer
• private

  boolean
• review_notes

  string
• reviewed_at

  string (date-time)
• revised_substantial_completion_date

  string (date)
• revision

  integer
• schedule_impact_amount

  integer
• signed_change_order_received_date

  string (date)
• status

  string
• title

  string
• type

  string
• updated_at

  string (date-time)
• creator

  object
• designated_reviewer

  object
• reviewer

  object
• attachments

  object[]
• line_items

  object[]
• currency_configuration

  object
• custom_fields

  object

Update Change Order Package

Parameters

• OS-Company-Id

  integerheaderrequired
• id

  integerpathrequired

Request body

• project_id

  integerrequired
• contract_id

  integer
• change_order

  objectrequired

Response · 200 · object

• id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• due_date

  string (date)
• executed

  boolean
• grand_total

  string
• invoiced_date

  string (date)
• number

  string
• origin_code

  string
• origin_data

  string
• origin_id

  string
• paid_date

  string (date)
• position

  integer
• private

  boolean
• review_notes

  string
• reviewed_at

  string (date-time)
• revised_substantial_completion_date

  string (date)
• revision

  integer
• schedule_impact_amount

  integer
• signed_change_order_received_date

  string (date)
• status

  string
• title

  string
• type

  string
• updated_at

  string (date-time)
• creator

  object
• designated_reviewer

  object
• reviewer

  object
• attachments

  object[]
• line_items

  object[]
• currency_configuration

  object
• custom_fields

  object

List Change Order Requests

Parameters

• OS-Company-Id

  integerheaderrequired
• project_id

  integerqueryrequired
• contract_id

  integerqueryrequired
• view

  stringquery
• filters[id]

  integer[]query
• filters[created_at]

  string (date)query
• filters[updated_at]

  string (date)query
• filters[due_date]

  stringquery
• filters[invoiced_date]

  stringquery
• filters[paid_date]

  stringquery
• filters[change_order_package_id]

  integerquery
• page

  integerquery
• per_page

  integerquery
• filters[status]

  string[]query
• filters[not_status]

  string[]query

Response · 200 · object[]

• id

  integer
• created_at

  string (date-time)
• created_by_id

  integer
• deleted_at

  string (date-time)
• due_date

  string (date)
• invoiced_date

  string (date)
• number

  string
• paid_date

  string (date)
• status

  string
• title

  string
• change_order_package_id

  integer
• updated_at

  string (date-time)
• revision

  integer
• grand_total

  string
• total_tax_amount

  string
• schedule_impact_amount

  integer
• currency_configuration

  object

Create Change Order Request

Parameters

• OS-Company-Id

  integerheaderrequired

Request body

• project_id

  integerrequired
• contract_id

  integerrequired
• change_order

  objectrequired

Response · 201 · object

• id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• creator

  object
• due_date

  string (date-time)
• grand_total

  string (float)
• invoiced_date

  string (date)
• number

  string
• origin_data

  string
• origin_id

  string
• paid_date

  string (date)
• position

  integer
• private

  boolean
• revision

  integer
• schedule_impact_amount

  integer
• status

  string
• title

  string
• updated_at

  string (date-time)
• currency_configuration

  object

Show Change Order Request

Parameters

• OS-Company-Id

  integerheaderrequired
• id

  integerpathrequired
• project_id

  integerqueryrequired
• contract_id

  integerqueryrequired
• view

  stringquery
• filters[include_deleted]

  stringquery

Response · 200 · object

• id

  integer
• change_order_package_id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• executed

  boolean
• creator

  object
• deleted_at

  string (date-time)
• due_date

  string (date-time)
• grand_total

  string (float)
• total_tax_amount

  string
• invoiced_date

  string (date)
• number

  string
• origin_data

  string
• origin_id

  string
• paid_date

  string (date)
• position

  integer
• private

  boolean
• revision

  integer
• schedule_impact_amount

  integer
• signed_change_order_received_date

  string (date)
• status

  string
• title

  string
• updated_at

  string (date-time)
• attachments

  object[]
• currency_configuration

  object
• contract

  object
• batch

  object

Update Change Order Request

Parameters

• OS-Company-Id

  integerheaderrequired
• id

  integerpathrequired

Request body

• project_id

  integerrequired
• contract_id

  integerrequired
• change_order

  objectrequired

Response · 200 · object

• id

  integer
• change_order_package_id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• executed

  boolean
• creator

  object
• deleted_at

  string (date-time)
• due_date

  string (date-time)
• grand_total

  string (float)
• total_tax_amount

  string
• invoiced_date

  string (date)
• number

  string
• origin_data

  string
• origin_id

  string
• paid_date

  string (date)
• position

  integer
• private

  boolean
• revision

  integer
• schedule_impact_amount

  integer
• signed_change_order_received_date

  string (date)
• status

  string
• title

  string
• updated_at

  string (date-time)
• attachments

  object[]
• currency_configuration

  object
• contract

  object
• batch

  object

List Potential Change Orders

Parameters

• OS-Company-Id

  integerheaderrequired
• project_id

  integerqueryrequired
• filters[id]

  integer[]query
• filters[origin_id]

  stringquery
• filters[created_at]

  string (date)query
• filters[updated_at]

  string (date)query
• filters[due_date]

  stringquery
• filters[contract_id]

  integerquery
• filters[include_deleted]

  stringquery
• filters[invoiced_date]

  stringquery
• filters[paid_date]

  stringquery
• filters[reviewed_at]

  stringquery
• page

  integerquery
• per_page

  integerquery

Response · 200 · object[]

• id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• created_by_id

  integer
• deleted_at

  string (date-time)
• due_date

  string (date)
• invoiced_date

  string (date)
• number

  string
• paid_date

  string (date)
• reviewed_at

  string (date-time)
• status

  string
• title

  string
• updated_at

  string (date-time)
• revision

  integer
• change_reason

  string
• schedule_impact_amount

  integer
• change_order_request_id

  integer
• executed

  boolean
• grand_total

  string
• change_order_request_title

  string
• change_order_package_title

  string
• potential_change_order_acronym_number

  string
• change_order_request_acronym_number

  string
• change_order_package_acronym_number

  string
• change_order_tiers

  integer
• currency_configuration

  object
• custom_fields

  object

Create Potential Change Order

Parameters

• OS-Company-Id

  integerheaderrequired

Request body

• project_id

  integerrequired
• contract_id

  integerrequired
• change_order

  objectrequired

Response · 201 · object

• id

  integer
• accounting_method

  string
• change_order_request_id

  integer
• commitment_change_event_id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• creator

  object
• due_date

  string (date-time)
• field_change

  boolean
• grand_total

  string (float)
• invoiced_date

  string (date)
• line_items

  object[]
• line_items_extended_total

  string (float)
• line_items_total

  string (float)
• number

  string
• origin_data

  string
• origin_id

  string
• paid

  boolean
• paid_date

  string (date)
• position

  integer
• prime_change_event_id

  integer
• private

  boolean
• revision

  integer
• schedule_impact_amount

  integer
• status

  string
• title

  string
• updated_at

  string (date-time)
• vendor

  object
• void

  boolean
• currency_configuration

  object
• custom_fields

  object

Show Potential Change Orders

Parameters

• OS-Company-Id

  integerheaderrequired
• id

  integerpathrequired
• project_id

  integerqueryrequired
• contract_id

  integerqueryrequired

Response · 200 · object

• id

  integer
• accounting_method

  string
• change_order_change_reason_id

  integer
• change_order_request_id

  integer
• commitment_change_event_id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• creator

  object
• deleted_at

  string (date-time)
• designated_reviewer

  object
• due_date

  string (date-time)
• field_change

  boolean
• grand_total

  string (float)
• invoiced_date

  string (date)
• attachments

  object[]
• line_items

  object[]
• line_items_extended_total

  string (float)
• line_items_total

  string (float)
• location_id

  integer
• number

  string
• origin_data

  string
• origin_id

  string
• paid

  boolean
• paid_date

  string (date)
• position

  integer
• prime_change_event_id

  integer
• private

  boolean
• reason

  string
• received_from

  object
• reference

  string
• request_for_quote_id

  integer
• reviewed_at

  string (date-time)
• reviewer

  object
• revision

  integer
• schedule_impact_amount

  integer
• status

  string
• title

  string
• updated_at

  string (date-time)
• vendor

  object
• void

  boolean
• currency_configuration

  object
• custom_fields

  object

Update Potential Change Order

Parameters

• OS-Company-Id

  integerheaderrequired
• id

  integerpathrequired

Request body

• project_id

  integerrequired
• contract_id

  integerrequired
• change_order

  objectrequired

Response · 200 · object

• id

  integer
• accounting_method

  string
• change_order_change_reason_id

  integer
• change_order_request_id

  integer
• commitment_change_event_id

  integer
• contract_id

  integer
• created_at

  string (date-time)
• creator

  object
• deleted_at

  string (date-time)
• designated_reviewer

  object
• due_date

  string (date-time)
• field_change

  boolean
• grand_total

  string (float)
• invoiced_date

  string (date)
• attachments

  object[]
• line_items

  object[]
• line_items_extended_total

  string (float)
• line_items_total

  string (float)
• location_id

  integer
• number

  string
• origin_data

  string
• origin_id

  string
• paid

  boolean
• paid_date

  string (date)
• position

  integer
• prime_change_event_id

  integer
• private

  boolean
• reason

  string
• received_from

  object
• reference

  string
• request_for_quote_id

  integer
• reviewed_at

  string (date-time)
• reviewer

  object
• revision

  integer
• schedule_impact_amount

  integer
• status

  string
• title

  string
• updated_at

  string (date-time)
• vendor

  object
• void

  boolean
• currency_configuration

  object
• custom_fields

  object

List Potential Change Order Line Items

Parameters

• OS-Company-Id

  integerheaderrequired
• potential_change_order_id

  integerpathrequired
• project_id

  integerqueryrequired
• page

  integerquery
• per_page

  integerquery
• filters[id]

  integer[]query
• filters[created_at]

  string (date)query
• filters[updated_at]

  string (date)query
• filters[cost_code_id]

  stringquery
• filters[line_item_type_id]

  integerquery

Response · 200 · object[]

• id

  integer
• amount

  string
• company

  object
• cost_code

  object
• created_at

  string (date-time)
• extended_type

  string
• holder

  object
• line_item_type

  object
• origin_data

  string
• origin_id

  string
• position

  integer
• project

  object
• quantity

  string (float)
• tax_code_id

  integer
• total_amount

  string (float)
• extended_amount

  string (float)
• unit_cost

  string (float)
• uom

  string
• wbs_code

  object
• updated_at

  string (date-time)
• change_event_line_item

  object
• currency_configuration

  object

Create Potential Change Order Line Item

Parameters

• OS-Company-Id

  integerheaderrequired
• potential_change_order_id

  integerpathrequired

Request body

• project_id

  integerrequired
• line_item

  objectrequired

Response · 201 · object

• id

  integer
• amount

  string
• company

  object
• cost_code

  object
• created_at

  string (date-time)
• extended_type

  string
• holder

  object
• line_item_type

  object
• origin_data

  string
• origin_id

  string
• position

  integer
• project

  object
• quantity

  string (float)
• tax_code_id

  integer
• total_amount

  string (float)
• extended_amount

  string (float)
• unit_cost

  string (float)
• uom

  string
• wbs_code

  object
• updated_at

  string (date-time)
• change_event_line_item

  object
• currency_configuration

  object

Show Potential Change Order Line Item

Parameters

• OS-Company-Id

  integerheaderrequired
• potential_change_order_id

  integerpathrequired
• id

  integerpathrequired
• project_id

  integerqueryrequired

Response · 200 · object

• id

  integer
• amount

  string
• company

  object
• cost_code

  object
• created_at

  string (date-time)
• extended_type

  string
• holder

  object
• line_item_type

  object
• origin_data

  string
• origin_id

  string
• position

  integer
• project

  object
• quantity

  string (float)
• tax_code_id

  integer
• total_amount

  string (float)
• extended_amount

  string (float)
• unit_cost

  string (float)
• uom

  string
• wbs_code

  object
• updated_at

  string (date-time)
• change_event_line_item

  object
• currency_configuration

  object

Update Potential Change Order Line Item

Parameters

• OS-Company-Id

  integerheaderrequired
• potential_change_order_id

  integerpathrequired
• id

  integerpathrequired

Request body

• project_id

  integerrequired
• line_item

  objectrequired

Response · 200 · object

• id

  integer
• amount

  string
• company

  object
• cost_code

  object
• created_at

  string (date-time)
• extended_type

  string
• holder

  object
• line_item_type

  object
• origin_data

  string
• origin_id

  string
• position

  integer
• project

  object
• quantity

  string (float)
• tax_code_id

  integer
• total_amount

  string (float)
• extended_amount

  string (float)
• unit_cost

  string (float)
• uom

  string
• wbs_code

  object
• updated_at

  string (date-time)
• change_event_line_item

  object
• currency_configuration

  object

Delete Potential Change Order Line Item

Parameters

• OS-Company-Id

  integerheaderrequired
• potential_change_order_id

  integerpathrequired
• id

  integerpathrequired
• project_id

  integerqueryrequired

Response · 200

No response body.