Skip to content
campaiDeveloper
campai.com

Crm · Contracts · Collections

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

Get collection task counts

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

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
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/contractCollectionTaskCounters' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • draftCollectionsCountinteger

    at least 0

  • draftCollectionsDueDatestring · date-timenullable
  • collectionsPendingSendCountinteger

    at least 0

  • collectionsPendingSendDueDatestring · date-timenullable
  • sepaCollectDueCollectionsCountinteger

    at least 0

  • sepaCollectDueCollectionsDueDatestring · date-timenullable
  • sepaCollectOverdueCollectionsCountinteger

    at least 0

  • sepaCollectOverdueCollectionsDueDatestring · date-timenullable
Response200
{
  "draftCollectionsCount": 0,
  "draftCollectionsDueDate": "2026-06-15T22:30:00Z",
  "collectionsPendingSendCount": 0,
  "collectionsPendingSendDueDate": "2026-06-15T22:30:00Z",
  "sepaCollectDueCollectionsCount": 0,
  "sepaCollectDueCollectionsDueDate": "2026-06-15T22:30:00Z",
  "sepaCollectOverdueCollectionsCount": 0,
  "sepaCollectOverdueCollectionsDueDate": "2026-06-15T22:30:00Z"
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.