Esc

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

Direct Costs

18 endpoints11 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/direct_costsList Direct Cost Items
  2. POST /rest/v1.0/projects/{project_id}/direct_costsCreate Direct Cost Item
  3. GET /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_itemsList Direct Cost Line Items
  4. POST /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_itemsCreate Direct Cost Line Item
  5. GET /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_items/{id}Show Direct Cost Line Item
  6. PATCH /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_items/{id}Update Direct Cost Line Item
  7. DELETE /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_items/{id}Delete a Direct Cost Line Item
  8. GET /rest/v1.0/projects/{project_id}/direct_costs/{id}Show Direct Cost Item
  9. PATCH /rest/v1.0/projects/{project_id}/direct_costs/{id}Update Direct Cost Item
  10. DELETE /rest/v1.0/projects/{project_id}/direct_costs/{id}Delete Direct Cost Item
  11. GET /rest/v1.0/projects/{project_id}/direct_costs/line_itemsList All Direct Cost Line Items
  12. PATCH /rest/v1.0/projects/{project_id}/direct_costs/line_items/syncSync Direct Cost Line Items
  13. PATCH /rest/v1.0/projects/{project_id}/direct_costs/syncSync Direct Cost Items
  14. GET /rest/v1.1/projects/{project_id}/direct_costsList Direct Cost Items
  15. POST /rest/v1.1/projects/{project_id}/direct_costsCreate Direct Cost Item
  16. GET /rest/v1.1/projects/{project_id}/direct_costs/{id}Show Direct Cost Item
  17. PATCH /rest/v1.1/projects/{project_id}/direct_costs/{id}Update Direct Cost Item
  18. DELETE /rest/v1.1/projects/{project_id}/direct_costs/{id}Delete Direct Cost Item
GET /rest/v1.0/projects/{project_id}/direct_costs

List Direct Cost Items

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[origin_id]
    stringquery
  • filters[invoice_number]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • filters[payment_date]
    stringquery
  • filters[received_date]
    stringquery

Response · 200 · object[]

  • id
    integer
  • amount
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • direct_cost_type
    string
  • direct_cost_date
    string (date)
  • grand_total
    string
  • invoice_number
    string
  • origin_data
    string
  • origin_id
    string
  • payment_date
    string (date)
  • received_date
    string (date)
  • status
    string
  • terms
    string
  • updated_at
    string (date-time)
  • vendor
    string
  • vendor_id
    integer
  • vendor_name
    string
  • currency_configuration
    object
  • tax_breakdown
    object
  • employee
    object
POST /rest/v1.0/projects/{project_id}/direct_costs

Create Direct Cost Item

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • attachments
    string[]
  • item
    objectrequired

Response · 201 · object

  • id
    integer
  • attachments
    object[]
  • attachments_count
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • direct_cost_type
    string
  • employee
    object
  • invoice_number
    string
  • direct_cost_date
    string (date)
  • origin_data
    string
  • origin_id
    string
  • grand_total
    string
  • line_items_count
    integer
  • payment_date
    string (date)
  • received_date
    string (date)
  • status
    string
  • terms
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • vendor_id
    integer
  • vendor_name
    string
  • currency_configuration
    object
  • tax_breakdown
    object
GET /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_items

List Direct Cost Line Items

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • direct_cost_id
    integerpathrequired
  • 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
  • funding_rule_id
    integer
  • 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
  • updated_at
    string (date-time)
  • change_event_line_item
    object
  • wbs_code
    object
  • currency_configuration
    object
POST /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_items

Create Direct Cost Line Item

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • direct_cost_id
    integerpathrequired

Request body

  • 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
  • funding_rule_id
    integer
  • 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
  • updated_at
    string (date-time)
  • change_event_line_item
    object
  • wbs_code
    object
  • currency_configuration
    object
GET /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_items/{id}

Show Direct Cost Line Item

v1.0Documented

Parameters

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

Response · 200 · object

  • id
    integer
  • amount
    string
  • company
    object
  • cost_code
    object
  • created_at
    string (date-time)
  • extended_type
    string
  • holder
    object
  • funding_rule_id
    integer
  • 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
  • updated_at
    string (date-time)
  • change_event_line_item
    object
  • wbs_code
    object
  • currency_configuration
    object
PATCH /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_items/{id}

Update Direct Cost Line Item

v1.0Documented

Parameters

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

Request body

  • 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
  • funding_rule_id
    integer
  • 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
  • updated_at
    string (date-time)
  • change_event_line_item
    object
  • wbs_code
    object
  • currency_configuration
    object
DELETE /rest/v1.0/projects/{project_id}/direct_costs/{direct_cost_id}/line_items/{id}

Delete a Direct Cost Line Item

v1.0Documented

Parameters

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

Response · 200

No response body.

GET /rest/v1.0/projects/{project_id}/direct_costs/{id}

Show Direct Cost Item

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • attachments
    object[]
  • attachments_count
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • direct_cost_type
    string
  • employee
    object
  • invoice_number
    string
  • direct_cost_date
    string (date)
  • origin_data
    string
  • origin_id
    string
  • grand_total
    string
  • line_items_count
    integer
  • payment_date
    string (date)
  • received_date
    string (date)
  • status
    string
  • terms
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • vendor_id
    integer
  • vendor_name
    string
  • currency_configuration
    object
  • tax_breakdown
    object
PATCH /rest/v1.0/projects/{project_id}/direct_costs/{id}

