Settings

GET /v1/settings

Organisation settings

settings:read

Request exampleNo request body

curl

curl https://api.rieckflow.com/v1/settings \
  -H "Authorization: Bearer $RIECK_API_KEY"

TypeScript

const svar = await rieck.request("GET", "/v1/settings");

Response

{
  "data": {
    "invoiceNumbering": {
      "mode": "auto",
      "startNumber": 1000,
      "seriesStarted": true
    },
    "tone": "friendly",
    "chartOfAccountsSource": "rieck",
    "paymentDomain": {
      "domain": "pay.acme.example",
      "verified": true
    },
    "paymentMethods": {
      "card": true,
      "mobilepay": true,
      "alternatives": [
        "klarna"
      ]
    }
  }
}

200 Numbering, tone, chart-of-accounts source, payment domain, available payment methods.application/json

Response fields 3

Field	Type	Description
data.invoiceNumbering	object	Number-series mode and lock status.
data.tone	friendly | neutral | firm | custom	Wording used on invoices and reminders.
data.paymentMethods	object	Payment methods available on your invoices.

Possible errors 4

HTTP	Code	Meaning
401	invalid_api_key	The API key is missing, invalid, expired or revoked.
403	api_not_included	The organisation’s plan does not include API access.
403	insufficient_scope	The key does not have the required scope.
429	rate_limited	The organisation’s rate budget is exhausted.

---

GET /v1/usage

Your API health

settings:read

Calls, error rate and latency percentiles for YOUR organisation, per route. Use it to spot a broken integration before your customers do.

Parameter	In	Type	Required	Description
hours	query	string	No	1-720, default 24

Request exampleNo request body

curl

curl https://api.rieckflow.com/v1/usage \
  -H "Authorization: Bearer $RIECK_API_KEY"

TypeScript

const svar = await rieck.request("GET", "/v1/usage");

Response

{
  "data": {
    "windowHours": 24,
    "totals": {
      "calls": 1842,
      "serverErrors": 1,
      "rejected": 12,
      "errorRate": 0.0071
    },
    "routes": [
      {
        "routeId": "api.v1.invoices.list",
        "calls": 622,
        "serverErrors": 0,
        "rejected": 2,
        "errorRate": 0.0032,
        "p50Ms": 42,
        "p95Ms": 118,
        "p99Ms": 201,
        "measuredCalls": 622
      }
    ]
  }
}

200 measuredCalls is how many calls carried a duration — percentiles are computed on those. Calls logged before this feature have none.application/json

Response fields 3

Field	Type	Description
data.windowHours	integer	Lookback period used for the metrics.
data.totals	object	Calls, errors and rejected requests across all routes.
data.routes	object[]	Per-route call counts and latency percentiles.

Possible errors 4

HTTP	Code	Meaning
401	invalid_api_key	The API key is missing, invalid, expired or revoked.
403	api_not_included	The organisation’s plan does not include API access.
403	insufficient_scope	The key does not have the required scope.
429	rate_limited	The organisation’s rate budget is exhausted.