Esc

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

Commitments

28 endpoints15 implementedAll modules →
  1. GET /rest/v1.0/purchase_order_contractsList of Purchase Order Contracts
  2. POST /rest/v1.0/purchase_order_contractsCreate Purchase Order Contract
  3. GET /rest/v1.0/purchase_order_contracts/{id}Show Purchase Order Contract
  4. PATCH /rest/v1.0/purchase_order_contracts/{id}Update Purchase Order Contract
  5. DELETE /rest/v1.0/purchase_order_contracts/{id}Delete Purchase Order Contract
  6. GET /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_itemsList Purchase Order Contract Line Items
  7. POST /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_itemsCreate Purchase Order Contract Line Item
  8. GET /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_items/{id}Show Purchase Order Contract Line Item
  9. PATCH /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_items/{id}Update Purchase Order Contract Line Item
  10. DELETE /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_items/{id}Delete Purchase Order Contract Line Item
  11. GET /rest/v1.0/requisitionsList Requisitions (Subcontractor Invoices) for Project
  12. POST /rest/v1.0/requisitionsCreate Requisition (Subcontractor Invoices) for Commitment
  13. GET /rest/v1.0/requisitions/{id}Show Requisition (Subcontractor Invoice)
  14. PATCH /rest/v1.0/requisitions/{id}Update Requisition (Subcontractor Invoice)
  15. DELETE /rest/v1.0/requisitions/{id}Delete Requisition (Subcontractor Invoice)
  16. GET /rest/v1.0/requisitions/{requisition_id}/contract_detail_itemsList requisition contract detail items (G703)
  17. POST /rest/v1.0/requisitions/{requisition_id}/contract_detail_itemsCreate a requisition contract detail item
  18. PATCH /rest/v1.0/requisitions/{requisition_id}/contract_detail_items/{id}Update a requisition contract detail item (this-period entry)
  19. GET /rest/v1.0/work_order_contractsList work order contracts
  20. POST /rest/v1.0/work_order_contractsCreate work order contract
  21. GET /rest/v1.0/work_order_contracts/{id}Show work order contract
  22. PATCH /rest/v1.0/work_order_contracts/{id}Update work order contract
  23. DELETE /rest/v1.0/work_order_contracts/{id}Delete work order contract
  24. GET /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_itemsList Work Order Contract Line Items
  25. POST /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_itemsCreate Work Order Contract line item
  26. GET /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_items/{id}Show Work Order Contract line item
  27. PATCH /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_items/{id}Update Work Order Contract line item
  28. DELETE /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_items/{id}Delete Work Order Contract line item
GET /rest/v1.0/purchase_order_contracts

List of Purchase Order Contracts

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • view
    stringquery
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[status]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • filters[include_deleted]
    stringquery
  • filters[origin_id]
    stringquery

Response · 200 · object[]

  • accounting_method
    string
  • approval_letter_date
    string
  • approved_change_orders
    string
  • assignee
    object
  • bill_to_address
    string
  • billing_schedule_of_values_status
    string
  • contract_date
    string (date)
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • delivery_date
    string (date)
  • draft_change_orders_amount
    string
  • executed
    boolean
  • execution_date
    string (date)
  • grand_total
    string
  • has_change_order_packages
    boolean
  • has_potential_change_orders
    boolean
  • id
    integer
  • issued_on_date
    string (date)
  • letter_of_intent_date
    string (date)
  • number
    string
  • origin_code
    string
  • origin_data
    string
  • origin_id
    string
  • payment_terms
    string
  • pending_change_orders
    string
  • pending_revised_contract
    string
  • percentage_paid
    string
  • private
    boolean
  • project
    object
  • remaining_balance_outstanding
    string
  • requisitions_are_enabled
    boolean
  • retainage_percent
    string
  • returned_date
    string (date)
  • revised_contract
    string
  • ship_to_address
    string
  • ship_via
    string
  • show_line_items_to_non_admins
    boolean
  • signed_contract_received_date
    string (date)
  • status
    string
  • title
    string
  • total_draw_requests_amount
    string
  • total_payments
    string
  • total_requisitions_amount
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • currency_configuration
    object
POST /rest/v1.0/purchase_order_contracts

Create Purchase Order Contract

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • run_configurable_validations
    booleanquery

Request body

  • project_id
    integerrequired
  • attachments
    string[]
  • purchase_order_contract
    objectrequired

