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
hasException	boolean	Indicates whether the invoice item has any exceptions	false
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	"This item is important"
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
taxCode	string?	Tax code applicable to this invoice item	"CA"
taxRate	float?	Tax rate applied to this invoice item	0.075
phaseCode	string?	Phase code associated with this invoice item	"100"
costCategory	string?	Cost category code associated with this invoice item	"M"

REST Endpoints

GET /invoices/:id/items

Read the items associated with an invoice

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 Invoice Item objects.

Example Request

GET https://api.kojo.tech/invoices/ckmnpybisiy5x08abky4g2d1f/items

Example Response

[
  {
      "id": "clku7gtqt000cpwtzv6e971xg",
      "createdAt": "2021-03-24 17:26:46.983Z",
      "updatedAt": "2021-03-24 17:26:46.983Z",
      "description": "LUT CABLE",
      "extPriceFloat": 1328.22,
      "hasException": false,
      "invoiceId": "ckmnpybisiy5x08abky4g2d1f",
      "lineNumber": 1,
      "notes": null,
      "shipQuantity": 1,
      "unitPriceFloat": 1328.22,
      "unitsOfMeasure": "EA",
      "taxCode": "test",
      "taxRate": 0,
      "phaseCode": "1-010",
      "costCategory": "L"
  }
]