Sign in
Job Materials

Create a new Job Material

OAuth Scope

This endpoint requires the following OAuth scope manage_job_materials.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/jobmaterial.json

Request body

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

job_uuidstring uuid
material_uuidstring uuid
namestring
quantitystring required
pricestring
displayed_amountstring
displayed_amount_is_tax_inclusivestring
tax_rate_uuidstring uuid
sort_orderstring
coststring
displayed_coststring
job_material_bundle_uuidstring uuid

UUID of a JobMaterialBundle which this JobMaterial belongs to. The default value is blank, which means that the JobMaterial is not part of a JobMaterialBundle.

Example request

{
  "uuid": "123e4567-1b3a-473e-b6f1-230b73628d6b",
  "edit_date": "2025-07-01 12:00:00",
  "job_uuid": "123e4567-73c4-4446-854b-230b71d3f28b",
  "material_uuid": "123e4567-52bb-4d9c-b366-230b74c6307b",
  "tax_rate_uuid": "123e4567-775b-4d6c-ad93-230b7f45dd5b",
  "job_material_bundle_uuid": "123e4567-f77b-468e-a79d-230b7d7ccd0b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes