Skip to content

Get an invoice line

Finance module

GET/invoice-lines/{id}invoiceLines.get

A line of an invoice. Returns one invoice line with its `ETag`. A invoice line the caller may not see returns 404.

  • Requires the capability finance.invoice.read.
  • OAuth scopes: finance.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

invoiceLines.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the invoice line.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: InvoiceLine

invoiceLines.get: InvoiceLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the invoice line.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
invoice_idstring (uuid)YesIdentifier of the invoice.
descriptionstringYesLine description.Constraints: length 1 to 300
quantitynumber | nullYesQuantity.
unit_price_minorinteger (int64) | nullYesUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
line_numberintegerYesLine number within the invoice.Constraints: range 1 to any
budget_line_idstring (uuid) | nullYesIdentifier of the budget line.
tax_rate_idstring (uuid) | nullYesIdentifier of the tax rate.
uridUridAtAnyGrain | nullYes
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Stage deck rental",
  "quantity": 24,
  "unit_price_minor": 4500,
  "line_number": 1,
  "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "tax_rate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "urid": "4000.01"
}

Code samples

curl -X GET "$XOS_BASE_URL/invoice-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.invoiceLines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.invoice_lines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos invoice-lines get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f