# GET /api/v1/budgets/{budget_id}/vs-actual

> Budget vs Actual

- **Tag:** budgets
- **Operation ID:** `get_budget_vs_actual_api_v1_budgets__budget_id__vs_actual_get`

## Description

Compare budgeted amounts to actual performance.

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Parameters

- `budget_id` (path, string, required)
- `start_date` (query, string · date, required) — Comparison period start date
- `end_date` (query, string · date, required) — Comparison period end date

## Responses

### 200 — Successful Response

Schema: `BudgetVsActualResponse`

- `budget_id` (string · required) — Budget UUID.
- `budget_name` (string · required) — Budget name.
- `business_id` (string · required) — Business UUID.
- `business_name` (string · required) — Business name.
- `start_date` (string · date · required) — Report period start.
- `end_date` (string · date · required) — Report period end.
- `generated_at` (string · date-time · required) — When report was generated.
- `revenue` (BudgetVsActualSection · required) → `BudgetVsActualSection` — Revenue section.
  - `section_name` (string · required) — Section name (e.g., 'Revenue', 'Expenses').
  - `items` (array · BudgetVsActualLineItem) → `BudgetVsActualLineItem` — Line items in this section
  - `total_budget` (integer · required) — Total budgeted for section.
  - `total_actual` (integer · required) — Total actual for section.
  - `total_variance` (integer · required) — Total variance for section.
  - `total_variance_percent` (number) — Total variance percentage.
- `expenses` (BudgetVsActualSection · required) → `BudgetVsActualSection` — Expenses section.
  - `section_name` (string · required) — Section name (e.g., 'Revenue', 'Expenses').
  - `items` (array · BudgetVsActualLineItem) → `BudgetVsActualLineItem` — Line items in this section
  - `total_budget` (integer · required) — Total budgeted for section.
  - `total_actual` (integer · required) — Total actual for section.
  - `total_variance` (integer · required) — Total variance for section.
  - `total_variance_percent` (number) — Total variance percentage.
- `budgeted_net_income` (integer · required) — Budgeted net income in cents.
- `actual_net_income` (integer · required) — Actual net income in cents.
- `net_income_variance` (integer · required) — Net income variance in cents.
- `net_income_variance_percent` (number) — Net income variance %.
- `net_income_variance_type` (VarianceTypeEnum · required) → `VarianceTypeEnum` — Favorable or unfavorable.

### 401 — Unauthorized - Authentication required

### 403 — Forbidden - Insufficient permissions

### 404 — Not Found - Resource does not exist

### 422 — Validation Error

Schema: `HTTPValidationError`

- `detail` (array · ValidationError) → `ValidationError`
  - `loc` (array · string | integer · required)
  - `msg` (string · required)
  - `type` (string · required)
  - `input` (object)
  - `ctx` (object)

## Code samples

### cURL

```bash
curl -X GET 'https://api.ondayzero.com/api/v1/budgets/{budget_id}/vs-actual' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/budgets/{budget_id}/vs-actual', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/budgets/{budget_id}/vs-actual", headers=headers)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/budgets/get-budget-vs-actual
- OpenAPI slice: https://www.ondayzero.com/docs/reference/budgets/get-budget-vs-actual/openapi.json
- Other endpoints in **budgets**: https://www.ondayzero.com/docs/reference/budgets