CostTypeQuantity

Returns installed material quantities

This call returns a list of installed material quantities for the specified job, foreman, date range or modified since date.

Securitybearer
Request
query Parameters
jobId
string <uuid>

The job id to query by. If omitted, returns records across all jobs.

foremanId
string <uuid>

The foreman id to query by. If omitted, returns records across all foremen.

startDate
string <date-time>

The start date (yyyy-MM-dd) to query by. If omitted, returns records from the beginning of time. (bounded by the end date).

endDate
string <date-time>

The end date (yyyy-MM-dd) to query by. If omitted, returns records until the end of time. (bounded by the start date).

modifiedSince
string <date-time>

The modified since date (yyyy-MM-ddThh:mm:ssZ Or yyyy-MM-ddThh:mm:ss.FFFFFFFZ) to query by. If specified, returns records modified since this time.

limit
integer <int32>
Default: 1000

The maximum number of results that should be returned.

cursor
string

Optional. When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.

Responses
get/api/v1/costTypeQuantities/materialInstalled
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Returns subcontract work performed quantities
This call returns a list of subcontract work performed quantities for the specified job, foreman, date range or modified since date.


Securitybearer 
Request 
query Parameters
jobId
string <uuid> 
The job id to query by. If omitted, returns records across all jobs.


 
foremanId
string <uuid> 
The foreman id to query by. If omitted, returns records across all foremen.


 
startDate
string <date-time> 
The start date (yyyy-MM-dd) to query by. If omitted, returns records from the beginning of time. (bounded by the end date).


 
endDate
string <date-time> 
The end date (yyyy-MM-dd) to query by. If omitted, returns records until the end of time. (bounded by the start date).


 
modifiedSince
string <date-time> 
The modified since date (yyyy-MM-ddThh:mm:ssZ Or yyyy-MM-ddThh:mm:ss.FFFFFFFZ) to query by. If specified, returns records modified since this time.


 
limit
integer <int32> 
 Default:  1000
The maximum number of results that should be returned.


 
cursor
string
Optional.  When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.


 
Responses 
get/api/v1/costTypeQuantities/subcontractWorked
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Returns quantity adjustment changes
This call returns a list of quantity changes that have been applied through quantity adjustments for the specified job, foreman, date range or modified since date.


Securitybearer 
Request 
query Parameters
jobId
string <uuid> 
The job id to query by. If omitted, returns records across all jobs.


 
foremanId
string <uuid> 
The foreman id to query by. If omitted, returns records across all foremen.


 
startDate
string <date-time> 
The start date (yyyy-MM-dd) to query by. If omitted, returns records from the beginning of time. (bounded by the end date).


 
endDate
string <date-time> 
The end date (yyyy-MM-dd) to query by. If omitted, returns records until the end of time. (bounded by the start date).


 
modifiedSince
string <date-time> 
The modified since date (yyyy-MM-ddThh:mm:ssZ Or yyyy-MM-ddThh:mm:ss.FFFFFFFZ) to query by. If specified, returns records modified since this time.


 
limit
integer <int32> 
 Default:  1000
The maximum number of results that should be returned.


 
cursor
string
Optional.  When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.


 
Responses 
get/api/v1/costTypeQuantities/adjustments
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Update an existing received custom cost type item with the values provided.
Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
 
Request Body schema: 
id
string <uuid> 
The id for the custom cost type received item


 
quantity
number or null <double> 
The quantity for the received material.


 
loads
integer or null <int32> 
The number of loads.


 
referenceNumber
string or null  <= 100 characters 
The reference number.


 
invoiceNumber
string or null  <= 100 characters 
The invoice number.


 
isInvoiced
boolean or null
The is invoiced flag


 
note
string or null
Note


 
Responses 
patch/api/v1/costTypeQuantities/customReceived/{id}
Request samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "quantity": 0,
  • "loads": 0,
  • "referenceNumber": "string",
  • "invoiceNumber": "string",
  • "isInvoiced": true,
  • "note": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "jobCustomCostTypeItemId": "5997e37f-1f9f-43d2-85ab-510b4f512322",
  • "foremanId": "69aa527e-0e0a-4642-a268-867ccfbc3591",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "date": "2019-08-24T14:15:22Z",
  • "referenceNumber": "string",
  • "invoiceNumber": "string",
  • "isInvoiced": true,
  • "quantity": 0,
  • "unitOfMeasure": "string",
  • "purchaseOrderId": "84a099d9-2935-4997-a6ac-0d3ee9bbef72",
  • "vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0"
}