Invoice

GET /finance/v0-nsfw/invoices/preview

<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/preview
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: invoices.read, admin

Query parameters

folioIdstring required

The ID of the folio for which the advance invoice should be created.

chargeIdsstring[]

The filter for charges

paymentIdsstring[]

The filter for payments

lineItemGrouping'NoGrouping' | 'ByCharge' | 'ByRatePlanDetailed' | 'ByRatePlanSimplified' | 'ByReceipt'

The line item grouping type to be applied to the invoice being created.

expandstring[]

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

Response

invoiceDatestring date required

Date the invoice has been created

folioIdstring required

The folio this invoice was requested for

folioType'House' | 'Guest' | 'External' | 'Booking'

The type of 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

createInvoiceAction'CannotCreateInvoice' | 'CreatesInvoice' | 'CreatesInvoiceAndClosesFolio' | 'CreatesArInvoiceAndClosesFolio' required

Describes what will happen, when you try to create an invoice with the folio in the state it is in now.

Example response

{
  "invoiceDate": "2026-10-16",
  "folioId": "SGZLTBJC-1",
  "folioType": "Guest",
  "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": [
      {
        "date": "2026-10-16",
        "description": "Double Room",
        "price": {
          "amount": 130,
          "currency": "EUR"
        },
        "vatType": "Reduced",
        "vatPercent": 7,
        "isNoShowFee": false,
        "type": "Charge"
      },
      {
        "date": "2026-10-16",
        "description": "Service Package",
        "price": {
          "amount": 20,
          "currency": "EUR"
        },
        "vatType": "Normal",
        "vatPercent": 19,
        "isNoShowFee": false,
        "type": "Charge"
      },
      {
        "date": "2026-10-16",
        "description": "Business Lounge Access",
        "price": {
          "amount": 40,
          "currency": "EUR"
        },
        "vatType": "Normal",
        "vatPercent": 19,
        "isNoShowFee": false,
        "type": "Charge"
      }
    ],
    "lineItemGrouping": "NoGrouping",
    "subTotal": {
      "amount": 190,
      "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": 30,
        "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": -30,
    "currency": "EUR"
  },
  "stayInfo": {
    "guestName": "John Doe",
    "arrivalDate": "2026-10-14",
    "departureDate": "2026-10-17",
    "reservationId": "ASTUBXVZ-1",
    "roomNumber": "10001",
    "guestsNumber": 2
  },
  "bookingInfo": {
    "bookingId": "ASTUBXVZ",
    "bookerName": "John Doe",
    "reservationsNumber": 1,
    "firstArrivalDate": "2026-10-14",
    "lastDepartureDate": "2026-10-17"
  },
  "propertyId": "ID",
  "propertyCountryCode": "BY",
  "languageCode": "en",
  "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-11",
    "personalTaxId": "123-321"
  },
  "createInvoiceAction": "CreatesInvoice"
}

Changes

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