BIbigchange
Jobs

Create a job line item

Create a new job line item (required scope jobs:write)

post/v1/jobs/{jobId}/lineItems

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/jobs/{jobId}/lineItems
  • Auth
    HTTP bearer

Path parameters

jobIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

contactIdinteger nullable

The unique identifier of the contact associated with this job item

quantitynumber double required

The quantity of the job item

descriptionstring

Description of the job line item

taxIdinteger nullable

Tax identifier (must exist and not be deleted for customer). Nullable

unitCostnumber double nullable

Unit cost (nullable, non-negative)

unitSellingPricenumber double

Unit selling price (non-negative)

nominalCodeIdinteger nullable

Nominal code identifier (must exist and not be deleted for customer)

departmentCodeIdinteger nullable

Department code identifier (must exist and not be deleted for customer)

Example request

{
  "contactId": 54321,
  "quantity": 1,
  "description": "Replacement filter cartridge",
  "taxId": 1001,
  "unitCost": 5.5,
  "unitSellingPrice": 10.99,
  "nominalCodeId": 50001,
  "departmentCodeId": 20002
}

Response

Created

idinteger

Identifier of the newly created record

Changes

No recorded changes to this operation across all 13 revisions of this API.