Prime Contracts

Show First Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• project_id

  integerqueryrequired

Response · 200 · object

• id

  integer
• accounting_method

  string
• actual_completion_date

  string (date)
• allow_comments

  boolean
• allow_markups

  boolean
• allow_payment_applications

  boolean
• allow_payments

  boolean
• allow_redistributions

  boolean
• approval_letter_date

  string (date)
• approved_change_orders

  string
• bill_to

  string
• budget_line_item_id

  integer
• contract_date

  string (date)
• contract_estimated_completion_date

  string (date)
• contract_start_date

  string (date)
• contract_termination_date

  string (date)
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• delivery_date

  string (date)
• display_materials_retainage

  boolean
• display_stored_materials

  boolean
• display_work_retainage

  boolean
• draft_change_orders_amount

  string
• exclusions

  string
• executed

  boolean
• execution_date

  string (date)
• grand_total

  string
• inclusions

  string
• issued_on_date

  string (date)
• letter_of_intent_date

  string (date)
• line_items_extended_total

  string
• line_items_total

  string
• number

  string
• origin_code

  string
• origin_data

  string
• origin_id

  string
• outstanding_balance

  string
• owner_invoices_amount

  string
• payment_terms

  string
• pending_change_orders_amount

  string
• pending_revised_contract_amount

  string
• percentage_paid

  string
• position

  integer
• private

  boolean
• requisition_number

  string
• retainage_percent

  string
• returned_date

  string (date)
• revised_contract_amount

  string
• ship_to

  string
• ship_via

  string
• signed_contract_received_date

  string (date)
• show_line_items_to_non_admins

  boolean
• status

  string
• title

  string
• total_payments

  string
• type

  string
• updated_at

  string (date-time)
• original_substantial_completion_date

  string (date)
• substantial_completion_date

  string (date)
• has_change_order_packages

  boolean
• has_potential_change_orders

  boolean
• architect

  object
• assigned_to

  object
• attachments

  object[]
• change_order_packages

  object[]
• change_order_requests

  object[][]
• contractor

  object
• cost_code

  object
• created_by

  object
• line_items

  object[]
• potential_change_orders

  object[]
• payments_received

  object[]
• received_from

  object
• vendor

  object
• currency_configuration

  object

Create Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• run_configurable_validations

  booleanquery

Request body

• project_id

  integerrequired
• attachments

  string[]
• prime_contract

  objectrequired

Response · 201 · object

• id

  integer
• accounting_method

  string
• actual_completion_date

  string (date)
• allow_comments

  boolean
• allow_markups

  boolean
• allow_payment_applications

  boolean
• allow_payments

  boolean
• allow_redistributions

  boolean
• approval_letter_date

  string (date)
• approved_change_orders

  string
• bill_to

  string
• budget_line_item_id

  integer
• contract_date

  string (date)
• contract_estimated_completion_date

  string (date)
• contract_start_date

  string (date)
• contract_termination_date

  string (date)
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• delivery_date

  string (date)
• display_materials_retainage

  boolean
• display_stored_materials

  boolean
• display_work_retainage

  boolean
• draft_change_orders_amount

  string
• exclusions

  string
• executed

  boolean
• execution_date

  string (date)
• grand_total

  string
• inclusions

  string
• issued_on_date

  string (date)
• letter_of_intent_date

  string (date)
• line_items_extended_total

  string
• line_items_total

  string
• number

  string
• origin_code

  string
• origin_data

  string
• origin_id

  string
• outstanding_balance

  string
• owner_invoices_amount

  string
• payment_terms

  string
• pending_change_orders_amount

  string
• pending_revised_contract_amount

  string
• percentage_paid

  string
• position

  integer
• private

  boolean
• requisition_number

  string
• retainage_percent

  string
• returned_date

  string (date)
• revised_contract_amount

  string
• ship_to

  string
• ship_via

  string
• signed_contract_received_date

  string (date)
• show_line_items_to_non_admins

  boolean
• status

  string
• title

  string
• total_payments

  string
• type

  string
• updated_at

  string (date-time)
• original_substantial_completion_date

  string (date)
• substantial_completion_date

  string (date)
• has_change_order_packages

  boolean
• has_potential_change_orders

  boolean
• architect

  object
• assigned_to

  object
• attachments

  object[]
• change_order_packages

  object[]
• change_order_requests

  object[][]
• contractor

  object
• cost_code

  object
• created_by

  object
• line_items

  object[]
• potential_change_orders

  object[]
• payments_received

  object[]
• received_from

  object
