Finance · Accounting · Budgets
Update budget lines
Replaces the planned lines of a budget that is not approved. It takes the organization, mandate and budget IDs and the replacement lines. On success, it returns no content.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Callers must have access to the organization.
- Callers need
mandate.readandbudget.edit.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
budgetIdidrequired
Body
Content-Type: application/json
-
linesobject[]requiredat most 20000 items
4 properties
-
accountintegerrequired1–999999999
-
costCenternumberrequirednullable1–99999999
-
amountintegerrequired -
monthsinteger[]requirednullableexactly 12 items · each at most 9999999999
-
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/lines' \
--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/lines", {
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/lines', 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
- Replaces the budget's lines with the submitted lines, sorted by account and cost center.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | The budget is approved. Reopen it to change it. | The budget is approved. Returns 400 with routes.finance.accounting.budgets.approved. |
| 400 | The monthly amounts of account account do not add up to its planned amount | A line's monthly amounts do not add up to its planned amount. Returns 400 with routes.finance.accounting.budgets.invalidMonths. |
| 400 | Account account is not part of the name | A line's account is missing from the accounting plan, or is neither in the income statement nor already planned in the budget. Returns 400 with routes.finance.accounting.budgets.invalidAccount. |
| 400 | Cost center cost center does not belong to the mandate of the budget | A line's non-null cost center is neither a cost center of the budget's mandate nor a recognized region. Returns 400 with routes.finance.accounting.budgets.invalidCostCenter. |
| 400 | Account account is planned twice for the same cost center | An account is planned twice for the same cost center. Returns 400 with routes.finance.accounting.budgets.duplicateLine. |
| 400 | Account account is planned both as a whole and per cost center. Plan it one way only. | A nonzero account is planned both as a whole and per cost center. Returns 400 with routes.finance.accounting.budgets.wholeAndSplit. |
| 404 | Budget was not found | The budget was not found for the organization and mandate. Returns 404 with routes.finance.accounting.budgets.notFound. |
| 404 | Accounting plan is missing. Please make sure you have setup your finances app properly. | The organization's accounting plan is missing. Returns 404 with finance.accounting.getAccountingPlan.notFound. |
Marked words such as account are filled in with the actual value when the error happens.
Errors nearly every request can meet are listed under Errors.