List Line Items for a Budget

get/public/v1/budgets/{budget}/items

get/public/v1/budgets/{budget}/items

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/budgets/{budget}/items' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "b1i2t3e4-m5f6-47a8-9b0c-1d2e3f4a5b6c",
      "name": "Support Coordination",
      "description": "Weekly coordination check-in",
      "number": "07_001_0106_8_3",
      "price": 10044,
      "unit_price": 3348,
      "ratio_numerator": 1,
      "ratio_denominator": 3,
      "quantity": 2.5,
      "unit": "H",
      "period": "week",
      "total": 1305720,
      "start": "2026-01-01T00:00:00+00:00",
      "end": "2026-12-31T00:00:00+00:00",
      "charge_item": {
        "id": "c1i2t3m4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
        "name": "Support Coordination",
        "reference": "SUPPORT_COORD_L2",
        "number": "07_002_0106_8_3"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

budgetstringrequired
The budget UUID

Query parameters

sortstring
Sort the results. Prefix with '-' for descending. One of: name, price.
Example:name
page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of BudgetItemResource

dataobject[]required
▶Show 15 child attributesHide child attributes
- idstringrequired
  Example:b1i2t3e4-m5f6-47a8-9b0c-1d2e3f4a5b6c
- namestringrequired
  Example:Support Coordination
- descriptionstring | nullrequired
  Example:Weekly coordination check-in
- numberstring | nullrequired
  Example:07_001_0106_8_3
- priceintegerrequired
  Example:10044
- unit_priceintegerrequired
  Example:3348
- ratio_numeratorinteger | nullrequired
  Example:1
- ratio_denominatorinteger | nullrequired
  Example:3
- quantitynumberrequired
  Example:2.5
- unitstringrequired
  Example:H
- periodstringrequired
  Example:week
- totalintegerrequired
  Example:1305720
- startstringrequired
  Example:2026-01-01T00:00:00+00:00
- endstringrequired
  Example:2026-12-31T00:00:00+00:00
- charge_itemobject | nullrequired
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:c1i2t3m4-e5f6-47a8-9b0c-1d2e3f4a5b6c
  namestringrequired
  Example:Support Coordination
  referencestringrequired
  Example:SUPPORT_COORD_L2
  numberstringrequired
  Example:07_002_0106_8_3
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Query parameters

Response

Errors