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-df7f-4659-a5ed-230b73447abb",
  "edit_date": "2025-07-01 12:00:00",
  "job_uuid": "123e4567-2f90-40b8-b570-230b7aa4214b",
  "material_uuid": "123e4567-3372-401e-9154-230b7ca7481b",
  "tax_rate_uuid": "123e4567-5499-4e36-86b3-230b75c3cffb",
  "job_material_bundle_uuid": "123e4567-b730-4448-be14-230b7aa2c89b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes