PayItem

Returns pay items

This call returns a list of pay items for the specified job.

Securitybearer
Request
query Parameters
jobId
string <uuid>

If specified, only returns pay items for this job.

isDeleted
boolean

If specified, only returns pay items that match the isDeleted value

cursor
string

A pagination cursor.

limit
integer <int32> [ 1 .. 1000 ]
Default: 1000

The maximum number of items to return.

Responses
get/api/v1/payItems
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Creates a new pay item.
The combination of jobId and pay item code must be unique.


The pay item code will be uppercased.  The pay item code,
description, owner code, and unit of measure will be trimmed.


Securitybearer 
Request 
Request Body schema: 
required
status
string (PayItemStatus) 
 Enum: "active" "completed" "cancelled"  
description
string or null  <= 200 characters 
A description for this pay item.


 
ownerCode
string or null  <= 50 characters 
The associated pay item code in the owner's system.


 
contractQuantity
number or null <double> 
The agreed-to quantity between the owner and the company.


 
unitOfMeasure
string or null  <= 50 characters 
The unit of measure used to bill the owner for this pay item.


 
unitPrice
number or null <double> 
The unit price used to bill the owner for this pay item.


 
stopOverruns
boolean or null
Whether to cap the billable quantity at the HeavyJobApi.Controllers.Models.PayItem.ApiPayItemWriteBase.ContractQuantity


 
notes
string or null  <= 500 characters 
Notes associated with this pay item.


 
jobId
required
string <uuid> 
The job that this pay item is associated with.


 
payItem
required
string  [ 1 .. 50 ] characters 
A unique code that describes this pay item.


 
accountingCode
string or null  <= 100 characters 
The accounting code value for this pay item.


 
Responses 
post/api/v1/payItems
Request samples 
{
  • "jobId": "962e2370-fbe4-4123-b163-73e557b12ca9",
  • "payItem": "PI1",
  • "status": "active",
  • "description": "Pay Item 1",
  • "ownerCode": "OWNER1",
  • "contractQuantity": 525,
  • "unitOfMeasure": "SF",
  • "unitPrice": 10.25,
  • "stopOverruns": true,
  • "notes": "This is a pay item for OWNER1."
}
Response samples 
application/json
{
  • "id": "49779959-0c77-4b08-bb1e-5aba18825233",
  • "jobId": "766161c0-916a-4a1c-b772-be665e6d609c",
  • "payItem": "PI1",
  • "description": "Pay Item 1",
  • "status": "active",
  • "ownerCode": "OWNER1",
  • "contractQuantity": 253.5,
  • "unitOfMeasure": "SF",
  • "unitPrice": 10.25,
  • "stopOverruns": true,
  • "notes": "This is a pay item.",
  • "linkedCostCodes": [
    ],
  • "isDeleted": false
}
Bulk upsert pay items by code and job id.
The pay item code will be uppercased.  The pay item code,
description, owner code, and unit of measure will be trimmed.


Securitybearer 
Request 
query Parameters
createOnly
boolean
 Default:  false
If true, no updates will be performed, and existing records will
be kept as-is.  New records will still be created.  This is useful
if pay items are synced from an external system, and the user wants
to preserve manual edits that are not in the external system.
If false, the behavior will be determined by the addToExisting parameter.


 
addToExisting
boolean
 Default:  false
If true, the passed quantity will be added to the existing quantity.
Otherwise, the passed quantity will overwrite the existing quantity.


 
Request Body schema: 
required
The pay items.


 Array (<= 10000 items)
status
string (PayItemStatus) 
 Enum: "active" "completed" "cancelled"  
description
string or null  <= 200 characters 
A description for this pay item.


 
ownerCode
string or null  <= 50 characters 
The associated pay item code in the owner's system.


 
contractQuantity
number or null <double> 
The agreed-to quantity between the owner and the company.


 
unitOfMeasure
string or null  <= 50 characters 
The unit of measure used to bill the owner for this pay item.


 
unitPrice
number or null <double> 
The unit price used to bill the owner for this pay item.


 
stopOverruns
boolean or null
Whether to cap the billable quantity at the HeavyJobApi.Controllers.Models.PayItem.ApiPayItemWriteBase.ContractQuantity


 
notes
string or null  <= 500 characters 
Notes associated with this pay item.


 
jobId
required
string <uuid> 
The job that this pay item is associated with.


 
payItem
required
string  [ 1 .. 50 ] characters 
A unique code that describes this pay item.


 
accountingCode
string or null  <= 100 characters 
The accounting code value for this pay item.


 
Responses 
204
No Content


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


patch/api/v1/payItems
Request samples 
[
  • {
    }
]
Returns pay items
VOLATILE
        The query parameters and responses are likely to change. Do not use this operation for mission-critical applications yet.
        

This call returns a list of pay items for the specified job.


Securitybearer 
Request 
query Parameters
jobId
string <uuid> 
If specified, only returns pay items for this job.


 
cursor
string
A pagination cursor.


 
modifiedSince
string <date-time> 
If specified, returns only records that have been modified since this time.  In RFC-3339 format.  (yyyy-MM-ddThh:mm:ssZ)


 
limit
integer <int32>   [ 1 .. 1000 ] 
 Default:  1000
The maximum number of items to return.


 
Responses 
get/api/v2/payItems
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Get Pay Item by Id
VOLATILE
        The query parameters and responses are likely to change. Do not use this operation for mission-critical applications yet.
        



Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
Pay Item Id


 
Responses 
200
Success


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
The specified resource is not found.


get/api/v1/payItems/{id}
Request samples 
Response samples 
application/json
{
  • "id": "49779959-0c77-4b08-bb1e-5aba18825233",
  • "jobId": "766161c0-916a-4a1c-b772-be665e6d609c",
  • "payItem": "PI1",
  • "description": "Pay Item 1",
  • "status": "active",
  • "ownerCode": "OWNER1",
  • "contractQuantity": 253.5,
  • "unitOfMeasure": "SF",
  • "unitPrice": 10.25,
  • "stopOverruns": true,
  • "notes": "This is a pay item.",
  • "linkedCostCodes": [
    ],
  • "isDeleted": false
}
Updates all the cost codes on all pay items for a job
VOLATILE
        The query parameters and responses are likely to change. Do not use this operation for mission-critical applications yet.
        

Updates all the cost codes on all pay items for a job


Securitybearer 
Request 
query Parameters
jobId
required
string <uuid> 
The job ID to update.


 
markAsDriver
required
boolean
Boolean to mark all code cost driver fields with.


 
Responses 
204
No Content


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


get/api/v2/payItems/markAllLinkedCostCodes
Request samples