Esc

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

Materials

16 endpoints16 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/materialsList Materials
  2. POST /rest/v1.0/projects/{project_id}/materialsCreate Material
  3. GET /rest/v1.0/projects/{project_id}/materials/{id}Show Material
  4. PATCH /rest/v1.0/projects/{project_id}/materials/{id}Update Material
  5. PATCH /rest/v1.0/projects/{project_id}/materials/{id}/restoreRestore Material
  6. GET /rest/v1.0/projects/{project_id}/materials/deliveriesList Deliveries
  7. POST /rest/v1.0/projects/{project_id}/materials/deliveriesCreate Delivery
  8. GET /rest/v1.0/projects/{project_id}/materials/deliveries/{id}Show Delivery
  9. PATCH /rest/v1.0/projects/{project_id}/materials/deliveries/{id}Update Delivery
  10. GET /rest/v1.0/projects/{project_id}/materials/deliveries/{id}/attachmentsList Delivery Attachments
  11. POST /rest/v1.0/projects/{project_id}/materials/deliveries/{id}/attachmentsAdd Delivery Attachments
  12. DELETE /rest/v1.0/projects/{project_id}/materials/deliveries/{id}/attachments/{attachment_id}Remove Delivery Attachment
  13. PATCH /rest/v1.0/projects/{project_id}/materials/deliveries/{id}/restoreRestore Delivery
  14. GET /rest/v1.0/projects/{project_id}/materials/deliveries/recycle_binList Recycled Deliveries
  15. GET /rest/v1.0/projects/{project_id}/materials/filter_options/categoryMaterial category filter options
  16. GET /rest/v1.0/projects/{project_id}/materials/recycle_binList Recycled Materials
GET /rest/v1.0/projects/{project_id}/materials

List Materials

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · Material[]

  • id
    integerrequired
  • name
    stringrequired
  • uom
    stringrequired
  • category
    string
  • quantity_on_hand
    stringrequired
  • unit_cost
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • project_id
    integerrequired
  • cost_code_id
    integer
  • cost_code
    CostCodeStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
POST /rest/v1.0/projects/{project_id}/materials

Create Material

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · Material

  • id
    integerrequired
  • name
    stringrequired
  • uom
    stringrequired
  • category
    string
  • quantity_on_hand
    stringrequired
  • unit_cost
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • project_id
    integerrequired
  • cost_code_id
    integer
  • cost_code
    CostCodeStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/materials/{id}

Show Material

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Material

  • id
    integerrequired
  • name
    stringrequired
  • uom
    stringrequired
  • category
    string
  • quantity_on_hand
    stringrequired
  • unit_cost
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • project_id
    integerrequired
  • cost_code_id
    integer
  • cost_code
    CostCodeStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
PATCH /rest/v1.0/projects/{project_id}/materials/{id}

Update Material

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Material

  • id
    integerrequired
  • name
    stringrequired
  • uom
    stringrequired
  • category
    string
  • quantity_on_hand
    stringrequired
  • unit_cost
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • project_id
    integerrequired
  • cost_code_id
    integer
  • cost_code
    CostCodeStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
PATCH /rest/v1.0/projects/{project_id}/materials/{id}/restore

Restore Material

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Material

  • id
    integerrequired
  • name
    stringrequired
  • uom
    stringrequired
  • category
    string
  • quantity_on_hand
    stringrequired
  • unit_cost
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • project_id
    integerrequired
  • cost_code_id
    integer
  • cost_code
    CostCodeStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/materials/deliveries

List Deliveries

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · DeliveryListItem[]

  • id
    integerrequired
  • number
    stringrequired
  • delivery_date
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • tracking_number
    string
  • notes
    string
  • project_id
    integerrequired
  • vendor_id
    integer
  • vendor
    VendorStub
  • received_by
    UserStub
  • line_items_count
    integerrequired
  • attachments_count
    integer
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • contract_type
    string
  • contract_id
    integer
  • commitment
    CommitmentStub
POST /rest/v1.0/projects/{project_id}/materials/deliveries

Create Delivery

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · DeliveryShow

  • id
    integerrequired
  • number
    stringrequired
  • delivery_date
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • tracking_number
    string
  • notes
    string
  • project_id
    integerrequired
  • vendor_id
    integer
  • vendor
    VendorStub
  • received_by
    UserStub
  • line_items_count
    integerrequired
  • attachments_count
    integer
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • contract_type
    string
  • contract_id
    integer
  • commitment
    CommitmentStub
  • line_items
    DeliveryItem[]required
  • attachments
    Attachment[]required
GET /rest/v1.0/projects/{project_id}/materials/deliveries/{id}

Show Delivery

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · DeliveryShow

  • id
    integerrequired
  • number
    stringrequired
  • delivery_date
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • tracking_number
    string
  • notes
    string
  • project_id
    integerrequired
  • vendor_id
    integer
  • vendor
    VendorStub
  • received_by
    UserStub
  • line_items_count
    integerrequired
  • attachments_count
    integer
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • contract_type
    string
  • contract_id
    integer
  • commitment
    CommitmentStub
  • line_items
    DeliveryItem[]required
  • attachments
    Attachment[]required
PATCH /rest/v1.0/projects/{project_id}/materials/deliveries/{id}

Update Delivery

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · DeliveryShow

  • id
    integerrequired
  • number
    stringrequired
  • delivery_date
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • tracking_number
    string
  • notes
    string
  • project_id
    integerrequired
  • vendor_id
    integer
  • vendor
    VendorStub
  • received_by
    UserStub
  • line_items_count
    integerrequired
  • attachments_count
    integer
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • contract_type
    string
  • contract_id
    integer
  • commitment
    CommitmentStub
  • line_items
    DeliveryItem[]required
  • attachments
    Attachment[]required
GET /rest/v1.0/projects/{project_id}/materials/deliveries/{id}/attachments

List Delivery Attachments

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Attachment[]

  • id
    integerrequired
  • name
    stringrequired
  • filename
    string
  • url
    stringrequired
  • can_be_viewed
    boolean
POST /rest/v1.0/projects/{project_id}/materials/deliveries/{id}/attachments

Add Delivery Attachments

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 201 · DeliveryShow

  • id
    integerrequired
  • number
    stringrequired
  • delivery_date
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • tracking_number
    string
  • notes
    string
  • project_id
    integerrequired
  • vendor_id
    integer
  • vendor
    VendorStub
  • received_by
    UserStub
  • line_items_count
    integerrequired
  • attachments_count
    integer
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • contract_type
    string
  • contract_id
    integer
  • commitment
    CommitmentStub
  • line_items
    DeliveryItem[]required
  • attachments
    Attachment[]required
DELETE /rest/v1.0/projects/{project_id}/materials/deliveries/{id}/attachments/{attachment_id}

Remove Delivery Attachment

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • attachment_id
    stringpathrequired

Response · 200 · DeliveryShow

  • id
    integerrequired
  • number
    stringrequired
  • delivery_date
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • tracking_number
    string
  • notes
    string
  • project_id
    integerrequired
  • vendor_id
    integer
  • vendor
    VendorStub
  • received_by
    UserStub
  • line_items_count
    integerrequired
  • attachments_count
    integer
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • contract_type
    string
  • contract_id
    integer
  • commitment
    CommitmentStub
  • line_items
    DeliveryItem[]required
  • attachments
    Attachment[]required
PATCH /rest/v1.0/projects/{project_id}/materials/deliveries/{id}/restore

Restore Delivery

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · DeliveryShow

  • id
    integerrequired
  • number
    stringrequired
  • delivery_date
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • tracking_number
    string
  • notes
    string
  • project_id
    integerrequired
  • vendor_id
    integer
  • vendor
    VendorStub
  • received_by
    UserStub
  • line_items_count
    integerrequired
  • attachments_count
    integer
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • contract_type
    string
  • contract_id
    integer
  • commitment
    CommitmentStub
  • line_items
    DeliveryItem[]required
  • attachments
    Attachment[]required
GET /rest/v1.0/projects/{project_id}/materials/deliveries/recycle_bin

List Recycled Deliveries

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · DeliveryListItem[]

  • id
    integerrequired
  • number
    stringrequired
  • delivery_date
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • tracking_number
    string
  • notes
    string
  • project_id
    integerrequired
  • vendor_id
    integer
  • vendor
    VendorStub
  • received_by
    UserStub
  • line_items_count
    integerrequired
  • attachments_count
    integer
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • contract_type
    string
  • contract_id
    integer
  • commitment
    CommitmentStub
GET /rest/v1.0/projects/{project_id}/materials/filter_options/category

Material category filter options

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · FilterOption[]

  • key
    stringrequired
  • value
    stringrequired
GET /rest/v1.0/projects/{project_id}/materials/recycle_bin

List Recycled Materials

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · Material[]

  • id
    integerrequired
  • name
    stringrequired
  • uom
    stringrequired
  • category
    string
  • quantity_on_hand
    stringrequired
  • unit_cost
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • project_id
    integerrequired
  • cost_code_id
    integer
  • cost_code
    CostCodeStub
  • created_at
    stringrequired
  • updated_at
    stringrequired

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