Response · 201 · object

  • id
    integer
  • accounting_method
    string
  • allow_change_orders_ssov
    boolean
  • approval_letter_date
    string
  • approved_change_orders
    string
  • assignee
    object
  • attachments
    object[]
  • bill_to_address
    string
  • billing_schedule_of_values_status
    string
  • change_order_packages
    object[]
  • change_order_requests
    object[]
  • contract_date
    string (date)
  • created_at
    string (date-time)
  • created_by_id
    integer
  • deleted_at
    string (date-time)
  • delivery_date
    string (date)
  • draft_change_orders_amount
    string
  • enable_ssov
    boolean
  • executed
    boolean
  • execution_date
    string (date)
  • grand_total
    string
  • has_change_order_packages
    boolean
  • has_potential_change_orders
    boolean
  • invoice_contacts
    object[]
  • issued_on_date
    string (date)
  • letter_of_intent_date
    string (date)
  • line_items
    object[]
  • number
    string
  • origin_code
    string
  • origin_data
    string
  • origin_id
    string
  • payment_terms
    string
  • payments_issued
    object[]
  • pending_change_orders
    string
  • pending_revised_contract
    string
  • percentage_paid
    string
  • potential_change_orders
    object[][]
  • private
    boolean
  • project
    object
  • remaining_balance_outstanding
    string
  • requisitions_are_enabled
    boolean
  • retainage_percent
    string
  • returned_date
    string (date)
  • revised_contract
    string
  • ship_to_address
    string
  • ship_via
    string
  • show_line_items_to_non_admins
    boolean
  • signed_contract_received_date
    string (date)
  • status
    string
  • title
    string
  • total_draw_requests_amount
    string
  • total_payments
    string
  • total_requisitions_amount
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • currency_configuration
    object
GET /rest/v1.0/purchase_order_contracts/{id}

Show Purchase Order Contract

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • accounting_method
    string
  • allow_change_orders_ssov
    boolean
  • approval_letter_date
    string
  • approved_change_orders
    string
  • assignee
    object
  • attachments
    object[]
  • bill_to_address
    string
  • billing_schedule_of_values_status
    string
  • change_order_packages
    object[]
  • change_order_requests
    object[]
  • contract_date
    string (date)
  • created_at
    string (date-time)
  • created_by_id
    integer
  • deleted_at
    string (date-time)
  • delivery_date
    string (date)
  • draft_change_orders_amount
    string
  • enable_ssov
    boolean
  • executed
    boolean
  • execution_date
    string (date)
  • grand_total
    string
  • has_change_order_packages
    boolean
  • has_potential_change_orders
    boolean
  • invoice_contacts
    object[]
  • issued_on_date
    string (date)
  • letter_of_intent_date
    string (date)
  • line_items
    object[]
  • number
    string
  • origin_code
    string
  • origin_data
    string
  • origin_id
    string
  • payment_terms
    string
  • payments_issued
    object[]
  • pending_change_orders
    string
  • pending_revised_contract
    string
  • percentage_paid
    string
  • potential_change_orders
    object[][]
  • private
    boolean
  • project
    object
  • remaining_balance_outstanding
    string
  • requisitions_are_enabled
    boolean
  • retainage_percent
    string
  • returned_date
    string (date)
  • revised_contract
    string
  • ship_to_address
    string
  • ship_via
    string
  • show_line_items_to_non_admins
    boolean
  • signed_contract_received_date
    string (date)
  • status
    string
  • title
    string
  • total_draw_requests_amount
    string
  • total_payments
    string
  • total_requisitions_amount
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • currency_configuration
    object
PATCH /rest/v1.0/purchase_order_contracts/{id}

Update Purchase Order Contract

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • project_id
    integerrequired
  • attachments
    string[]
  • purchase_order_contract
    objectrequired

