Invoice Items

Invoice Item represents an individual line item on an Invoice

Schema

InvoiceItem

Name	Type	Description	Example
id	ID	Unique identifier for invoice items	"ckmnpybisiy5x08abky4g2d1f"
createdAt	DateTime	When this invoice item was created	"2021-03-24 17:26:46.983Z"
updatedAt	DateTime	When this invoice item was updated	"2021-03-24 17:26:46.983Z"
description	string?	Description of the invoice item	3/4" EMT
extPriceFloat	float?	EXT price of the item	125.00
extPriceFloatIncludingTax	float?	EXT price of the item inclusive of tax	130.00
hasException	boolean	Indicates whether the invoice item has any exceptions	true
invoice	Invoice?	Invoice associated with this item	See Invoice docs
invoiceId	ID	The ID of the invoice this item is attached to	"ckmnpybisiy5x08abky4g2d1f"
lineNumber	int	Number representing the index of the line item within it's invoice	3
notes	string?	Additional handwritten details attached to this item	"Set this aside."
shipQuantity	float?	Quantity of this item	100
unitPriceFloat	float?	Unit price of this item	1.25
unitsOfMeasure	string?	Unit of measurement for this item	EA
creditMemoItems	CreditMemoItem[]	Credit memo items associated with this invoice item	See CreditMemoItem
orderItems	Item[]	Order items associated with this invoice item	See Item docs
taxCode	string?	Tax code applicable to this invoice item	"CA"
taxRate	float?	Tax rate applied to this invoice item	0.04
phaseCode	string?	Phase code associated with this invoice item	"450"
costCategory	string?	Cost category code associated with this invoice item	"M"
glCode	GLCode?	GL code associated with this invoice item	"5000"

Queries

invoiceItem

Get a single invoice item by ID.

Parameters

Name	Type	Description
id	ID	ID of the invoice item to fetch

Response

A single InvoiceItem.

Example Request

query {
  invoiceItem(id: "ckb91igzt01e90733giki0v0p") {
    id
    lineNumber
    shipQuantity
    unitPriceFloat
    description
  }
}

Example Response

{
  "id": "ckb91igzt01e90733giki0v0p",
  "lineNumber": 1,
  "shipQuantity": 100,
  "unitPriceFloat": 1328.22,
  "description": "3/4\" EMT",
}

invoiceItems

Get the items on an invoice.

Parameters

Name	Type	Description
invoiceId	ID	ID of the invoice to retrieve items for

Accepts all standard pagination parameters.

Allowed orderBy fields: createdAt, id, lineNumber, updatedAt.

Default (direction, orderBy): (lineNumber, ASC)

Allowed filter fields: createdAt, description, hasException, id, notes, updatedAt.

Response

A list of InvoiceItem objects.

Example Request

query {
  invoiceItems(invoiceId: "ckb91igzt01e90733giki0v0p") {
    id
    lineNumber
    shipQuantity
    unitPriceFloat
    description
  }
}

Example Response

[
  {
    "id": "ckb91igzt01e90733giki0v0p",
    "lineNumber": 1,
    "shipQuantity": 100,
    "unitPriceFloat": 1328.22,
    "description": "3/4\" EMT",
  }
]