Details zu einer gebuchten Leistung

GET/customers/{customerNumber}/benefits/{benefit}/

API version

v1

Request method

GET

Operation ID

getBenefitDetails

---

Liefert Details zu einer gebuchten Leistung.

Request

• customerNumberinteger

  required

  Kundennummer

• benefitstring

  required

  Leistung

Responses

Format

application/json

Description

Die Leistung

Schema documentation

• benefitobject
  • identifierstring
  • uidinteger
• exceedanceinteger
• uidinteger
• usageinteger
• valueinteger

Example

{
  "benefit": {
    "identifier": "string",
    "uid": 123
  },
  "exceedance": 123,
  "uid": 123,
  "usage": 123,
  "value": 123
}

JSON Schema

{
  "title": "Benefit",
  "type": "object",
  "properties": {
    "benefit": {
      "type": "object",
      "properties": {
        "identifier": {
          "type": "string"
        },
        "uid": {
          "type": "integer"
        }
      }
    },
    "exceedance": {
      "type": "integer"
    },
    "uid": {
      "type": "integer"
    },
    "usage": {
      "type": "integer"
    },
    "value": {
      "type": "integer"
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/customers/123/benefits/string