Response · 200 · object

  • id
    integer
  • accounting_method
    string
  • allow_change_orders_ssov
    boolean
  • approval_letter_date
    string
  • approved_change_orders
    string
  • assignee
    object
  • attachments
    object[]
  • bill_to_address
    string
  • billing_schedule_of_values_status
    string
  • change_order_packages
    object[]
  • change_order_requests
    object[]
  • contract_date
    string (date)
  • created_at
    string (date-time)
  • created_by_id
    integer
  • deleted_at
    string (date-time)
  • delivery_date
    string (date)
  • draft_change_orders_amount
    string
  • enable_ssov
    boolean
  • executed
    boolean
  • execution_date
    string (date)
  • grand_total
    string
  • has_change_order_packages
    boolean
  • has_potential_change_orders
    boolean
  • invoice_contacts
    object[]
  • issued_on_date
    string (date)
  • letter_of_intent_date
    string (date)
  • line_items
    object[]
  • number
    string
  • origin_code
    string
  • origin_data
    string
  • origin_id
    string
  • payment_terms
    string
  • payments_issued
    object[]
  • pending_change_orders
    string
  • pending_revised_contract
    string
  • percentage_paid
    string
  • potential_change_orders
    object[][]
  • private
    boolean
  • project
    object
  • remaining_balance_outstanding
    string
  • requisitions_are_enabled
    boolean
  • retainage_percent
    string
  • returned_date
    string (date)
  • revised_contract
    string
  • ship_to_address
    string
  • ship_via
    string
  • show_line_items_to_non_admins
    boolean
  • signed_contract_received_date
    string (date)
  • status
    string
  • title
    string
  • total_draw_requests_amount
    string
  • total_payments
    string
  • total_requisitions_amount
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • currency_configuration
    object
DELETE /rest/v1.0/purchase_order_contracts/{id}

Delete Purchase Order Contract

v1.0Implemented

Parameters

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

Response · 200

No response body.

GET /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_items

List Purchase Order Contract Line Items

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • purchase_order_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
  • view
    stringquery

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
POST /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_items

Create Purchase Order Contract Line Item

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • purchase_order_contract_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
GET /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_items/{id}

Show Purchase Order Contract Line Item

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • purchase_order_contract_id
    integerpathrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired
  • view
    stringquery

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
PATCH /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_items/{id}

Update Purchase Order Contract Line Item

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • purchase_order_contract_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 /rest/v1.0/purchase_order_contracts/{purchase_order_contract_id}/line_items/{id}

Delete Purchase Order Contract Line Item

v1.0Documented

Parameters

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

Response · 200

No response body.

GET /rest/v1.0/requisitions

List Requisitions (Subcontractor Invoices) for Project

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[commitment_id]
    integerquery
  • filters[period_id]
    integerquery
  • filters[status]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • filters[origin_id]
    stringquery
  • filters[search]
    stringquery

Response · 200 · object[]

  • id
    integer
  • project_id
    integer
  • electronic_signature_id
    integer
  • billing_date
    string (date)
  • commitment_id
    integer
  • commitment_type
    string
  • contract_name
    string
  • created_at
    string (date-time)
  • created_by
    object
  • updated_at
    string (date-time)
  • invoice_number
    string
  • invoice_type
    string
  • contract_invoicing_method
    string
  • move_materials_to_previous_work_completed
    boolean
  • origin_data
    string
  • origin_id
    string
  • payment_date
    string (date)
  • period_id
    integer
  • requisition_start
    string (date)
  • requisition_end
    string (date)
  • status
    string
  • erp_status
    string
  • submitted_at
    string (date)
  • comment
    string
  • final
    boolean
  • number
    integer
  • percent_complete
    string
  • vendor_name
    string
  • total_claimed_amount
    string
  • deletable
    boolean
  • custom_fields
    object
  • currency_configuration
    object
  • attachments
    object[]
  • summary
    object
  • action_policy
    object
POST /rest/v1.0/requisitions

Create Requisition (Subcontractor Invoices) for Commitment

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired

Request body

  • project_id
    integerrequired
  • commitment_id
    integerrequired
  • attachments
    string[]
  • requisition
    object

Response · 201 · object

  • id
    integer
  • previous_requisition_id
    integer
  • project_id
    integer
  • billing_date
    string (date)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • commitment_id
    integer
  • commitment_type
    string
  • contract_name
    string
  • deletable
    boolean
  • final
    boolean
  • vendor_name
    string
  • vendor_id
    integer
  • invoice_number
    string
  • invoice_type
    string
  • contract_invoicing_method
    string
  • origin_data
    string
  • origin_id
    string
  • payment_date
    string (date)
  • percent_complete
    string
  • period_id
    integer
  • requisition_start
    string (date)
  • requisition_end
    string (date)
  • status
    string
  • erp_status
    string
  • number
    integer
  • submitted_at
    string (date)
  • total_claimed_amount
    string
  • electronic_signature_id
    integer
  • move_materials_to_previous_work_completed
    boolean
  • summary_text
    object
  • summary
    object
  • created_by
    object
  • subtiers_certified_by
    object
  • custom_fields
    object
  • currency_configuration
    object
  • attachments
    object[]
  • action_policy
    object
  • tax_summary
    object[]
  • accounting_method
    string
  • items
    object[]
  • item_packages
    object[]
