Creates a new pay item.

post

https://api.hcssapps.com/heavyjob/api/v1/payItems

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A set of fields for creating a new pay item.

status

string

enum

Allowed:

description

string | null

A description for this pay item.

ownerCode

string | null

The associated pay item code in the owner's system.

contractQuantity

double | null

The agreed-to quantity between the owner and the company.

unitOfMeasure

string | null

The unit of measure used to bill the owner for this pay item.

unitPrice

double | null

The unit price used to bill the owner for this pay item.

stopOverruns

boolean | null

Whether to cap the billable quantity at the HeavyJobApi.Controllers.Models.PayItem.ApiPayItemWriteBase.ContractQuantity

notes

string | null

Notes associated with this pay item.

jobId

uuid

required

The job that this pay item is associated with.

payItem

string

required

length between 1 and 50

A unique code that describes this pay item.

accountingCode

string | null

The accounting code value for this pay item.

uuid | null

The id of this pay item. Optional

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

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.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK