Finance · Cash · Transactions
Preview cash transaction rule
Previews a cash transaction rule for a mandate using the supplied matcher. Returns the number of matching existing transactions and up to five of the most recent. Nothing is saved or changed.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have access to the organization.
- The caller needs the
mandate.readpermission. - The caller needs the
cashTransaction.readpermission.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
matcherobjectrequired5 properties
-
typeMatchstringrequiredrevenueexpense -
amountobject2 properties
-
valueintegerrequired -
comparatorstringrequiredequalslessThanlessEqualgreaterThangreaterEqual
-
-
purposeobject -
counterpartNameobject -
counterpartAccountobject
-
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/finance/cash/transactions/rules/preview' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/cash/transactions/rules/preview", {
method: "POST",
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' => 'POST',
'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/YOUR_MANDATE_ID/finance/cash/transactions/rules/preview', 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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
countnumber -
cashTransactionsobject[]6 properties
-
_idid -
datestring -
amountintegerat most 9999999999
-
purposestringat most 1000 characters
-
infostringat most 200 characters
-
counterpartNamestringat most 200 characters
-
Response200
{
"count": 1,
"cashTransactions": [
{
"_id": "000000000000000000000001",
"date": "string",
"amount": 1,
"purpose": "string",
"info": "string",
"counterpartName": "string"
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.