Crm · Contracts · Statistics
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.readplan.readcontract.readcontractCollection.readdepartment.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Query parameters
-
fromDatestringrequired -
toDatestringrequired
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'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/contracts/statistics/departmentAmounts", {
method: "GET",
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' => 'GET',
'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/crm/contracts/statistics/departmentAmounts', 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;
Response
200 Successful response
Content-Type: application/json
-
departmentsobject[]7 properties
-
departmentobjectnullable3 properties
-
departmentIdid -
namestring -
colorstring
-
-
amountintegerat least 0
-
openAmountintegerat least 0
-
membershipFeeAmountintegerat least 0
-
contractAmountintegerat least 0
-
activeCountintegerat least 0
-
plansobject[]10 properties
-
planIdid -
namestring -
typestringmembershipFeecontract -
departmentobjectnullable3 properties
-
departmentIdid -
namestring -
colorstring
-
-
amountintegerat least 0
-
openAmountintegerat least 0
-
activeCountintegerat least 0
-
intervalstringnullablemonthquarterhalfYearyearcustomflexible -
priceintegernullable -
removedboolean
-
-
{
"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.