• vendor

  object
• currency_configuration

  object

Show Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• id

  integerpathrequired
• project_id

  integerqueryrequired

Response · 200 · object

• id

  integer
• accounting_method

  string
• actual_completion_date

  string (date)
• allow_comments

  boolean
• allow_markups

  boolean
• allow_payment_applications

  boolean
• allow_payments

  boolean
• allow_redistributions

  boolean
• approval_letter_date

  string (date)
• approved_change_orders

  string
• bill_to

  string
• budget_line_item_id

  integer
• contract_date

  string (date)
• contract_estimated_completion_date

  string (date)
• contract_start_date

  string (date)
• contract_termination_date

  string (date)
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• delivery_date

  string (date)
• display_materials_retainage

  boolean
• display_stored_materials

  boolean
• display_work_retainage

  boolean
• draft_change_orders_amount

  string
• exclusions

  string
• executed

  boolean
• execution_date

  string (date)
• grand_total

  string
• inclusions

  string
• issued_on_date

  string (date)
• letter_of_intent_date

  string (date)
• line_items_extended_total

  string
• line_items_total

  string
• number

  string
• origin_code

  string
• origin_data

  string
• origin_id

  string
• outstanding_balance

  string
• owner_invoices_amount

  string
• payment_terms

  string
• pending_change_orders_amount

  string
• pending_revised_contract_amount

  string
• percentage_paid

  string
• position

  integer
• private

  boolean
• requisition_number

  string
• retainage_percent

  string
• returned_date

  string (date)
• revised_contract_amount

  string
• ship_to

  string
• ship_via

  string
• signed_contract_received_date

  string (date)
• show_line_items_to_non_admins

  boolean
• status

  string
• title

  string
• total_payments

  string
• type

  string
• updated_at

  string (date-time)
• original_substantial_completion_date

  string (date)
• substantial_completion_date

  string (date)
• has_change_order_packages

  boolean
• has_potential_change_orders

  boolean
• architect

  object
• assigned_to

  object
• attachments

  object[]
• change_order_packages

  object[]
• change_order_requests

  object[][]
• contractor

  object
• cost_code

  object
• created_by

  object
• line_items

  object[]
• potential_change_orders

  object[]
• payments_received

  object[]
• received_from

  object
• vendor

  object
• currency_configuration

  object

Update Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• id

  integerpathrequired
• run_configurable_validations

  booleanquery

Request body

• project_id

  integerrequired
• attachments

  string[]
• prime_contract

  objectrequired

Response · 200 · object

• id

  integer
• accounting_method

  string
• actual_completion_date

  string (date)
• allow_comments

  boolean
• allow_markups

  boolean
• allow_payment_applications

  boolean
• allow_payments

  boolean
• allow_redistributions

  boolean
• approval_letter_date

  string (date)
• approved_change_orders

  string
• bill_to

  string
• budget_line_item_id

  integer
• contract_date

  string (date)
• contract_estimated_completion_date

  string (date)
• contract_start_date

  string (date)
• contract_termination_date

  string (date)
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• delivery_date

  string (date)
• display_materials_retainage

  boolean
• display_stored_materials

  boolean
• display_work_retainage

  boolean
• draft_change_orders_amount

  string
• exclusions

  string
• executed

  boolean
• execution_date

  string (date)
• grand_total

  string
• inclusions

  string
• issued_on_date

  string (date)
• letter_of_intent_date

  string (date)
• line_items_extended_total

  string
• line_items_total

  string
• number

  string
• origin_code

  string
• origin_data

  string
• origin_id

  string
• outstanding_balance

  string
• owner_invoices_amount

  string
• payment_terms

  string
• pending_change_orders_amount

  string
• pending_revised_contract_amount

  string
• percentage_paid

  string
• position

  integer
• private

  boolean
• requisition_number

  string
• retainage_percent

  string
• returned_date

  string (date)
• revised_contract_amount

  string
• ship_to

  string
• ship_via

  string
• signed_contract_received_date

  string (date)
• show_line_items_to_non_admins

  boolean
• status

  string
• title

  string
• total_payments

  string
• type

  string
• updated_at

  string (date-time)
• original_substantial_completion_date

  string (date)
• substantial_completion_date

  string (date)
• has_change_order_packages

  boolean
• has_potential_change_orders

  boolean
• architect

  object
• assigned_to

  object
• attachments

  object[]
• change_order_packages

  object[]
• change_order_requests

  object[][]
• contractor

  object
• cost_code

  object
• created_by

  object