GET /rest/v1.0/requisitions/{id}

Show Requisition (Subcontractor Invoice)

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • project_id
    integer
  • electronic_signature_id
    integer
  • billing_date
    string (date)
  • commitment_id
    integer
  • commitment_type
    string
  • contract_name
    string
  • created_at
    string (date-time)
  • created_by
    object
  • updated_at
    string (date-time)
  • invoice_number
    string
  • invoice_type
    string
  • contract_invoicing_method
    string
  • move_materials_to_previous_work_completed
    boolean
  • origin_data
    string
  • origin_id
    string
  • payment_date
    string (date)
  • period_id
    integer
  • requisition_start
    string (date)
  • requisition_end
    string (date)
  • status
    string
  • erp_status
    string
  • submitted_at
    string (date)
  • comment
    string
  • final
    boolean
  • number
    integer
  • percent_complete
    string
  • vendor_name
    string
  • total_claimed_amount
    string
  • deletable
    boolean
  • custom_fields
    object
  • currency_configuration
    object
  • attachments
    object[]
  • summary
    object
  • action_policy
    object
PATCH /rest/v1.0/requisitions/{id}

Update Requisition (Subcontractor Invoice)

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • commitment_id
    integerrequired
  • attachments
    string[]
  • requisition
    object

Response · 200 · object

  • id
    integer
  • previous_requisition_id
    integer
  • project_id
    integer
  • billing_date
    string (date)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • commitment_id
    integer
  • commitment_type
    string
  • contract_name
    string
  • deletable
    boolean
  • final
    boolean
  • vendor_name
    string
  • vendor_id
    integer
  • invoice_number
    string
  • invoice_type
    string
  • contract_invoicing_method
    string
  • origin_data
    string
  • origin_id
    string
  • payment_date
    string (date)
  • percent_complete
    string
  • period_id
    integer
  • requisition_start
    string (date)
  • requisition_end
    string (date)
  • status
    string
  • erp_status
    string
  • number
    integer
  • submitted_at
    string (date)
  • total_claimed_amount
    string
  • electronic_signature_id
    integer
  • move_materials_to_previous_work_completed
    boolean
  • summary_text
    object
  • summary
    object
  • created_by
    object
  • subtiers_certified_by
    object
  • custom_fields
    object
  • currency_configuration
    object
  • attachments
    object[]
  • action_policy
    object
  • tax_summary
    object[]
  • accounting_method
    string
  • items
    object[]
  • item_packages
    object[]
DELETE /rest/v1.0/requisitions/{id}

Delete Requisition (Subcontractor Invoice)

v1.0Implemented

Parameters

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

Response · 200

No response body.

GET /rest/v1.0/requisitions/{requisition_id}/contract_detail_items

List requisition contract detail items (G703)

v1.0Documented

Parameters

  • requisition_id
    stringpathrequired

Response · 200 · object[]

  • id
    integer
  • requisition_id
    integer
  • position
    integer
  • detail_line_item_id
    integer
  • cost_code_id
    integer
  • description_of_work
    string
  • item_number
    string
  • scheduled_value
    string
  • work_completed_from_previous_application
    string
  • work_completed_this_period
    string
  • materials_presently_stored
    string
  • total_completed_and_stored_to_date
    string
  • total_completed_and_stored_to_date_percent
    string
  • balance_to_finish
    string
  • completed_work_retainage_percent_this_period
    string
  • work_completed_retainage_retained_this_period
    string
  • subcontractor_claimed_amount
    string
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/requisitions/{requisition_id}/contract_detail_items

Create a requisition contract detail item

v1.0Documented

Parameters

  • requisition_id
    stringpathrequired

