Skip to main content

List Invoices of a Customer

GET/customers/{customerId}/invoices/
v2
GET
invoice-list-customer-invoices

Request​

  • customerIdstring
    required

Responses​

Response headers

  • X-Pagination-Limitinteger

    The limit used to select the resources for the response

  • X-Pagination-Skipinteger

    The number of skipped items

  • X-Pagination-Pagenumber

    The calculate page of the list response. Refer to parameters to learn more.

  • X-Pagination-TotalCountinteger

    The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

application/json
  • Array[
    • *object
      • amountPaidnumber
        required
      • cancellationobject
        • cancellationIdstring (uuid)
          required
        • cancelledAtstring (date-time)
          required
        • correctionNumberstring
          required
        • pdfIdstring (uuid)
          required
        • reasonstring
      • cancellationOfstring (uuid)

        The ID of the Invoice that this invoice cancels.

      • currencystring
        required
      • customerIdstring
        required
      • datestring (date-time)
        required
      • groupsarray of object
        required
        • Array[
          • *object
            • contractIdstring (uuid)
            • descriptionstring
            • itemsarray of object
              required
              • Array[
                • *object
                  • additionalDescriptionstring
                  • contractItemIdstring (uuid)
                    required
                  • descriptionstring
                    required
                  • itemCancelledOrCorrectedByarray of object
                    • Array[
                      • *object
                        • sourceInvoiceIdstring (uuid)
                        • sourceInvoiceItemIdstring (uuid)
                      ]
                  • itemIdstring (uuid)
                    required
                  • priceobject
                    required
                    • currency"EUR"
                      required
                    • valueinteger
                      required
                  • referenceobject
                    • sourceInvoiceIdstring (uuid)
                      required
                    • sourceInvoiceItemIdstring (uuid)
                      required
                  • serviceDatestring (date-time)
                  • servicePeriodobject
                    • endstring (date-time)
                      required
                    • startstring (date-time)
                      required
                  • vatRatenumber
                    required
                ]
          ]
      • idstring (uuid)
        required
      • invoiceNumberstring
        required
      • invoiceTypestring (one of: REGULAR, REISSUE, CORRECTION, CANCELLATION)
        required
      • paymentSettingsone of 2 alternatives
        • Alternativeobject
          • accountHolderstring
            required
          • bicstring

            Optional. Required for payments outside of the European Union.

          • ibanstring
            required
          • method"debit"
            required
        • Alternativeobject
          • method"invoice"
            required
      • pdfIdstring (uuid)
        required
      • recipientobject
        required
        • addressobject
          required
          • streetstring
            required
          • houseNumberstring
            required
          • citystring
            required
          • zipstring
            required
          • countryCodestring
            required

            ISO 3166-1 alpha-2 country code

          • addressPrefixstring
        • companystring
        • emailAddressstring (email)
        • firstNamestring
        • lastNamestring
        • phoneNumbersarray of string
          • Array[
            • *string
            ]
        • salutationstring (one of: mr, ms, other)
          required
        • titlestring
        • useFormalTermboolean
      • reissuedBystring (uuid)

        The ID of the Invoice that is a Reissue of this one.

      • statusstring (one of: NEW, CONFIRMED, DENIED, PAID, PARTIALLY_PAID, OVERPAID)
        required
      • totalGrossnumber
        required
      • totalNetnumber
        required
      • vatIdstring
    ]

Usage examples​

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/customers/string/invoices?invoiceTypes=REGULAR&status=CONFIRMED&search=string&limit=50&page=1&sort=invoiceNumber&order=asc