---
title: "Gets an invoice preview for one specific folio."
method: GET
path: "/finance/v1/invoices/preview"
tags: ["Invoice"]
---

# Gets an invoice preview for one specific folio.

`GET /finance/v1/invoices/preview`

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

To see if the invoice creation would be successful, check the warnings.<br>You must have this scope: 'invoices.read'.<br>For fine-grained clients, you must have this permission: 'core.invoices.read'.

## Query parameters

- `folioId` string, required
- `expand` string[]

## Response `200`

Success.

- PreviewInvoiceModel
  - `to` InvoiceRecipientModel
    - `name` string, nullable
    - `address` NonStrictAddressModel
      - `addressLine1` string, nullable
      - `addressLine2` string, nullable
      - `postalCode` string, nullable
      - `city` string, nullable
      - `regionCode` string, nullable
      - `countryCode` string, nullable
    - `companyName` string, nullable
    - `companyTaxId` string, nullable
    - `reference` string, nullable
    - `personalTaxId` string, nullable
  - `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.
  - `createInvoiceWarning` CreateInvoiceWarningModel: A warning about what would fail if you would try to create an invoice with the current folio.
    - `type` 'InvoiceAlreadyExists' | 'NotAllChargesPosted' | 'DebitorDetailsMissing' | 'InvoiceHasPendingPayments' | 'NoCompanyFound' | 'CompanyCannotCheckOutOnAr' | 'IsHouseFolio' | 'CannotCreateCompanyInvoiceForExternal' | 'CheckOutOnArIsNotAllowed' | 'IsEmptyFolio' | 'CashPaymentLimitExceeded' | 'FolioState', required: The general classification of the warning, why an invoice would not be created if you would try to create it for the current folio.
    - `message` string, nullable: Optionally, additional information about the warning
  - `invoiceDate` string, date, required: Date the invoice has been created
  - `folioId` string, required: The folio this invoice was requested for
  - `from` InvoiceSenderModel, required
    - `name` string, required
    - `address` AddressModel
      - `addressLine1` string, required
      - `addressLine2` string, nullable
      - `postalCode` string, required
      - `city` string, required
      - `regionCode` string, nullable
      - `countryCode` string, required
  - `commercialInformation` CommercialInfoModel, required
    - `registerEntry` string, required
    - `taxId` string, required
    - `managingDirectors` string, nullable
  - `bankAccount` BankAccountModel
    - `iban` string, nullable
    - `bic` string, nullable
    - `bank` string, nullable
  - `paymentTerms` string, nullable: Specification of the payment terms, as defined in the property
  - `lineItems` InvoiceLineItemsModel, required
    - `lineItems` InvoiceLineItemModel[], nullable
      - `date` string, date, required: The date on which this item or service is delivered
      - `description` string, required: The description of the item or service
      - `price` MonetaryValueModel, required
        - `amount` number, double, required
        - `currency` string, required
      - `vatType` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', nullable: The applied VAT type.
      - `vatPercent` number, double, nullable: The applied VAT percent
      - `isNoShowFee` boolean, required: Whether this line item represents a no-show fee
      - `includedLineItems` IncludedLineItemModel[], nullable: Items which are included in the package, if there are any
        - `description` string, nullable: The description of the item or service
        - `price` MonetaryValueModel, required
          - `amount` number, double, required
          - `currency` string, required
        - `vatType` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', nullable: The applied VAT type.
        - `vatPercent` number, double, nullable: The applied VAT percent
      - `guest` string, nullable: Guest who the service has been provided to. Is defined only when the invoice has charges from multiple folios with different guests.
      - `quantity` integer, nullable: The count of services provided
    - `subTotal` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
  - `payments` InvoicePaymentModel[], nullable: A list of all payments
    - `id` string, required: Id of the payment. This is unique within one folio.
    - `method` 'Cash' | 'BankTransfer' | 'CreditCard' | 'Invoice' | 'Amex' | 'VisaCredit' | 'VisaDebit' | 'MasterCard' | 'MasterCardDebit' | 'Maestro' | 'GiroCard' | 'DiscoverCard' | 'Diners' | 'Jcb' | 'BookingCom' | 'VPay' | 'PayPal' | 'Postcard' | 'Reka' | 'Twint' | 'Lunchcheck' | 'Voucher' | 'ChinaUnionPay' | 'Other' | 'Cheque' | 'Airbnb' | 'HolidayCheck' | 'PspCash' | 'PspDebit' | 'PspBanking' | 'PspOpenInvoice' | 'PspWallet' | 'Representation' | 'IDeal', required: The Payment Method type.
    - `methodName` string, required: The Payment Method name translated in the requested language of the invoice
    - `amount` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
    - `paymentDate` string, date-time: The date when the payment was done<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>
    - `businessDate` string, date: The business date of the payment, can be different from the payment date for some payments posted after midnight and before 6AM.
  - `outstandingPayment` MonetaryValueModel
    - `amount` number, double, required
    - `currency` string, required
  - `taxDetails` TaxDetailModel[], nullable: The subtotal, displaying net and tax amount for each VAT type
    - `vatType` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', required
    - `vatPercent` number, double, required
    - `net` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
    - `tax` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
  - `total` MonetaryValueModel, required
    - `amount` number, double, required
    - `currency` string, required
  - `stayInfo` StayInfoModel
    - `guestName` string, required: Name of the primary guest
    - `arrivalDate` string, date, required: The arrival date
    - `departureDate` string, date, required: The departure date
    - `reservationId` string, required: ID of the reservation this invoice is for, if any.
    - `roomNumber` string, nullable: The last room number
  - `propertyId` string, required: The ID of the property
  - `propertyCountryCode` string, required: The country code of the property
  - `languageCode` string, required: Language which was used to create the invoice
  - `company` EmbeddedCompanyModel
    - `id` string, required: The company ID
    - `code` string, nullable: The code of the company
    - `name` string, nullable: The name of the company
    - `canCheckOutOnAr` boolean, nullable: Whether or not the company can check out on AR

## Other responses

- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-finance-api.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api/revisions/6f1d524c1ea7?raw)