BIbigchange
PurchaseOrders

Get a purchase order line item

Retrieve the details of a single purchase order line item (required scope finance:read)

get/v1/finance/purchaseorders/{purchaseOrderId}/lineItems/{lineItemId}

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/finance/purchaseorders/{purchaseOrderId}/lineItems/{lineItemId}
  • Auth
    HTTP bearer

Path parameters

purchaseOrderIdinteger required

The unique identifier of the purchase order associated with the line item

lineItemIdinteger required

The unique identifier of the purchase order line item

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier associated with the purchase order line item

purchaseOrderIdinteger nullable

The unique identifier of the purchase order associated with the purchase order line item

contactIdinteger nullable

The unique identifier of the contact associated with the purchase order line item

createdAtstring date-time

The date and time when the purchase order line item was created

quantitynumber double

The quantity of the line item

descriptionstring

Description of the purchase order line item

taxIdinteger nullable

VAT / Tax identifier associated with the line item

taxPercentagenumber double

Tax percentage applied to the line item (GET only, never null). Defaults to 0 when no tax is applied

unitCostnumber double nullable

Unit cost of the item (cannot be negative)

unitSellingPricenumber double

Unit selling price of the item (cannot be negative)

taxAmountnumber double nullable

Tax amount for the line item (GET only)

grossAmountnumber double nullable

Gross amount (formerly NetPrice internal) of the line item (GET only)

nominalCodeIdinteger nullable

Nominal code identifier

departmentCodeIdinteger nullable

Department code identifier

Example response

{
  "id": 12345,
  "purchaseOrderId": 54321,
  "quantity": 5,
  "description": "Replacement filter cartridge",
  "taxId": 1001,
  "taxPercentage": 20,
  "unitCost": 5.5,
  "unitSellingPrice": 10.99,
  "taxAmount": 2.2,
  "grossAmount": 13.19,
  "nominalCodeId": 50001,
  "departmentCodeId": 20002
}

Changes

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