Templates · Receipt
Get standard receipt templates
Gets the standard templates assigned to invoice, reminder, and other receipt contexts for an organization. Supply the organizationId in the path. The endpoint returns the organization's receipt template defaults.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Organization access with both
template.readandreceipt.readis required.
Request
Path parameters
-
organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/receipt/defaults' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/receipt/defaults", {
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/templates/receipt/defaults', 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;
A request the admin app sent for “Create a receipt”.
Response
200 Successful response
Content-Type: application/json
object of id
Response200
{
"key": "000000000000000000000001"
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | No fixed message | If no finance settings are found for the organization, the endpoint returns HTTP 404 (NOT_FOUND). |
Errors nearly every request can meet are listed under Errors.