BIbigchange
JobGroups

Create a job group line item

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

post/v1/jobGroups/{jobGroupId}/lineItems

Request

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

Path parameters

jobGroupIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

contactIdinteger nullable

Contact id that the costs are charged to

quantitynumber double required

Quantity of the line item

descriptionstring

Description of the 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

Id of the associated nominal code

departmentCodeIdinteger nullable

Id of the associated department code

Example request

{
  "contactId": 6547,
  "quantity": 5,
  "description": "Copper pipe - 1m",
  "taxId": 1,
  "unitCost": 2.5,
  "unitSellingPrice": 5.99,
  "nominalCodeId": 45,
  "departmentCodeId": 59
}

Response

Created

idinteger

Identifier of the newly created record

Changes

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