Skip to content
campaiDeveloper
campai.com

Crm · Work hours

POST/{organizationId}/{mandateId}/crm/work-hours/accounts/settle

Settle work hours accounts

Settles up to 50 open accounts of ended periods. Missing approved work is billed with the fee of the rule as membership fee invoice of the payer’s debtor, collected by direct debit or paid by transfer like membership fees; accounts with nothing missing are settled without a receipt. Entries still waiting for review do not count. Fees are booked in the default mandate of the settings, otherwise in the given one. Accounts that cannot be settled are returned with the reason, the others are settled. Users limited to their assigned entries cannot settle accounts.

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
  • workHours.read
  • workHoursSettlement.edit

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • accountIdsid[]required

    at least 1 items

  • bookingMandateIdidrequirednullable
  • sepaDirectDebitCashAccountIdidrequirednullable
  • sepaCreditTransferCashAccountIdidrequirednullable
  • sendReceiptsbooleanrequired
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/crm/work-hours/accounts/settle' \
  --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

  • settledinteger
  • failedobject[]
    2 properties
    • accountIdid
    • messagestring
Response200
{
  "settled": 1,
  "failed": [
    {
      "accountId": "000000000000000000000001",
      "message": "string"
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.