Skip to content
campaiDeveloper
campai.com

Crm · Contracts · Statistics

GET/{organizationId}/{mandateId}/crm/contracts/statistics/departmentAmountsReads only

Get collected amounts by department

Returns what the membership fee and contract plans collected in a period per department, the most first, with the plans without a department last. Each plan counts for the department set on it; a plan on a sub-department counts for the topmost department above it that is not only a category. For each department and each of its plans it gives the amount collected, how much of it is still open and the subscriptions running today, split into membership fees and contracts, and for the plans their interval and fixed price. The amounts come from the receipts of contract collections dated in the period, leaving out draft, canceled and archived receipts, and a receipt for several subscriptions is split evenly between them. Donation plans are left out

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
  • plan.read
  • contract.read
  • contractCollection.read
  • department.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Query parameters

  • fromDatestringrequired
  • toDatestringrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/contracts/statistics/departmentAmounts' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • departmentsobject[]
    7 properties
    • departmentobjectnullable
      3 properties
      • departmentIdid
      • namestring
      • colorstring
    • amountinteger

      at least 0

    • openAmountinteger

      at least 0

    • membershipFeeAmountinteger

      at least 0

    • contractAmountinteger

      at least 0

    • activeCountinteger

      at least 0

    • plansobject[]
      10 properties
      • planIdid
      • namestring
      • typestring
        membershipFee contract
      • departmentobjectnullable
        3 properties
        • departmentIdid
        • namestring
        • colorstring
      • amountinteger

        at least 0

      • openAmountinteger

        at least 0

      • activeCountinteger

        at least 0

      • intervalstringnullable
        month quarter halfYear year custom flexible
      • priceintegernullable
      • removedboolean
Response200
{
  "departments": [
    {
      "department": {
        "departmentId": "000000000000000000000001",
        "name": "string",
        "color": "string"
      },
      "amount": 0,
      "openAmount": 0,
      "membershipFeeAmount": 0,
      "contractAmount": 0,
      "activeCount": 0,
      "plans": [
        {
          "planId": "000000000000000000000001",
          "name": "string",
          "type": "membershipFee",
          "department": {
            "departmentId": "000000000000000000000001",
            "name": "string",
            "color": "string"
          },
          "amount": 0,
          "openAmount": 0,
          "activeCount": 0,
          "interval": "month",
          "price": 1,
          "removed": true
        }
      ]
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.