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

job_uuidstring uuid

The UUID of the job this material is associated with. This is a required field that establishes the relationship between the job material and its parent job.

material_uuidstring uuid

The UUID of the material catalog item this job material is based on. Links the job material to the corresponding material in the materials catalog.

namestring

The name of the material item used on the job. This is displayed on invoices and is used to identify the material to the customer. The name typically comes from the associated material object but can be customized per job.

quantitystring required

The quantity of this material used on the job. This field is mandatory and cannot be empty.

pricestring

The unit price of the material excluding tax. Used in calculations to determine the total price for this line item on the job. The system may automatically adjust this value to maintain consistency with tax-inclusive pricing.

displayed_amountstring

The unit price amount as displayed on invoices and quotes. This can be either tax-inclusive or tax-exclusive depending on the displayed_amount_is_tax_inclusive field value. Used for presentation to customers.

displayed_amount_is_tax_inclusivestring

Boolean flag indicating whether the displayed_amount includes tax (true) or excludes tax (false). This controls how prices are presented to customers and determines which price value (inclusive or exclusive) is used in calculations.

tax_rate_uuidstring uuid

The UUID of the tax rate applied to this job material. Determines how tax is calculated for this specific line item.

sort_orderstring

Integer value controlling the display order of materials on a job. Lower values appear first in lists. Used to customize the presentation order of materials on quotes, invoices and job forms.

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.

uuidstring uuid

Unique identifier for this record

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

{
  "job_uuid": "123e4567-9fc9-48a4-890d-2346740a9abb",
  "material_uuid": "123e4567-254b-4900-bc16-234675b70bcb",
  "tax_rate_uuid": "123e4567-f190-40a7-a240-234671b7cafb",
  "uuid": "123e4567-1ba7-4870-b862-23467e2bedcb",
  "job_material_bundle_uuid": "123e4567-07b8-403a-aaaf-23467049b34b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes