Get a budget line
Finance module
GET/budget-lines/{id}budgetLines.get
A budget line. A blank unit price is unpriced; zero is a claim. Fee and Contingency are line types. Returns one budget line with its `ETag`. A budget line the caller may not see returns 404.
- Requires the capability finance.budget.read.
- OAuth scopes: finance.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the budget line. |
| fields | Fields | No | Sparse 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: BudgetLine
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the budget line. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| budget_id | string (uuid) | Yes | Identifier of the budget. |
| cost_center_id | string (uuid) | null | Yes | Identifier of the cost center. |
| urid | UridAtAnyGrain | Yes | URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$ |
| xyz | Xyz | Yes | XYZ schema-family tag (Section 3.6): X Resource, Y Process, Z Timeline.Constraints: pattern ^[XYZ]$ |
| xyz_basis | string | Yes | Basis for the XYZ tag.Constraints: length 1 to 300 |
| line_type | LineType | Yes | Budget line type from the budget template specification (Bible tab 34). Fee and Contingency are line types, not accounts.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| grade_code | string | null | Yes | Price band grade of the catalog element.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| element_id | ItemId | Yes | Catalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$ |
| description | string | Yes | Line description.Constraints: length 1 to 300 |
| quantity | number | Yes | Quantity; defaults to 1. |
| unit_basis | UnitCode | Yes | Unit basis from the controlled unit list in `xpms.dim_unit_alias`.Constraints: pattern ^[a-z][a-z0-9_-]*$ |
| unit_price_minor | integer (int64) | null | Yes | Unit price. Integer minor units of the resource currency; null means unpriced, never zero. |
| line_total_minor | integer (int64) | null | Yes | Line total, generated from quantity and unit price. Integer minor units of the resource currency; null means unpriced, never zero. |
| line_number | integer | Yes | Line number within the budget.Constraints: range 1 to any |
| phase_code | PhaseCode | null | Yes | |
| tier_code | TierCode | null | Yes | |
| actual_minor | integer (int64) | null | Yes | Approved and paid expenses posted to the line (app.budget_line_facts); null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero. |
| account_code | GlAccountCode | null | Yes |
{
"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",
"budget_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"urid": "4000.01",
"xyz": "X",
"xyz_basis": "Rented inventory",
"line_type": "Contingency",
"grade_code": "base",
"element_id": "4000.01.01-XPMS-001",
"description": "Stage deck rental",
"quantity": 24,
"unit_basis": "each",
"unit_price_minor": 4500,
"line_total_minor": 108000,
"line_number": 1,
"phase_code": "SCP",
"tier_code": "04",
"actual_minor": 480000,
"account_code": "5400"
}Code samples
curl -X GET "$XOS_BASE_URL/budget-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.budgetLines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.budget_lines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos budget-lines get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f