Get dunning level

Returns the details of a single dunning level.

Required license

This endpoint requires the Dunning add-on.

Request

GET /api/oauth/v2/resource/invoices/dunnings/types/{uuid}

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string (UUID)	Yes	Unique ID of the dunning level

Required scope: dunnings

Response

Success (200 OK)

{
  "data": {
    "id": "0f6b1c4a-8d21-4b7e-9a33-5c81e2f40a17",
    "name": "1. Mahnung",
    "text": "Dear Sir or Madam, we would like to remind you of the following open invoice.",
    "emailSubject": null,
    "emailBody": null,
    "color": "#f5a623",
    "sort": 1,
    "dunningFee": "5.00",
    "latePaymentInterestRate": "4.00",
    "paymentDeadline": 14,
    "tenancies": ["7c2f5b81-40de-4a19-b6c3-8ea1d0742f95"],
    "deleted": false
  }
}

Note: A deleted dunning level still returns 200 — deleted is true then.

Response fields

See List dunning levels for the full field reference — the data object here has the same fields as one entry of data[] there.

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/invoices/dunnings/types/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *string

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Access token invalid or expired
403	insufficient_scope	Scope dunnings not present
404	not_found	Dunning level not found
429	rate_limit_exceeded	Too many requests — see Error Handling

Note: If the Authorization header is missing or the token is invalid, the API answers with 401 and the JSON envelope invalid_client. This holds for the OAuth API in general, not just for this endpoint.