Invoice

GET /finance/v0-nsfw/invoices/{id}

<br>You must have this scope: 'invoices.read'.<br>For fine-grained clients, you must have this permission: 'core.invoices.read'.

Request

Base URL
https://api.apaleo.com (the document declares no server; this is the origin it was published from)
URL
https://api.apaleo.com/finance/v0-nsfw/invoices/{id}
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: invoices.read, admin

Path parameters

idstring required

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: company, groupedLineItems. All other values will be silently ignored.

Response

idstring required

Invoice identifier

numberstring required

Invoice number

Invoice type

seriesstring nullable

Invoice number series

paymentSettledboolean required

True, if this invoice had no outstanding payments or was settled.

status'FullyPaid' | 'Unpaid' | 'WrittenOff' required

Status of the invoice

processingStatus'Pending' | 'Success' | 'Failure' required

Processing status of the invoice

createdstring date-time required

Date of creation<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

relatedInvoiceNumberstring nullable

If the invoice is related to another invoice, this field contains related invoice number For example, if the invoice has Cancellation type, this field contains the number of invoice which is being cancelled

relatedInvoiceIdstring nullable

If the invoice is related to another invoice, this field contains related invoice id For example, if the invoice has Cancellation type, this field contains the number of invoice which is being cancelled

writeOffReasonstring nullable

If the invoice was written-off, this field contains the reason why it was written-off

cancellationReasonCode'ChangeOfRecipientDetails' | 'ChangeOfInvoiceRecipient' | 'ChangeOfPaymentMethod' | 'ChangeOfInvoiceTransactions' | 'Other' nullable

If the invoice is a cancellation invoice, this field contains the code of the cancellation reason

allowedActionsstring[] nullable

Depending on the state of the invoice, certain actions are allowed or not. This list includes all actions you can perform on this invoice.

invoiceDatestring date required

Date the invoice has been created

folioIdstring required

The folio this invoice was requested for

paymentTermsstring nullable

Specification of the payment terms, as defined in the property

propertyIdstring required

The ID of the property

propertyCountryCodestring required

The country code of the property

languageCodestring required

Language which was used to create the invoice

Example response

{
  "id": "INVOICE-SGZLTBJC-1",
  "number": "MUC_20190328000000228",
  "type": "Initial",
  "series": "INV0000200",
  "to": {
    "name": "John D. Doe",
    "phone": "123456789",
    "address": {
      "addressLine1": "Baker Street 7",
      "postalCode": "10005",
      "city": "London",
      "countryCode": "GB"
    },
    "companyName": "Investigators Inc.",
    "companyTaxId": "GB-3358791",
    "companyAdditionalTaxId": "AD-TAX-24256432",
    "companyAdditionalTaxId2": "AD2-TAX-24256432",
    "companyInvoiceNetworkIdentity": {
      "network": "Peppol",
      "id": "0208:123456789"
    },
    "companyType": "GovernmentBuyer",
    "companyIdentifiers": [
      {
        "scheme": "PEPPOL:0204",
        "value": "991-12345-37"
      }
    ],
    "reference": "REF-111",
    "personalTaxId": "123-321"
  },
  "paymentSettled": true,
  "status": "FullyPaid",
  "processingStatus": "Success",
  "created": "0001-01-01T00:00:00Z",
  "writeOffReason": "Weighty reason",
  "allowedActions": [
    "CorrectAddress",
    "CorrectCharges"
  ],
  "invoiceDate": "2026-10-16",
  "folioId": "SGZLTBJC-1",
  "from": {
    "name": "The Bay Hotel",
    "address": {
      "addressLine1": "Ocean Drive 44",
      "postalCode": "55511",
      "city": "Santa Cruz",
      "countryCode": "US"
    }
  },
  "commercialInformation": {
    "registerEntry": "200417510087, California",
    "taxId": "775-43-2106"
  },
  "bankAccount": {
    "iban": "DE44 5001 0517 5407 3249 31",
    "bic": "SSKMDEMMXXX",
    "bank": "Stadtsparkasse München"
  },
  "paymentTerms": "Pay within 7 days",
  "lineItems": {
    "lineItems": [
      {
        "id": "SGZLTBJC-TS-1",
        "serviceType": "Accommodation",
        "date": "2026-10-16",
        "description": "Double Room",
        "price": {
          "amount": 130,
          "currency": "EUR"
        },
        "vatType": "Reduced",
        "vatPercent": 7,
        "isNoShowFee": false,
        "guest": "John Doe",
        "type": "Charge"
      },
      {
        "serviceType": "Other",
        "date": "2026-10-16",
        "description": "Business Lounge Access",
        "price": {
          "amount": 40,
          "currency": "EUR"
        },
        "vatType": "Normal",
        "vatPercent": 19,
        "isNoShowFee": false,
        "guest": "John Doe",
        "type": "Charge"
      },
      {
        "id": "CHARGE-NAME-VAT-GROUP-1",
        "serviceType": "FoodAndBeverages",
        "date": "2026-10-16",
        "description": "Service Package",
        "price": {
          "amount": 40,
          "currency": "EUR"
        },
        "vatType": "Normal",
        "vatPercent": 19,
        "isNoShowFee": false,
        "groupedLineItems": [
          {
            "id": "SGZLTBJC-TS-1-2",
            "date": "2026-10-16",
            "description": "Service Package",
            "guest": "Jane Air",
            "grossPrice": {
              "amount": 20,
              "currency": "EUR"
            },
            "vatDetails": {
              "type": "Normal",
              "percent": 19
            },
            "serviceType": "FoodAndBeverages",
            "quantity": 1
          },
          {
            "id": "SGZLTBJC-TS-1-3",
            "date": "2026-10-17",
            "description": "Service Package",
            "guest": "Jane Air",
            "grossPrice": {
              "amount": 20,
              "currency": "EUR"
            },
            "vatDetails": {
              "type": "Normal",
              "percent": 19
            },
            "serviceType": "FoodAndBeverages",
            "quantity": 1
          }
        ],
        "guest": "Jane Air",
        "quantity": 2,
        "type": "Charge"
      }
    ],
    "lineItemGrouping": "ByCharge",
    "subTotal": {
      "amount": 210,
      "currency": "EUR"
    }
  },
  "payments": [
    {
      "id": "PAY-1",
      "method": "BankTransfer",
      "methodName": "Banküberweisung",
      "amount": {
        "amount": 130,
        "currency": "EUR"
      },
      "paymentDate": "2026-10-16T13:14:35.0609237+02:00",
      "businessDate": "0001-01-01"
    },
    {
      "id": "PAY-2",
      "method": "Cash",
      "methodName": "Bar",
      "amount": {
        "amount": 60,
        "currency": "EUR"
      },
      "paymentDate": "2026-10-16T13:14:35.0609237+02:00",
      "businessDate": "0001-01-01"
    }
  ],
  "taxDetails": [
    {
      "vatType": "Reduced",
      "vatPercent": 7,
      "net": {
        "amount": 120,
        "currency": "EUR"
      },
      "tax": {
        "amount": 10,
        "currency": "EUR"
      }
    },
    {
      "vatType": "Normal",
      "vatPercent": 19,
      "net": {
        "amount": 49,
        "currency": "EUR"
      },
      "tax": {
        "amount": 11,
        "currency": "EUR"
      }
    }
  ],
  "total": {
    "amount": -20,
    "currency": "EUR"
  },
  "stayInfo": {
    "guestName": "John Doe",
    "arrivalDate": "2026-10-14",
    "departureDate": "2026-10-17",
    "reservationId": "ASTUBXVZ-1",
    "guestsNumber": 1
  },
  "bookingInfo": {
    "bookingId": "ASTUBXVZ",
    "bookerName": "John Doe",
    "reservationsNumber": 1,
    "firstArrivalDate": "2026-10-14",
    "lastDepartureDate": "2026-10-17"
  },
  "propertyId": "MUC",
  "propertyCountryCode": "DE",
  "languageCode": "EN",
  "company": {
    "id": "MUC-ACME",
    "code": "ACME",
    "name": "ACME Inc."
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.