API Docs
Voxbi Cockpit APIs
All endpoints

Pause a recurring transaction

Sets the template status to paused. 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>
id path · string · uuid *
accept header · string
example: application/json

Responses

Response schema
idstring · uuid
Unique recurring transaction template identifier.
example: 550e8400-e29b-41d4-a716-446655440000
pbx_idstring · uuid
PBX tenant the template belongs to.
example: 550e8400-e29b-41d4-a716-446655440001
employee_idstring · uuid
Tempus employee the materialised transactions are booked against.
example: 550e8400-e29b-41d4-a716-446655440002
typestring
Transaction type key.
example: bonus
sub_typestring | null
Optional sub-type key.
example: annual
absence_type_idstring | null · uuid
Linked absence type, when the transaction credits or debits an absence balance.
amountnumber · float
Amount applied on each run. Always greater than zero.
example: 8
tr_typestring
Whether each run credits or debits the balance.
enum: credit debit
example: credit
notestring | null
Free-text note carried onto each materialised transaction.
example: Monthly meal allowance
frequencystring
When the template materialises a transaction.
enum: monthly_start yearly_start
example: monthly_start
run_onceboolean
When true the template runs a single time and then completes.
example:
statusstring
Lifecycle status of the template.
enum: active paused completed failed
example: active
failure_reasonstring | null
Populated when the last run failed.
next_run_atstring | null · date-time
Next scheduled materialisation, in ISO 8601.
example: 2026-07-01T00:00:00+00:00
last_run_atstring | null · date-time
Last materialisation timestamp, in ISO 8601.
last_transaction_idstring | null
Identifier of the most recently materialised Tempus transaction.
created_by_user_idstring | null
User who created the template. Always null when created through the API key flow.
created_atstring | null · date-time
example: 2026-06-01T08:29:07+00:00
updated_atstring | null · date-time
example: 2026-06-01T08:29:07+00:00
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
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<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/{id}/pause
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/recurring-transactions/{id}/pause' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/recurring-transactions/{id}/pause', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
});

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

response = requests.post('https://cockpit.voxbi.com/api/v1/recurring-transactions/{id}/pause',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
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",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/recurring-transactions/{id}/pause', false, $context);
$data = json_decode($response, true);
print_r($data);
No example for this status.
{ … }
"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."
}
{ … }
"message": [ … ]
"Data not found"
]
}
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"
}