Rechnung eines Kunden

GET/invoices/{invoiceNumber}/

API version

v1

Request method

GET

Operation ID

getInvoice

---

Diese Ressource repräsentiert eine einzelne Rechnung.

Über den Accept-Header kann gesteuert werden, ob die Daten dieser Rechnung als JSON-Dokument oder das tatsächliche Rechnungsdokument als PDF abgerufen werden sollen.

Request

• invoiceNumberinteger

  required

  Rechnungsnummer

Responses

Format

application/json

Beschreibung

Die Rechnung

Schema-Dokumentation

• invoiceNumbernumber

  required

  Die Rechnungsnummer

• invoicedAtstring (datetime)

  required

  Das Datum der Rechnungsstellung

• netTotalobject

  required
  • currency"EUR"

    required

    Die Währung des Betrags

• grossTotalobject

  required
  • currency"EUR"

    required

    Die Währung des Betrags

• itemsarray of object

  required
  • Array[
  • *object
    • titlestring

      required
    • textstring

      required
    • netTotalobject

      required
      • currency"EUR"

        required

        Die Währung des Betrags

    • quantityobject

      required
      • amountinteger

        required

        Anzahl

      • unitstring

        Einheit

  ]

Beispiel

{
  "invoiceNumber": 123,
  "invoicedAt": "string",
  "netTotal": {
    "currency": "EUR"
  },
  "grossTotal": {
    "currency": "EUR"
  },
  "items": [
    {
      "title": "string",
      "text": "string",
      "netTotal": {
        "currency": "EUR"
      },
      "quantity": {
        "amount": 123,
        "unit": "string"
      }
    }
  ]
}

JSON Schema

{
  "title": "Invoice",
  "required": [
    "grossTotal",
    "invoiceNumber",
    "invoicedAt",
    "items",
    "netTotal"
  ],
  "type": "object",
  "properties": {
    "invoiceNumber": {
      "type": "number",
      "description": "Die Rechnungsnummer"
    },
    "invoicedAt": {
      "type": "string",
      "description": "Das Datum der Rechnungsstellung",
      "format": "datetime"
    },
    "netTotal": {
      "title": "InvoiceAmount",
      "required": [
        "currency"
      ],
      "type": "object",
      "properties": {
        "currency": {
          "type": "string",
          "description": "Die Währung des Betrags",
          "enum": [
            "EUR"
          ]
        }
      }
    },
    "grossTotal": {
      "title": "InvoiceAmount",
      "required": [
        "currency"
      ],
      "type": "object",
      "properties": {
        "currency": {
          "type": "string",
          "description": "Die Währung des Betrags",
          "enum": [
            "EUR"
          ]
        }
      }
    },
    "items": {
      "type": "array",
      "items": {
        "title": "InvoiceItem",
        "required": [
          "netTotal",
          "quantity",
          "text",
          "title"
        ],
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "netTotal": {
            "title": "InvoiceAmount",
            "required": [
              "currency"
            ],
            "type": "object",
            "properties": {
              "currency": {
                "type": "string",
                "description": "Die Währung des Betrags",
                "enum": [
                  "EUR"
                ]
              }
            }
          },
          "quantity": {
            "required": [
              "amount"
            ],
            "type": "object",
            "properties": {
              "amount": {
                "type": "integer",
                "description": "Anzahl"
              },
              "unit": {
                "type": "string",
                "description": "Einheit"
              }
            }
          }
        }
      }
    }
  }
}

Usage examples

cURL

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