Skip to content
campaiDeveloper
campai.com

Finance · Accounting · Budgets

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

Get budget report

Returns the comparison of planned and booked amounts of the budgets of a fiscal year, per account, per cost center, as one sheet per cost center or for the general meeting, as PDF, HTML, Excel or CSV. Without a mandate it covers all mandates with a summary per mandate.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • budget.read
Also checked, depending on the request and the records it touches
  • user.read
  • apiKey.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read
  • contact.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • fiscalYearintegerrequired

    2000–3000

  • untilobject
    2 properties
    • yearintegerrequired

      2000–3000

    • monthIndexintegerrequired

      1–12

  • layoutstringrequired
    accounts costCenters costCenterSheets meeting
  • costCenternumber

    1–99999999

  • formatstringrequired
    html pdf excel csv
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/report' \
  --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

  • namestring
  • dataobject
    2 properties
    • contentstring
    • zipboolean
  • emptyboolean
Response200
{
  "name": "string",
  "data": {
    "content": "string"
  },
  "empty": true
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.