Skip to main content
GET
/
api
/
public
/
v1
/
budgets
/
{id}
Get budget
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/budgets/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "fiscalYear": 123,
    "periodType": "Annual",
    "status": "Draft",
    "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",
    "lineItems": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "Software",
        "description": "<string>",
        "quantity": 1,
        "unitPrice": 1,
        "recurrence": "One-Time",
        "termMonths": 2,
        "annualisedCost": 123,
        "status": "pending",
        "currency": "<string>",
        "notes": "<string>",
        "category": {
          "id": "<string>",
          "name": "<string>"
        },
        "linkedItem": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "device",
          "name": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Budget ID

Response

Budget details with line items

​
data
object
required