Retrieve an invoice line item
get
/v1/invoice-line-items/{id}Returns one invoice line item by ID. Available to keys belonging to office staff.
Path parameters
id
stringrequired
ID of the invoice line item.
Response
200The invoice line item.
object
stringread-only
String representing the object's type. Always invoice_line_item.
id
stringread-only
Unique identifier of the invoice line item.
invoiceId
string | nullread-onlymax length 64
The invoice this line belongs to.
description
string | nullread-onlymax length 20000
Line description.
quantity
number | nullread-only
Quantity, such as hours.
unitPriceCents
integer | nullread-only
Price per unit. In cents.
totalCents
integer | nullread-only
Line total. In cents.
serviceCode
string | nullread-onlymax length 2000
Service code.
serviceCategory
string | nullread-onlymax length 2000
Service category.
visitId
string | nullread-onlymax length 64
The visit this line bills.
visitDate
string · date | nullread-only
Date of the visit.
sortOrder
integer | nullread-only
Position of the line on the invoice.
createdAt
string · date-time | nullread-only
When the invoice line item was created.
updatedAt
string · date-time | nullread-only
When the invoice line item was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 404 | n/a | No such object, or it is not visible to this key (not_found). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.