curl --request GET \
--url https://coreapi.io/api/analytics/finance/recurring/excel \
--header 'Authorization: Bearer <token>'import requests
url = "https://coreapi.io/api/analytics/finance/recurring/excel"
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/finance/recurring/excel', 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/finance/recurring/excel",
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;
}"<string>"{
"status": 409,
"type": "ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED",
"title": "An error occurred",
"detail": "<string>"
}{
"status": 422,
"type": "https://tools.ietf.org/html/rfc2616#section-10",
"violations": [
{
"propertyPath": "to",
"message": "Der Zeitraum darf höchstens 36 Monate umfassen.",
"code": "analytics.mrr_financials.range_too_long"
}
],
"title": "Validation Failed",
"detail": "<string>"
}{
"status": 409,
"type": "ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED",
"title": "An error occurred",
"detail": "<string>"
}Export the recurring revenue page as XLSX
The page with the same query as GET /api/analytics/finance/recurring, one sheet per card with the numbers of the page: “Info” (organisation, range in dates of the organisation, currency, scope, segment, filters not applied, snapshot state, calculation and generation time), “Kennzahlen”, “MRR-Waterfall” (the month), “Ursachen der Bewegungen”, “Bewegungen je Monat”, “Backlog”, “MRR-Tabelle” (the sheet of the MRR financials export), “Nachträge”; then the drill-down lines of the whole range without a row limit: “Rohdaten MRR-Positionen” (every item with MRR at the start or the end of a month, with the movement of its account), “Rohdaten Vertrag zu Rechnung”, “Rohdaten Accounted MRR”, “Rohdaten Hinweise”; last “Definitionen”. Amounts are numbers, names are text cells, dates are dates in the time zone of the organisation. With snapshot=1 the MRR table shows the “Stand zum Abschluss” like the page. File name: recurring_{organisation}_{from}_{to}.xlsx.
Required permission: analytics:read.
curl --request GET \
--url https://coreapi.io/api/analytics/finance/recurring/excel \
--header 'Authorization: Bearer <token>'import requests
url = "https://coreapi.io/api/analytics/finance/recurring/excel"
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/finance/recurring/excel', 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/finance/recurring/excel",
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;
}"<string>"{
"status": 409,
"type": "ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED",
"title": "An error occurred",
"detail": "<string>"
}{
"status": 422,
"type": "https://tools.ietf.org/html/rfc2616#section-10",
"violations": [
{
"propertyPath": "to",
"message": "Der Zeitraum darf höchstens 36 Monate umfassen.",
"code": "analytics.mrr_financials.range_too_long"
}
],
"title": "Validation Failed",
"detail": "<string>"
}{
"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.
Abfrageparameter
First month (YYYY-MM, time zone of the organisation). Default: to minus 11 months.
Last month (YYYY-MM). Default: the current month. At most 36 months.
ISO-4217 code. Default: the default currency.
Movement scope. Default: the organisation setting.
subscription, invoice_address, customer, organisation Analytics segment: only its customers.
Month of the bridge sheet (YYYY-MM, within the range). Default: the last month of the range that has ended.
1: the MRR table as "Stand zum Abschluss" (the snapshotted rows from the month-end snapshots, months without one empty). No effect when the range has no snapshot or a segment is applied.
0, 1 Antwort
XLSX file download.
The response is of type file.
War diese Seite hilfreich?