Read the finance settings
curl --request GET \
--url https://coreapi.io/api/analytics/mrr-financials/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://coreapi.io/api/analytics/mrr-financials/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://coreapi.io/api/analytics/mrr-financials/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/api/analytics/mrr-financials/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"movementScope": "invoice_address",
"mrrRestatementAlertShare": "0.01"
}{
"status": 409,
"type": "ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED",
"title": "An error occurred",
"detail": "<string>"
}Einstellungen
Read the finance settings
The organisation-wide settings of the finance figures: the default movement scope and the share of a month’s MRR above which restatements of a closed month raise one warning.
Required permission: analytics:read.
GET
/
api
/
analytics
/
mrr-financials
/
settings
Read the finance settings
curl --request GET \
--url https://coreapi.io/api/analytics/mrr-financials/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://coreapi.io/api/analytics/mrr-financials/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://coreapi.io/api/analytics/mrr-financials/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/api/analytics/mrr-financials/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"movementScope": "invoice_address",
"mrrRestatementAlertShare": "0.01"
}{
"status": 409,
"type": "ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED",
"title": "An error occurred",
"detail": "<string>"
}Autorisierungen
API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.
Antwort
The settings.
Organisation-wide settings of the finance figures.
Default level on which MRR movements are classified. All levels are always calculated; this only picks the default view.
Verfügbare Optionen:
subscription, invoice_address, customer, organisation Beispiel:
"invoice_address"
Share of a snapshotted month's MRR above which its restatements raise one warning (decimal string, 0.01 = 1 %).
Beispiel:
"0.01"
War diese Seite hilfreich?