Project budget-vs-actual report

Budget-vs-actual for the project, computed through the report engine (derived, cumulative, and in-kind lines handled correctly). Requires the reports:read scope. Each cell carries budgeted, actual, and variance.

GET /projects/{id}/report

Project budget-vs-actual report

cURL

curl --request GET \
  --url https://ledgitify.com/api/v1/projects/{id}/report \
  --header 'Authorization: Bearer <token>'

200

Example

{ "data": { "totalLabel": "<string>", "columns": [ { "label": "<string>", "periodStart": "2023-11-07T05:31:56Z", "periodEnd": "2023-11-07T05:31:56Z" } ], "rows": [ { "budgetLineId": "<string>", "budgetLineName": "<string>", "depth": 123, "isLeaf": true, "cells": [ { "budgeted": 123, "actual": 123, "variance": 123 } ], "total": { "budgeted": 123, "actual": 123, "variance": 123 } } ], "columnTotals": [ { "budgeted": 123, "actual": 123, "variance": 123 } ], "grandTotal": { "budgeted": 123, "actual": 123, "variance": 123 } } }

Authorizations

Authorization · string · header · required

API key as a Bearer token: Authorization: Bearer lk_live_<48 hex>. Create keys in Settings → API keys (Owner or Admin); the full key is shown once. API access is a Professional+ feature. Each key is granted one or more scopes — read (projects:read, reports:read, allocations:read, transactions:read) and the single write scope (transactions:write) — and is limited to 120 requests per minute.

Path Parameters

id · string · required

The project id.

Query Parameters

granularity · enum<string> · default: monthly

Reporting period granularity. Defaults to monthly.

Available options: monthly, quarterly

Response

200

application/json

The budget-vs-actual report.

granularity · enum<string> · required

Available options: monthly, quarterly

data · object · required

Show child attributes