API Docs
Voxbi Cockpit APIs
All endpoints

Preview the next run of a recurring transaction

Computes the next materialisation date for a given frequency without creating a template. Server-to-server only (PBX API key).

HTTP: PbxApiKey

PBX API key, used by the customer's PBX server (e.g. for roaming login/logout)

HTTP Authorization Scheme
bearer
Bearer format
Bearer <pbx_api_key>
accept header · string
example: application/json

Request body · required

Request schema
frequency*string
enum: monthly_start yearly_start
run_onceboolean
fromstring · date
Optional anchor date. Defaults to today.

Responses

Response schema
next_run_atstring · date-time
next_run_at_humanstring
timezonestring
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
The authenticated principal is not allowed to manage recurring transactions.
Response schema
messagestring
Unprocessable Parameters. This error is returned when a parameter is not valid.
Response schema
messagestring
example: The given data was invalid.
errorsobject
filterarray<string>
[]string
sortarray<string>
[]string
pagearray<string>
[]string
per_pagearray<string>
[]string
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
post https://cockpit.voxbi.com/api/v1/recurring-transactions/preview-next-run
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/recurring-transactions/preview-next-run' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"frequency":"monthly_start","from":"2026-06-15"}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/recurring-transactions/preview-next-run', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "frequency": "monthly_start",
    "from": "2026-06-15"
}),
});

const data = await response.json();
console.log(data);
import requests

response = requests.post('https://cockpit.voxbi.com/api/v1/recurring-transactions/preview-next-run',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "frequency": "monthly_start",
    "from": "2026-06-15"
}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'POST',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
        'content' => '{
    \"frequency\": \"monthly_start\",
    \"from\": \"2026-06-15\"
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/recurring-transactions/preview-next-run', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"frequency": "monthly_start",
"from": "2026-06-15"
}
{ … }
"next_run_at": "2026-07-01T00:00:00+00:00",
"next_run_at_human": "July 1, 2026",
"timezone": "Europe/Luxembourg"
}
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "You are not authorised to manage recurring transactions."
}
{ … }
"errors": { … }
"filter": [ … ],
"The filter field must be an array."
],
"sort": [ … ],
"The sort field must be a string."
],
"page": [ … ],
"The page field must be an integer."
],
"per_page": [ … ]
"The per page field must be an integer."
]
}
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "Server Error"
}