Update Direct Cost Item

v1.0Implemented

Parameters

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

Request body

  • attachments
    string[]
  • item
    object

Response · 200 · object

  • id
    integer
  • attachments
    object[]
  • attachments_count
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • direct_cost_type
    string
  • employee
    object
  • invoice_number
    string
  • direct_cost_date
    string (date)
  • origin_data
    string
  • origin_id
    string
  • grand_total
    string
  • line_items_count
    integer
  • payment_date
    string (date)
  • received_date
    string (date)
  • status
    string
  • terms
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • vendor_id
    integer
  • vendor_name
    string
  • currency_configuration
    object
  • tax_breakdown
    object
DELETE /rest/v1.0/projects/{project_id}/direct_costs/{id}

Delete Direct Cost Item

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integer
GET /rest/v1.0/projects/{project_id}/direct_costs/line_items

List All Direct Cost Line Items

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[direct_cost_id]
    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
  • cost_code
    object
  • created_at
    string (date-time)
  • extended_amount
    string (float)
  • extended_type
    string
  • holder
    object
  • line_item_type
    object
  • origin_id
    string
  • funding_rule_id
    integer
  • position
    integer
  • project
    object
  • quantity
    string (float)
  • sub_job_id
    integer
  • tax_code_id
    integer
  • total_amount
    string (float)
  • unit_cost
    string (float)
  • uom
    string
  • updated_at
    string (date-time)
  • wbs_code
    object
  • currency_configuration
    object
PATCH /rest/v1.0/projects/{project_id}/direct_costs/line_items/sync

Sync Direct Cost Line Items

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • updates
    object[]required

Response · 200 · object

  • entities
    object[]
  • errors
    object[]
PATCH /rest/v1.0/projects/{project_id}/direct_costs/sync

Sync Direct Cost Items

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • updates
    object[]required

Response · 200 · object

  • entities
    object[]
  • errors
    object[]
GET /rest/v1.1/projects/{project_id}/direct_costs

List Direct Cost Items

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[origin_id]
    stringquery
  • filters[invoice_number]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • filters[payment_date]
    stringquery
  • filters[received_date]
    stringquery

Response · 200 · object[]

  • id
    integer
  • amount
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • direct_cost_type
    string
  • direct_cost_date
    string (date)
  • grand_total
    string
  • invoice_number
    string
  • origin_data
    string
  • origin_id
    string
  • payment_date
    string (date)
  • received_date
    string (date)
  • status
    string
  • terms
    string
  • updated_at
    string (date-time)
  • vendor
    string
  • vendor_id
    integer
  • vendor_name
    string
  • currency_configuration
    object
  • tax_breakdown
    object
  • employee
    object
POST /rest/v1.1/projects/{project_id}/direct_costs

Create Direct Cost Item

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • attachments
    string[]
  • direct_cost
    objectrequired

Response · 201 · object

  • id
    integer
  • attachments
    object[]
  • attachments_count
    integer
  • company
    object
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • direct_cost_type
    string
  • employee
    object
  • invoice_number
    string
  • direct_cost_date
    string (date)
  • origin_data
    string
  • origin_id
    string
  • grand_total
    string
  • line_items_count
    integer
  • payment_date
    string (date)
  • project
    object
  • received_date
    string (date)
  • status
    string
  • synced
    boolean
  • has_workflows
    boolean
  • terms
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • vendor_id
    integer
  • vendor_name
    string
  • currency_configuration
    object
  • tax_breakdown
    object
  • line_items
    object[]
GET /rest/v1.1/projects/{project_id}/direct_costs/{id}

Show Direct Cost Item

v1.1Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • attachments
    object[]
  • attachments_count
    integer
  • company
    object
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • direct_cost_type
    string
  • employee
    object
  • invoice_number
    string
  • direct_cost_date
    string (date)
  • origin_data
    string
  • origin_id
    string
  • grand_total
    string
  • line_items_count
    integer
  • payment_date
    string (date)
  • project
    object
  • received_date
    string (date)
  • status
    string
  • synced
    boolean
  • has_workflows
    boolean
  • terms
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • vendor_id
    integer
  • vendor_name
    string
  • currency_configuration
    object
  • tax_breakdown
    object
  • line_items
    object[]
PATCH /rest/v1.1/projects/{project_id}/direct_costs/{id}

Update Direct Cost Item

v1.1Implemented

Parameters

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

Request body

  • attachments
    string[]
  • direct_cost
    object

Response · 200 · object

  • id
    integer
  • attachments
    object[]
  • attachments_count
    integer
  • company
    object
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • direct_cost_type
    string
  • employee
    object
  • invoice_number
    string
  • direct_cost_date
    string (date)
  • origin_data
    string
  • origin_id
    string
  • grand_total
    string
  • line_items_count
    integer
  • payment_date
    string (date)
  • project
    object
  • received_date
    string (date)
  • status
    string
  • synced
    boolean
  • has_workflows
    boolean
  • terms
    string
  • updated_at
    string (date-time)
  • vendor
    object
  • vendor_id
    integer
  • vendor_name
    string
  • currency_configuration
    object
  • tax_breakdown
    object
  • line_items
    object[]
DELETE /rest/v1.1/projects/{project_id}/direct_costs/{id}

Delete Direct Cost Item

v1.1Implemented

Parameters

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

Response · 200 · object

  • id
    integer

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