Skip to content
campaiDeveloper
campai.com

Finance · Accounting · Budgets

POST/{organizationId}/{mandateId}/finance/accounting/budgets/monthsReads only

Get monthly budget amounts

Returns planned and booked amounts per month for an organization, a mandate or all mandates, and a requested range. Only months covered by a budget are returned, with bookings counted for the mandate that owns the budget. The response also counts the mandates with a budget in the range.

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 needs mandate.read.
  • The caller needs budget.read.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • rangeobjectrequired
    2 properties
    • fromobjectrequired
      2 properties
      • yearintegerrequired

        2000–3000

      • monthIndexintegerrequired

        1–12

    • toobjectrequired
      2 properties
      • yearintegerrequired

        2000–3000

      • monthIndexintegerrequired

        1–12

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/months' \
  --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

Content-Type: application/json

  • mandateCountinteger

    at least 0

  • monthsobject[]
    6 properties
    • yearinteger
    • monthIndexinteger

      1–12

    • revenueinteger
    • expenseinteger
    • plannedRevenueinteger
    • plannedExpenseinteger
Response200
{
  "mandateCount": 0,
  "months": [
    {
      "year": 1,
      "monthIndex": 1,
      "revenue": 1,
      "expense": 1,
      "plannedRevenue": 1,
      "plannedExpense": 1
    }
  ]
}

Errors

Other errors

StatusErrorWhen
404Accounting plan is missing. Please make sure you have setup your finances app properly.If the accounting plan is missing, the endpoint returns HTTP 404 with key finance.accounting.getAccountingPlan.notFound.
404Finances settings are missingIf finances settings are missing, the endpoint returns HTTP 404 with key finance.settings.getFinancesSettings.notFound.

Errors nearly every request can meet are listed under Errors.