Create budget

POST

public

budgets

Create budget

curl --request POST \
  --url https://api.agile-tools.io/v1/public/budgets \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "targetId": "ec62afde-2718-4e54-98d8-aa2578f5d8a6",
  "targetType": "VALUEUNIT",
  "periodStart": "2026-01-01",
  "periodEnd": "2026-12-31",
  "budgetAmount": 250000,
  "currencyUnitId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "description": "Q1 platform budget",
  "externalId": "BUDGET_Q1_2026"
}
'

import requests

url = "https://api.agile-tools.io/v1/public/budgets"

payload = {
    "targetId": "ec62afde-2718-4e54-98d8-aa2578f5d8a6",
    "targetType": "VALUEUNIT",
    "periodStart": "2026-01-01",
    "periodEnd": "2026-12-31",
    "budgetAmount": 250000,
    "currencyUnitId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "description": "Q1 platform budget",
    "externalId": "BUDGET_Q1_2026"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    targetId: 'ec62afde-2718-4e54-98d8-aa2578f5d8a6',
    targetType: 'VALUEUNIT',
    periodStart: '2026-01-01',
    periodEnd: '2026-12-31',
    budgetAmount: 250000,
    currencyUnitId: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
    description: 'Q1 platform budget',
    externalId: 'BUDGET_Q1_2026'
  })
};

fetch('https://api.agile-tools.io/v1/public/budgets', 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://api.agile-tools.io/v1/public/budgets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'targetId' => 'ec62afde-2718-4e54-98d8-aa2578f5d8a6',
    'targetType' => 'VALUEUNIT',
    'periodStart' => '2026-01-01',
    'periodEnd' => '2026-12-31',
    'budgetAmount' => 250000,
    'currencyUnitId' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
    'description' => 'Q1 platform budget',
    'externalId' => 'BUDGET_Q1_2026'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agile-tools.io/v1/public/budgets"

	payload := strings.NewReader("{\n  \"targetId\": \"ec62afde-2718-4e54-98d8-aa2578f5d8a6\",\n  \"targetType\": \"VALUEUNIT\",\n  \"periodStart\": \"2026-01-01\",\n  \"periodEnd\": \"2026-12-31\",\n  \"budgetAmount\": 250000,\n  \"currencyUnitId\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"description\": \"Q1 platform budget\",\n  \"externalId\": \"BUDGET_Q1_2026\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agile-tools.io/v1/public/budgets")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"targetId\": \"ec62afde-2718-4e54-98d8-aa2578f5d8a6\",\n  \"targetType\": \"VALUEUNIT\",\n  \"periodStart\": \"2026-01-01\",\n  \"periodEnd\": \"2026-12-31\",\n  \"budgetAmount\": 250000,\n  \"currencyUnitId\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"description\": \"Q1 platform budget\",\n  \"externalId\": \"BUDGET_Q1_2026\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agile-tools.io/v1/public/budgets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"targetId\": \"ec62afde-2718-4e54-98d8-aa2578f5d8a6\",\n  \"targetType\": \"VALUEUNIT\",\n  \"periodStart\": \"2026-01-01\",\n  \"periodEnd\": \"2026-12-31\",\n  \"budgetAmount\": 250000,\n  \"currencyUnitId\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"description\": \"Q1 platform budget\",\n  \"externalId\": \"BUDGET_Q1_2026\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "6b9a8462-e58f-4697-a725-f55bb86e3b2d",
    "targetId": "ec62afde-2718-4e54-98d8-aa2578f5d8a6",
    "targetType": "VALUEUNIT",
    "periodStart": "2026-01-01",
    "periodEnd": "2026-12-31",
    "budgetAmount": 250000,
    "currencyUnitId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "description": "Q1 platform budget",
    "externalId": "BUDGET_Q1_2026",
    "spentAmount": 0,
    "remainingAmount": 250000,
    "spentPercentage": 0,
    "unvaluedMinutes": 0
  },
  "meta": {
    "requestId": "f056699e-497d-41d9-a877-d7c862de6587",
    "timestamp": "2026-04-03T12:08:00Z"
  }
}

Authorizations

X-API-Key

string

header

required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Body

application/json

Create payload for a budget. Resolve targetId via GET /v1/public/value-units, /v1/public/organizational-units or /v1/public/teams. Resolve currencyUnitId via GET /v1/public/units.

targetId

string

required

Id of the target (value unit, organizational unit or team) the budget applies to.

Maximum string length: 100

Pattern: \S

Example:

"6b9a8462-e58f-4697-a725-f55bb86e3b2d"

targetType

enum<string>

required

Type of the target. One of VALUEUNIT, ORGANIZATIONALUNIT, TEAM.

Available options:

VALUEUNIT,

ORGANIZATIONALUNIT,

TEAM

Example:

"VALUEUNIT"

periodStart

string<date>

required

Budget period start (inclusive).

Example:

"2026-01-01"

periodEnd

string<date>

required

Budget period end (inclusive).

Example:

"2026-12-31"

budgetAmount

number

required

Budget amount in the budget currency.