• line_items

  object[]
• potential_change_orders

  object[]
• payments_received

  object[]
• received_from

  object
• vendor

  object
• currency_configuration

  object

Delete Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• id

  integerpathrequired
• project_id

  integerqueryrequired

Response · 200

No response body.

List all Prime Contracts

Parameters

• OS-Company-Id

  integerheaderrequired
• project_id

  integerqueryrequired
• page

  integerquery
• per_page

  integerquery
• filters[id]

  integer[]query
• filters[updated_at]

  string (date)query

Response · 200 · object[]

• id

  integer
• accounting_method

  string
• actual_completion_date

  string (date)
• approval_letter_date

  string (date)
• approved_change_orders

  string
• contract_date

  string (date)
• contract_estimated_completion_date

  string (date)
• contract_start_date

  string (date)
• contract_termination_date

  string (date)
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• executed

  boolean
• execution_date

  string (date)
• exclusions

  string
• grand_total

  string
• inclusions

  string
• issued_on_date

  string (date)
• letter_of_intent_date

  string (date)
• number

  string
• origin_code

  string
• origin_data

  string
• origin_id

  string
• private

  boolean
• retainage_percent

  string
• returned_date

  string (date)
• signed_contract_received_date

  string (date)
• show_line_items_to_non_admins

  boolean
• status

  string
• title

  string
• updated_at

  string (date-time)
• original_substantial_completion_date

  string (date)
• substantial_completion_date

  string (date)
• outstanding_balance

  string
• revised_contract_amount

  string
• total_payments

  string
• draft_change_orders_amount

  string
• pending_change_orders_amount

  string
• pending_revised_contract_amount

  string
• percentage_paid

  string
• owner_invoices_amount

  string
• has_change_order_packages

  boolean
• has_potential_change_orders

  boolean
• architect

  object
• attachments

  object[]
• contractor

  object
• created_by

  object
• vendor

  object
• currency_configuration

  object

List Prime Contract line items

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_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 Prime Contract line item

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_id

  integerpathrequired
• project_id

  integerqueryrequired

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 Prime Contract line item

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_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 Prime Contract line item

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_id

  integerpathrequired
• id

  integerpathrequired
• project_id

  integerqueryrequired

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 a Prime Contract line item

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_id

  integerpathrequired
• id

  integerpathrequired
• project_id

  integerqueryrequired

Response · 200

No response body.

Sync Prime Contract Line Items

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_id

  integerpathrequired
• project_id

  integerqueryrequired

Request body

• updates

  object[]required

Response · 200 · object

• entities

  object[]
• errors

  object[]

Update Payment Application (Owner Invoice) Line Item for Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_id

  integerpathrequired
• id

  integerpathrequired

Request body

• project_id

  integerrequired
• payment_application_line_item

  objectrequired

Response · 200 · object

• id

  integer
• balance_to_finish

  string
• materials_presently_stored

  string
• scheduled_value

  string
• total_completed_and_stored_to_date

  string
• total_completed_and_stored_to_date_percent

  string
• work_completed_from_previous_application

  string
• work_completed_this_period

  string
• description_of_work

  string
• item_number

  integer
• cost_code

  object
• wbs_code

  object
• scheduled_unit_price

  string
• scheduled_quantity

  string
• total_completed_and_stored_to_date_quantity

  string
• work_completed_this_period_quantity

  string
• work_completed_from_previous_application_quantity

  string
• work_completed_retainage_currently_retained

  string
• work_completed_retainage_from_previous_application

  string
• work_completed_retainage_released_this_period

  string
• work_completed_retainage_retained_this_period

  string
• work_completed_retainage_percent_this_period

  string
• materials_stored_retainage_currently_retained

  string
• materials_stored_retainage_from_previous_application

  string
• materials_stored_retainage_released_this_period

  string
• materials_stored_retainage_retained_this_period

  string
• materials_stored_retainage_percent_this_period

  string
• total_retainage_currently_retained

  string
• total_retainage_from_previous_application

  string
• materials_moved

  string
• materials_retainage_retained_moved

  string
• type

  string

Update Payment Application (Owner Invoice) Markup Line item for Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_id

  integerpathrequired
• id

  integerpathrequired

Request body

• project_id

  integerrequired
• payment_application_markup_line_item

  objectrequired

Response · 200 · object

• id

  integer (int64)
• balance_to_finish

  string
• scheduled_value

  string
• work_completed_from_previous_application

  string
• total_completed_and_stored_to_date_percent

  string
• total_completed_and_stored_to_date

  string
