Zahlungseingänge einer Rechnung

GET/invoices/{invoiceNumber}/paymentreceipts/

API version

v1

Request method

GET

Operation ID

getPaymentReceipts

---

Liest erfasste Buchungen zu einer bestimmten Rechnung aus

Request

• invoiceNumberinteger

  required

  Rechnungsnummer

Responses

Format

application/json

Description

Eine Liste von Buchungen

Schema documentation

• Array[
  • *object
    • recordedAtstring (datetime)

      required

      Datum, an dem der Zahlungseingang erfasst wurde

    • amountobject

      required
      • currency"EUR"

        required

        Die Währung des Betrags

    • kindobject

      required
      • descriptionstring

        required

        Die Art der Buchung

  ]

Example

Content-Type: application/json

[
  {
    "recordedAt": "string",
    "amount": {
      "currency": "EUR"
    },
    "kind": {
      "description": "string"
    }
  }
]

JSON Schema

{
  "type": "array",
  "items": {
    "title": "PaymentReceipt",
    "required": [
      "amount",
      "kind",
      "recordedAt"
    ],
    "type": "object",
    "properties": {
      "recordedAt": {
        "type": "string",
        "description": "Datum, an dem der Zahlungseingang erfasst wurde",
        "format": "datetime"
      },
      "amount": {
        "title": "InvoiceAmount",
        "required": [
          "currency"
        ],
        "type": "object",
        "properties": {
          "currency": {
            "type": "string",
            "description": "Die Währung des Betrags",
            "enum": [
              "EUR"
            ]
          }
        }
      },
      "kind": {
        "required": [
          "description"
        ],
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "Die Art der Buchung"
          }
        }
      }
    }
  }
}

Usage examples

cURL

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