Finance · Accounting · Budgets
Update budget fiscal year
It takes organizationId, a nullable mandateId, budgetId, and fiscalYear. Planned amounts stay on the same months of the fiscal year, and the mutation returns no value.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access.
- The caller must have
mandate.readpermission. - The caller must have
budget.editpermission.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
budgetIdidrequired
Body
Content-Type: application/json
-
fiscalYearintegerrequired2000–3000
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/accounting/budgets/YOUR_BUDGET_ID/fiscalYear' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/accounting/budgets/YOUR_BUDGET_ID/fiscalYear", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/accounting/budgets/YOUR_BUDGET_ID/fiscalYear', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
No response body is specified.
What else happens
- When the checks pass, the budget's
fiscalYearis updated.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | The budget is approved. Reopen it to change it. | If the budget is approved, the endpoint returns 400 BAD_REQUEST with key routes.finance.accounting.budgets.approved. |
| 404 | Budget was not found | If the budget is not found, the endpoint returns 404 NOT_FOUND with key routes.finance.accounting.budgets.notFound. |
| 409 | This mandate already has a budget for this fiscal year | If another budget for the same mandate already exists in the requested fiscal year, the endpoint returns 409 CONFLICT with key routes.finance.accounting.budgets.alreadyExists. |
Errors nearly every request can meet are listed under Errors.