• work_completed_this_period

  string
• type

  string
• description_of_work

  string
• materials_presently_stored

  string
• work_completed_retainage_currently_retained

  string
• work_completed_retainage_from_previous_application

  string
• work_completed_retainage_released_this_period

  string
• work_completed_retainage_retained_this_period

  string
• work_completed_retainage_percent_this_period

  string
• total_retainage_currently_retained

  string
• total_retainage_from_previous_application

  string
• materials_stored_retainage_currently_retained

  string
• materials_stored_retainage_from_previous_application

  string
• materials_stored_retainage_released_this_period

  string
• materials_stored_retainage_retained_this_period

  string
• materials_stored_retainage_percent_this_period

  string

List Payment Applications (Owner Invoices) for Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_id

  integerpathrequired
• project_id

  integerqueryrequired
• filters[id]

  integer[]query
• page

  integerquery
• per_page

  integerquery
• filters[is_last]

  booleanquery

Response · 200 · object[]

• id

  integer
• billing_date

  string (date)
• invoice_number

  string
• origin_data

  string
• origin_id

  string
• percent_complete

  string
• period_start

  string (date)
• period_end

  string (date)
• period_id

  integer
• status

  string
• total_amount_paid

  string
• number

  integer
• total_amount_accrued_this_period

  string
• formatted_contract_company

  string
• currency_configuration

  object
• g702

  object
• billing_period

  object
• contract

  object
• created_at

  string (date-time)
• updated_at

  string (date-time)

Create Payment Application (Owner Invoice) for Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_id

  integerpathrequired

Request body

• project_id

  integerrequired
• attachments

  string[]
• payment_application

  object

Response · 201 · object

• attachments

  object[]
• g703

  object[]
• id

  integer
• billing_date

  string (date)
• invoice_number

  string
• origin_data

  string
• origin_id

  string
• percent_complete

  string
• period_start

  string (date)
• period_end

  string (date)
• period_id

  integer
• status

  string
• total_amount_paid

  string
• number

  integer
• total_amount_accrued_this_period

  string
• formatted_contract_company

  string
• currency_configuration

  object
• description_type

  string
• g702

  object
• billing_period

  object
• contract

  object

Update Payment Application (Owner Invoice) for Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• prime_contract_id

  integerpathrequired
• id

  integerpathrequired

Request body

• project_id

  integerrequired
• attachments

  string[]
• payment_application

  object

Response · 200 · object

• attachments

  object[]
• g703

  object[]
• id

  integer
• billing_date

  string (date)
• invoice_number

  string
• origin_data

  string
• origin_id

  string
• percent_complete

  string
• period_start

  string (date)
• period_end

  string (date)
• period_id

  integer
• status

  string
• total_amount_paid

  string
• number

  integer
• total_amount_accrued_this_period

  string
• formatted_contract_company

  string
• currency_configuration

  object
• description_type

  string
• g702

  object
• billing_period

  object
• contract

  object

List Prime Contracts

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• page

  integerquery
• per_page

  integerquery
• view

  stringquery
• filters[accounting_method]

  stringquery
• filters[architect_id]

  integer | integer[]query
• filters[contractor_id]

  integer | integer[]query
• filters[created_at]

  string (date-time) | string (date-time)[] | stringquery
• filters[deleted_at]

  string (date-time) | string (date-time)[] | stringquery
• filters[id]

  integer | integer[]query
• filters[signature_required]

  booleanquery
• filters[status]

  string | string[]query
• filters[updated_at]

  string (date-time) | string (date-time)[] | stringquery
• filters[vendor_id]

  integer | integer[]query
• filters[executed]

  booleanquery

Response · 200 · object

• data

  object[]

Create Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• view

  stringquery

Request body

• number

  string
• status

  string
• title

  string
• executed

  boolean
• vendor_id

  string
• architect_id

  string
• contractor_id

  string
• inclusions

  string
• exclusions

  string
• accounting_method

  string
• allow_comments

  boolean
• auto_approve_prefilled_requisitions_on_payapp

  boolean
• allow_markups

  boolean
• change_order_level_of_detail

  string
• enable_ssov

  boolean
• allow_payment_applications

  boolean
• allow_payments

  boolean
• display_materials_retainage

  boolean
• display_work_retainage

  boolean
• show_cost_code_on_pdf

  boolean
• retainage_percent

  number
• accessor_ids

  string[]
• private

  boolean
• show_line_items_to_non_admins

  boolean
• signature_required

  boolean
• actual_completion_date

  string (date)
