Project budget-vs-actual report
curl --request GET \
--url https://ledgitify.com/api/v1/projects/{id}/report \
--header 'Authorization: Bearer <token>'import requests
url = "https://ledgitify.com/api/v1/projects/{id}/report"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://ledgitify.com/api/v1/projects/{id}/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ledgitify.com/api/v1/projects/{id}/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ledgitify.com/api/v1/projects/{id}/report"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ledgitify.com/api/v1/projects/{id}/report")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledgitify.com/api/v1/projects/{id}/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"granularity": "monthly",
"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
}
}
}Projects
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 --request GET \
--url https://ledgitify.com/api/v1/projects/{id}/report \
--header 'Authorization: Bearer <token>'import requests
url = "https://ledgitify.com/api/v1/projects/{id}/report"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://ledgitify.com/api/v1/projects/{id}/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ledgitify.com/api/v1/projects/{id}/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ledgitify.com/api/v1/projects/{id}/report"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ledgitify.com/api/v1/projects/{id}/report")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledgitify.com/api/v1/projects/{id}/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"granularity": "monthly",
"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
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
The project id.
Query Parameters
Reporting period granularity. Defaults to monthly.
Available options:
monthly, quarterly