Response · 201 · object

  • id
    integer
  • requisition_id
    integer
  • position
    integer
  • detail_line_item_id
    integer
  • cost_code_id
    integer
  • description_of_work
    string
  • item_number
    string
  • scheduled_value
    string
  • work_completed_from_previous_application
    string
  • work_completed_this_period
    string
  • materials_presently_stored
    string
  • total_completed_and_stored_to_date
    string
  • total_completed_and_stored_to_date_percent
    string
  • balance_to_finish
    string
  • completed_work_retainage_percent_this_period
    string
  • work_completed_retainage_retained_this_period
    string
  • subcontractor_claimed_amount
    string
  • created_at
    string
  • updated_at
    string
PATCH /rest/v1.0/requisitions/{requisition_id}/contract_detail_items/{id}

Update a requisition contract detail item (this-period entry)

v1.0Documented

Parameters

  • requisition_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integer
  • requisition_id
    integer
  • position
    integer
  • detail_line_item_id
    integer
  • cost_code_id
    integer
  • description_of_work
    string
  • item_number
    string
  • scheduled_value
    string
  • work_completed_from_previous_application
    string
  • work_completed_this_period
    string
  • materials_presently_stored
    string
  • total_completed_and_stored_to_date
    string
  • total_completed_and_stored_to_date_percent
    string
  • balance_to_finish
    string
  • completed_work_retainage_percent_this_period
    string
  • work_completed_retainage_retained_this_period
    string
  • subcontractor_claimed_amount
    string
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/work_order_contracts

List work order contracts

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • view
    stringquery
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[status]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • filters[include_deleted]
    stringquery
  • filters[origin_id]
    stringquery

Response · 200 · object[]

  • accounting_method
    string
  • actual_completion_date
    string (date)
  • approval_letter_date
    string
  • approved_change_orders
    string
  • billing_schedule_of_values_status
    string
  • contract_date
    string (date)
  • contract_start_date
    string (date)
  • contract_estimated_completion_date
    string (date)
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • draft_change_orders_amount
    string
  • exclusions
    string
  • executed
    boolean
  • execution_date
    string (date)
  • grand_total
    string
  • has_change_order_packages
    boolean
  • has_potential_change_orders
    boolean
  • id
    integer
  • inclusions
    string
  • issued_on_date
    string (date)
  • letter_of_intent_date
    string (date)
  • number
    string
  • origin_data
    string
  • origin_code
    string
  • origin_id
    string
  • pending_change_orders
    string
  • pending_revised_contract
    string
  • percentage_paid
    string
  • private
    boolean
  • project
    object
  • remaining_balance_outstanding
    string
  • requisitions_are_enabled
    boolean
  • retainage_percent
    string
  • returned_date
    string (date)
  • revised_contract
    string
  • signed_contract_received_date
    string (date)
  • show_line_items_to_non_admins
    boolean
  • status
    string
  • title
    string
  • total_draw_requests_amount
    string
  • total_payments
    string
  • total_requisitions_amount
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • currency_configuration
    object
POST /rest/v1.0/work_order_contracts

Create work order contract

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • run_configurable_validations
    booleanquery

Request body

  • project_id
    integerrequired
  • attachments
    string[]
  • work_order_contract
    objectrequired

Response · 201 · object

  • accounting_method
    string
  • actual_completion_date
    string (date)
  • approval_letter_date
    string
  • approved_change_orders
    string
  • attachments
    object[]
  • change_order_packages
    object[]
  • change_order_requests
    object[][]
  • contract_date
    string (date)
  • contract_start_date
    string (date)
  • contract_estimated_completion_date
    string (date)
  • created_at
    string (date-time)
  • created_by_id
    integer
  • deleted_at
    string (date-time)
  • draft_change_orders_amount
    string
  • exclusions
    string
  • executed
    boolean
  • execution_date
    string (date)
  • grand_total
    string
  • id
    integer
  • inclusions
    string
  • invoice_contacts
    object[]
  • issued_on_date
    string (date)
  • letter_of_intent_date
    string (date)
  • line_items
    object[]
  • number
    string
  • origin_data
    string
  • origin_code
    string
  • origin_id
    string
  • payments_issued
    object[]
  • pending_change_orders
    string
  • pending_revised_contract
    string
  • percentage_paid
    string
  • potential_change_orders
    object[]
  • private
    boolean
  • project
    object
  • remaining_balance_outstanding
    string
  • requisitions_are_enabled
    boolean
  • retainage_percent
    string
  • returned_date
    string (date)
  • revised_contract
    string
  • signed_contract_received_date
    string (date)
  • show_line_items_to_non_admins
    boolean
  • status
    string
  • title
    string
  • total_draw_requests_amount
    string
  • total_payments
    string
  • total_requisitions_amount
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • currency_configuration
    object