Required range: x >= 0

Example:

250000

currencyUnitId

string

required

Id of the currency unit. Resolve via GET /v1/public/units.

Maximum string length: 100

Pattern: \S

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

description

string

Optional budget description.

Maximum string length: 500

Example:

"Q1 platform budget"

externalId

string

Optional external system identifier. Must be unique within the organization.

Maximum string length: 255

Example:

"BUDGET_Q1_2026"

Response

Budget created

string

targetId

string

targetType

enum<string>

Available options:

VALUEUNIT,

ORGANIZATIONALUNIT,

TEAM

periodStart

string<date>

Example:

"2022-03-10"

periodEnd

string<date>

Example:

"2022-03-10"

budgetAmount

number

currencyUnitId

string

description

string

externalId

string

spentAmount

number

remainingAmount

number

spentPercentage

number<double>

unvaluedMinutes

integer<int64>

Create budget

curl --request POST \
  --url https://api.agile-tools.io/v1/public/budgets \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "targetId": "ec62afde-2718-4e54-98d8-aa2578f5d8a6",
  "targetType": "VALUEUNIT",
  "periodStart": "2026-01-01",
  "periodEnd": "2026-12-31",
  "budgetAmount": 250000,
  "currencyUnitId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "description": "Q1 platform budget",
  "externalId": "BUDGET_Q1_2026"
}
'

import requests

url = "https://api.agile-tools.io/v1/public/budgets"

payload = {
    "targetId": "ec62afde-2718-4e54-98d8-aa2578f5d8a6",
    "targetType": "VALUEUNIT",
    "periodStart": "2026-01-01",
    "periodEnd": "2026-12-31",
    "budgetAmount": 250000,
    "currencyUnitId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "description": "Q1 platform budget",
    "externalId": "BUDGET_Q1_2026"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    targetId: 'ec62afde-2718-4e54-98d8-aa2578f5d8a6',
    targetType: 'VALUEUNIT',
    periodStart: '2026-01-01',
    periodEnd: '2026-12-31',
    budgetAmount: 250000,
    currencyUnitId: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
    description: 'Q1 platform budget',
    externalId: 'BUDGET_Q1_2026'
  })
};

fetch('https://api.agile-tools.io/v1/public/budgets', 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://api.agile-tools.io/v1/public/budgets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'targetId' => 'ec62afde-2718-4e54-98d8-aa2578f5d8a6',
    'targetType' => 'VALUEUNIT',
    'periodStart' => '2026-01-01',
    'periodEnd' => '2026-12-31',
    'budgetAmount' => 250000,
    'currencyUnitId' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
    'description' => 'Q1 platform budget',
    'externalId' => 'BUDGET_Q1_2026'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agile-tools.io/v1/public/budgets"

	payload := strings.NewReader("{\n  \"targetId\": \"ec62afde-2718-4e54-98d8-aa2578f5d8a6\",\n  \"targetType\": \"VALUEUNIT\",\n  \"periodStart\": \"2026-01-01\",\n  \"periodEnd\": \"2026-12-31\",\n  \"budgetAmount\": 250000,\n  \"currencyUnitId\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"description\": \"Q1 platform budget\",\n  \"externalId\": \"BUDGET_Q1_2026\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agile-tools.io/v1/public/budgets")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"targetId\": \"ec62afde-2718-4e54-98d8-aa2578f5d8a6\",\n  \"targetType\": \"VALUEUNIT\",\n  \"periodStart\": \"2026-01-01\",\n  \"periodEnd\": \"2026-12-31\",\n  \"budgetAmount\": 250000,\n  \"currencyUnitId\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"description\": \"Q1 platform budget\",\n  \"externalId\": \"BUDGET_Q1_2026\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agile-tools.io/v1/public/budgets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"targetId\": \"ec62afde-2718-4e54-98d8-aa2578f5d8a6\",\n  \"targetType\": \"VALUEUNIT\",\n  \"periodStart\": \"2026-01-01\",\n  \"periodEnd\": \"2026-12-31\",\n  \"budgetAmount\": 250000,\n  \"currencyUnitId\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"description\": \"Q1 platform budget\",\n  \"externalId\": \"BUDGET_Q1_2026\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "6b9a8462-e58f-4697-a725-f55bb86e3b2d",
    "targetId": "ec62afde-2718-4e54-98d8-aa2578f5d8a6",
    "targetType": "VALUEUNIT",
    "periodStart": "2026-01-01",
    "periodEnd": "2026-12-31",
    "budgetAmount": 250000,
    "currencyUnitId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "description": "Q1 platform budget",
    "externalId": "BUDGET_Q1_2026",
    "spentAmount": 0,
    "remainingAmount": 250000,
    "spentPercentage": 0,
    "unvaluedMinutes": 0
  },
  "meta": {
    "requestId": "f056699e-497d-41d9-a877-d7c862de6587",
    "timestamp": "2026-04-03T12:08:00Z"
  }
}

API

API Reference

API Guides

CLI

Integration Automation

Support

Authorizations

Body

Response