• approval_letter_date

  string (date)
• contract_date

  string (date)
• contract_estimated_completion_date

  string (date)
• contract_start_date

  string (date)
• contract_termination_date

  string (date)
• execution_date

  string (date)
• issued_on_date

  string (date)
• letter_of_intent_date

  string (date)
• returned_date

  string (date)
• signed_contract_received_date

  string (date)
• substantial_completion_date

  string (date)
• currency_exchange_rate

  string
• currency_iso_code

  string
• custom_field_%{custom_field_definition_id}

  string | boolean | string[]
• change_event_attachment_ids

  integer[]
• request_for_quote_attachment_ids

  integer[]
• attachment_ids

  string[]
• drawing_revision_ids

  string[]
• file_version_ids

  string[]
• form_ids

  string[]
• image_ids

  string[]
• upload_ids

  string[]

Response · 201 · object

• data

  object

Show Prime Contract Summary

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• contract_id

  stringpathrequired

Response · 200 · object

• data

  object

Show Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired
• view

  stringquery
• filters[include_deleted]

  stringquery

Response · 200 · object

• data

  object

Update Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired
• view

  stringquery

Request body

• number

  string
• status

  string
• title

  string
• executed

  boolean
• vendor_id

  string
• architect_id

  string
• contractor_id

  string
• inclusions

  string
• exclusions

  string
• accounting_method

  string
• allow_comments

  boolean
• auto_approve_prefilled_requisitions_on_payapp

  boolean
• allow_markups

  boolean
• change_order_level_of_detail

  string
• enable_ssov

  boolean
• allow_payment_applications

  boolean
• allow_payments

  boolean
• display_materials_retainage

  boolean
• display_work_retainage

  boolean
• show_cost_code_on_pdf

  boolean
• retainage_percent

  number
• accessor_ids

  string[]
• private

  boolean
• show_line_items_to_non_admins

  boolean
• signature_required

  boolean
• actual_completion_date

  string (date)
• approval_letter_date

  string (date)
• contract_date

  string (date)
• contract_estimated_completion_date

  string (date)
• contract_start_date

  string (date)
• contract_termination_date

  string (date)
• execution_date

  string (date)
• issued_on_date

  string (date)
• letter_of_intent_date

  string (date)
• returned_date

  string (date)
• signed_contract_received_date

  string (date)
• substantial_completion_date

  string (date)
• currency_exchange_rate

  string
• currency_iso_code

  string
• custom_field_%{custom_field_definition_id}

  string | boolean | string[]
• change_event_attachment_ids

  integer[]
• request_for_quote_attachment_ids

  integer[]
• attachment_ids

  string[]
• drawing_revision_ids

  string[]
• file_version_ids

  string[]
• form_ids

  string[]
• image_ids

  string[]
• upload_ids

  string[]

Response · 200 · object

• data

  object

Delete Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired

Response · 204

No response body.

List Prime Contract Attachments

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired
• page

  integerquery
• per_page

  integerquery
• filters[contract][include_deleted]

  booleanquery

Response · 200 · object

• data

  object[]

List Prime Contract Line Items

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired
• page

  integerquery
• per_page

  integerquery
• view

  stringquery

Response · 200 · object

• data

  object[]

Create Prime Contract Line Item

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired

Request body

• line_item_group_id

  string
• rate_value_id

  string
• resource_id

  string
• amount

  string
• quantity

  string
• unit_cost

  string
• uom

  string
• wbs_code_id

  stringrequired
• tax_code_id

  string
• funding_rule_id

  string

Response · 200 · object

• data

  object

Show Prime Contract Line Item

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired
• id

  stringpathrequired
• view

  stringquery

Response · 200 · object

• data

  object

Update Prime Contract Line Item

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired
• id

  stringpathrequired

Request body

• line_item_group_id

  string
• rate_value_id

  string
• resource_id

  string
• amount

  string
• quantity

  string
• unit_cost

  string
• uom

  string
• wbs_code_id

  string
• tax_code_id

  string
• funding_rule_id

  string

Response · 200 · object

• data

  object

Delete Prime Contract Line Item

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired
• id

  stringpathrequired

Response · 204

No response body.

Check PDF generation status

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired

Response · 202

No response body.

Create PDF export for a Prime Contract

Parameters

• OS-Company-Id

  integerheaderrequired
• company_id

  stringpathrequired
• project_id

  stringpathrequired
• prime_contract_id

  stringpathrequired

Request body

• wbs_pdf_groups

  string[]

Response · 204

No response body.