List budgets

Retrieve a paginated list of budgets. Supports filtering by company, fiscal year, status, and period type.

GET /api/public/v1/budgets

List budgets

cURL

curl --request GET \
  --url https://app.msportal.ai/api/public/v1/budgets \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "fiscalYear": 123,
      "currency": "<string>",
      "notes": "<string>",
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "createdBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "totals": {
        "softwareTotal": 123,
        "hardwareTotal": 123,
        "labourTotal": 123,
        "subscriptionTotal": 123,
        "otherTotal": 123,
        "grandTotal": 123
      },
      "lineItemCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

Authorization · string · header · required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page · number · default: 1

Page number

Required range: x >= 1

limit · number · default: 25

Items per page

Required range: 1 <= x <= 100

sortColumn · enum<string> · default: created_at

Field to sort by

Available options: title, fiscal_year, fiscalYear, status, period_type, periodType, created_at, createdAt, updated_at, updatedAt

sortDesc · boolean | null · default: true

Sort descending

search · string

Search in budget title

Maximum string length: 255

companyId · string<uuid>

Filter by company ID

fiscalYear · number

Filter by fiscal year

Required range: 1900 <= x <= 2100

status · enum<string>

Filter by status

Available options: Draft, PendingApproval, Approved, Obsolete

periodType · enum<string>

Filter by period type

Available options: Annual, Quarterly, Monthly

Response

200

application/json

List of budgets

data · object[] · required

Array of budgets

Show child attributes

pagination · object · required

Show child attributes