API docs by Redocly

DIGIBIZ Reporting API (1.0.1)

Download OpenAPI specification:

DIGIBIZ support: support@spdigi.biz URL: https://reporting-sandbox.app.spdigi.biz/docs/support License: LicenseRef-Proprietary

Read-only reporting data for Microsoft Fabric and Power BI.

Full snapshots of the reporting resources, one keyset-paged GET per resource. Machine clients authenticate with an Entra access token (client credentials). Code fields are open sets: clients ignore unknown values and read their labels from the codes resource.

Quickstart, guide and error catalogue.

Meta

Health, identity and manifest.

Liveness

The process is up. No authentication.

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Readiness

The registry is loaded and, in the sandbox, the database is reachable and holds data. Also 200 while the API is switched off: read checks.enabled. No authentication.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "checks": {
    }
}

Identity and grants of the client

Client id, environment, granted proceedings with opaque keys and granted column groups.

Authorizations:
entra

Responses

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "environment": "string",
  • "proceedings": [
    ],
  • "column_groups": [
    ],
  • "rate_tier": "string",
  • "meta": {
    }
}

Resources, keys, columns and row counts

Per resource the primary key, the granted columns and an advisory row count valid at as_of.

Authorizations:
entra

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "schema_version": "string",
  • "epoch": "string",
  • "as_of": "2019-08-24T14:15:22Z",
  • "proceedings": [
    ]
}

Dimensions

Proceedings, suppliers, cost types, cost centers, codes.

List proceedings

One row per proceeding (Unternehmen) the client may see. Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

List suppliers

One row per supplier (Kreditor), with its proceeding. The same company in two proceedings is two suppliers. Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

List cost types

One row per cost type (Kostenart), with its proceeding. Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

List cost centers

One row per cost center (Kostenstelle), with its proceeding. Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

List codes

One row per code of a domain, with German label and flags. Global, not per proceeding: a proceeding_id parameter returns 400 invalid-parameter. Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

Facts

Cases, orders, invoices, payments and their links.

List cases

One row per case (Vorgang). Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

List orders

One row per order (Bestellung). Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

List invoices

One row per invoice (Rechnung). Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

List payment plans

One row per payment plan (Zahlplan). Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

List approval steps

One row per approval decision on an order. Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}

List bank statement lines

One row per bank statement line, with the statement date. Keyset-paged: follow next_link until it is absent.

Authorizations:
entra
query Parameters
proceeding_id
Array of strings[ items^p_[a-z2-7]{20}$ ]

Opaque key of a proceeding. May repeat. Omit it to read all granted proceedings.

page_size
integer [ 1 .. 10000 ]
Default: 5000

Rows per page, an integer from 1 to 10000. Any other value returns 400 invalid-parameter.

cursor
string non-empty

Opaque cursor of a previous page. Use next_link instead of building it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next_link": "string",
  • "meta": {
    }
}