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

The cost of the material for this job. This is the ex-tax amount.

displayed_coststring

The cost of the material for this job, displayed as inc-tax or ex-tax depending on jobMaterial.displayed_amount_is_tax_inclusive.

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-7fbe-4fa5-a449-231fe25f905b",
  "edit_date": "2025-08-01 12:00:00",
  "job_uuid": "123e4567-e80c-4f95-af78-231fe8cf450b",
  "material_uuid": "123e4567-aae0-4ea2-a2e9-231fe1ee41eb",
  "tax_rate_uuid": "123e4567-0195-43e5-9d1a-231fe92e08cb",
  "job_material_bundle_uuid": "123e4567-4f02-4800-8b33-231fe98fad0b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes