Skip to content
campaiDeveloper
campai.com

Finance · Accounting · Budgets

POST/{organizationId}/{mandateId}/finance/accounting/budgets/{budgetId}/lines

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.read and budget.edit.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • budgetIdidrequired

Body

Content-Type: application/json

  • linesobject[]required

    at most 20000 items

    4 properties
    • accountintegerrequired

      1–999999999

    • costCenternumberrequirednullable

      1–99999999

    • amountintegerrequired
    • monthsinteger[]requirednullable

      exactly 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'

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

StatusErrorWhen
400The budget is approved. Reopen it to change it.The budget is approved. Returns 400 with routes.finance.accounting.budgets.approved.
400The monthly amounts of account account do not add up to its planned amountA line's monthly amounts do not add up to its planned amount. Returns 400 with routes.finance.accounting.budgets.invalidMonths.
400Account account is not part of the nameA 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.
400Cost center cost center does not belong to the mandate of the budgetA 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.
400Account account is planned twice for the same cost centerAn account is planned twice for the same cost center. Returns 400 with routes.finance.accounting.budgets.duplicateLine.
400Account 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.
404Budget was not foundThe budget was not found for the organization and mandate. Returns 404 with routes.finance.accounting.budgets.notFound.
404Accounting 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.