Read the finance definitions catalogue

curl --request GET \
  --url https://coreapi.io/api/analytics/finance/definitions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://coreapi.io/api/analytics/finance/definitions', 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/definitions",
  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;
}

{
  "version": "v2",
  "validFrom": "2026-09-28",
  "entries": [
    {
      "id": "nrr",
      "title": "NRR 12 Monate",
      "definition": "<string>",
      "formula": "<string>"
    }
  ],
  "changelog": [
    {
      "version": "v2",
      "validFrom": "2026-09-28",
      "changes": [
        {
          "id": "dso_3m",
          "change": "<string>"
        }
      ]
    }
  ]
}

{
  "status": 409,
  "type": "ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED",
  "title": "An error occurred",
  "detail": "<string>"
}

GET

api

analytics

finance

definitions

Read the finance definitions catalogue

curl --request GET \
  --url https://coreapi.io/api/analytics/finance/definitions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://coreapi.io/api/analytics/finance/definitions', 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/definitions",
  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;
}

{
  "version": "v2",
  "validFrom": "2026-09-28",
  "entries": [
    {
      "id": "nrr",
      "title": "NRR 12 Monate",
      "definition": "<string>",
      "formula": "<string>"
    }
  ],
  "changelog": [
    {
      "version": "v2",
      "validFrom": "2026-09-28",
      "changes": [
        {
          "id": "dso_3m",
          "change": "<string>"
        }
      ]
    }
  ]
}

{
  "status": 409,
  "type": "ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED",
  "title": "An error occurred",
  "detail": "<string>"
}

Autorisierungen

Authorization

string

header

erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Antwort

The catalogue.

The definitions catalogue the figures are computed by.

version

string

Catalogue version.

Beispiel:

"v2"

validFrom

string

Date from which the version applies (YYYY-MM-DD).

Beispiel:

"2026-09-28"

entries

object[]

The definitions.

Show child attributes

changelog

object[]

Every version of the catalogue, newest first, with the definitions whose meaning changed.

Show child attributes

Einführung

Grundlagen

Pläne

Angebote

Finanzberichte

Provisionen

Zahlungspläne

Read the finance definitions catalogue

Autorisierungen

Antwort