Crm · Contracts · Statistics
Get collected amounts
Returns the amount in cents collected through contract collections in a period and in the period of the same length right before it, with its monthly split by payment method. The amounts leave out draft, canceled and archived receipts. It also returns the amount per plan from the same receipts, splitting a receipt for several subscriptions evenly between them
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.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/collectedAmounts' \
--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/collectedAmounts", {
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/collectedAmounts', 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
-
totalAmountnumber -
previousTotalAmountnumber -
monthsobject[]7 properties
-
datestring -
totalAmountnumber -
sepaDirectDebitnumber -
onlinenumber -
sepaCreditTransfernumber -
cashnumber -
nonenumber
-
-
plansobject[]2 properties
-
planIdid -
amountnumber
-
Response200
{
"totalAmount": 1,
"previousTotalAmount": 1,
"months": [
{
"date": "string",
"totalAmount": 1,
"sepaDirectDebit": 1,
"online": 1,
"sepaCreditTransfer": 1,
"cash": 1,
"none": 1
}
],
"plans": [
{
"planId": "000000000000000000000001",
"amount": 1
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.