GET /rest/v1.0/work_order_contracts/{id}

Show work order contract

v1.0Implemented

Parameters

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

Response · 200 · object

  • accounting_method
    string
  • actual_completion_date
    string (date)
  • approval_letter_date
    string
  • approved_change_orders
    string
  • attachments
    object[]
  • change_order_packages
    object[]
  • change_order_requests
    object[][]
  • contract_date
    string (date)
  • contract_start_date
    string (date)
  • contract_estimated_completion_date
    string (date)
  • created_at
    string (date-time)
  • created_by_id
    integer
  • deleted_at
    string (date-time)
  • draft_change_orders_amount
    string
  • exclusions
    string
  • executed
    boolean
  • execution_date
    string (date)
  • grand_total
    string
  • id
    integer
  • inclusions
    string
  • invoice_contacts
    object[]
  • issued_on_date
    string (date)
  • letter_of_intent_date
    string (date)
  • line_items
    object[]
  • number
    string
  • origin_data
    string
  • origin_code
    string
  • origin_id
    string
  • payments_issued
    object[]
  • pending_change_orders
    string
  • pending_revised_contract
    string
  • percentage_paid
    string
  • potential_change_orders
    object[]
  • private
    boolean
  • project
    object
  • remaining_balance_outstanding
    string
  • requisitions_are_enabled
    boolean
  • retainage_percent
    string
  • returned_date
    string (date)
  • revised_contract
    string
  • signed_contract_received_date
    string (date)
  • show_line_items_to_non_admins
    boolean
  • status
    string
  • title
    string
  • total_draw_requests_amount
    string
  • total_payments
    string
  • total_requisitions_amount
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • currency_configuration
    object
PATCH /rest/v1.0/work_order_contracts/{id}

Update work order contract

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • project_id
    integerrequired
  • attachments
    string[]
  • work_order_contract
    objectrequired

Response · 200 · object

  • accounting_method
    string
  • actual_completion_date
    string (date)
  • approval_letter_date
    string
  • approved_change_orders
    string
  • attachments
    object[]
  • change_order_packages
    object[]
  • change_order_requests
    object[][]
  • contract_date
    string (date)
  • contract_start_date
    string (date)
  • contract_estimated_completion_date
    string (date)
  • created_at
    string (date-time)
  • created_by_id
    integer
  • deleted_at
    string (date-time)
  • draft_change_orders_amount
    string
  • exclusions
    string
  • executed
    boolean
  • execution_date
    string (date)
  • grand_total
    string
  • id
    integer
  • inclusions
    string
  • invoice_contacts
    object[]
  • issued_on_date
    string (date)
  • letter_of_intent_date
    string (date)
  • line_items
    object[]
  • number
    string
  • origin_data
    string
  • origin_code
    string
  • origin_id
    string
  • payments_issued
    object[]
  • pending_change_orders
    string
  • pending_revised_contract
    string
  • percentage_paid
    string
  • potential_change_orders
    object[]
  • private
    boolean
  • project
    object
  • remaining_balance_outstanding
    string
  • requisitions_are_enabled
    boolean
  • retainage_percent
    string
  • returned_date
    string (date)
  • revised_contract
    string
  • signed_contract_received_date
    string (date)
  • show_line_items_to_non_admins
    boolean
  • status
    string
  • title
    string
  • total_draw_requests_amount
    string
  • total_payments
    string
  • total_requisitions_amount
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • currency_configuration
    object
DELETE /rest/v1.0/work_order_contracts/{id}

Delete work order contract

v1.0Implemented

Parameters

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

Response · 200

No response body.

GET /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_items

List Work Order Contract Line Items

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • work_order_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
  • view
    stringquery

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
POST /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_items

Create Work Order Contract line item

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • work_order_contract_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
GET /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_items/{id}

Show Work Order Contract line item

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • work_order_contract_id
    integerpathrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired
  • view
    stringquery

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
PATCH /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_items/{id}

Update Work Order Contract line item

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • work_order_contract_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 /rest/v1.0/work_order_contracts/{work_order_contract_id}/line_items/{id}

Delete Work Order Contract line item

v1.0Documented

Parameters

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

Response · 200

No response body.

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