---
title: "GET /finance/v0-nsfw/invoices/{id}"
method: GET
path: "/finance/v0-nsfw/invoices/{id}"
tags: ["Invoice"]
---

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

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

## 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`

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

## Path parameters

- `id` string, required

## Query parameters

- `expand` string[]

## Response `200`

OK

- UnstableInvoiceModel
  - `id` string, required: Invoice identifier
  - `number` string, required: Invoice number
  - `type` 'Initial' | 'Cancellation' | 'Correction' | 'Advance' | 'AdvanceCancellation' | 'AdvanceCorrection' | 'Proforma' | 'Deposit' | 'DepositCancellation' | 'DepositCorrection', required: Invoice type
  - `series` string, nullable: Invoice number series
  - `to` UnstableInvoiceRecipientModel, required
    - `name` string, nullable
    - `phone` 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
    - `companyAdditionalTaxId` string, nullable
    - `companyAdditionalTaxId2` string, nullable
    - `companyInvoiceNetworkIdentity` InvoiceNetworkIdentityModel
      - `network` 'Peppol', required: The Network through which to send the Invoice e. g. Peppol
      - `id` string, required: The Id of the company at the network. e.g. "0208:123456789"
    - `companyType` 'CorporateClient' | 'TravelAgency' | 'GovernmentBuyer', nullable
    - `companyIdentifiers` CompanyIdentifierModel[], nullable
      - `scheme` string, required: The identifier scheme (must exist in the company identifier-scheme registry).
      - `value` string, required: The identifier value for the scheme.
    - `reference` string, nullable
    - `personalTaxId` string, nullable
  - `paymentSettled` boolean, 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
  - `created` string, 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>
  - `relatedInvoiceNumber` string, 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
  - `relatedInvoiceId` string, 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
  - `writeOffReason` string, 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
  - `allowedActions` string[], 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.
  - `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` UnstableInvoiceLineItemsModel, required
    - `lineItems` UnstableInvoiceLineItemModel[], nullable
      - `id` string, required: The id of the line item
      - `serviceType` 'Other' | 'Accommodation' | 'FoodAndBeverages' | 'CancellationFees' | 'NoShow' | 'CityTax' | 'SecondCityTax' | 'LocalTax' | 'ConsumptionTax', nullable: The type of the service
      - `productType` 'Service' | 'Goods', nullable: The product type of this line item. Some jurisdictions require specifying the type of offering the line item represents.
      - `serviceId` string, nullable: The ID of the service which might be: - The service used as a reference when creating a charge which is lately used to create the invoice line item. - The additional service to which the charge is applied. - The included service for which the charge is added.
      - `productId` string, nullable: The code which is used to identify service within fiscalization provider. Calculated property
      - `date` string, date, required: The date on which this item or service is delivered
      - `createdInFolio` string, date-time, nullable: The time when the corresponding charge was added to the folio<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>
      - `dateRange` DateRangeModel, required
        - `start` string, date, required: Specifies the start date of a date range.
        - `end` string, date, required: Specifies the end date of a date range.
      - `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` UnstableIncludedLineItemModel[], nullable: Items which are included in the package, if there are any
        - `id` string, required: The id of the included line item
        - `description` string, nullable: The description of the item or service
        - `createdInFolio` string, date-time, nullable: The time when the corresponding charge was added to the folio<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>
        - `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
        - `serviceType` 'Other' | 'Accommodation' | 'FoodAndBeverages' | 'CancellationFees' | 'NoShow' | 'CityTax' | 'SecondCityTax' | 'LocalTax' | 'ConsumptionTax', nullable: The type of the service
        - `serviceId` string, nullable: The ID of the service which might be: - The service used as a reference when creating a charge which is lately used to create the invoice line item. - The additional service to which the charge is applied. - The included service for which the charge is added.
        - `productId` string, nullable: The code which is used to identify service within fiscalization provider. Calculated property
      - `groupedLineItems` InvoiceGroupedLineItemModel[], nullable: A list of line items that are grouped together when the line item was created from multiple items.
        - `id` string, required: The id of the line item
        - `date` string, date, required: The date on which this line item is delivered
        - `dateRange` DateRangeModel, required
          - `start` string, date, required: Specifies the start date of a date range.
          - `end` string, date, required: Specifies the end date of a date range.
        - `description` string, required: The description of the line item
        - `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.
        - `sourceLineItemId` string, nullable: The id of the source line item (for allowances and split charges)
        - `grossPrice` MonetaryValueModel, required
          - `amount` number, double, required
          - `currency` string, required
        - `vatDetails` VatInfoModel, required
          - `type` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', required: The VAT type
          - `percent` number, double, required: The currently valid percent to calculate the VAT
        - `serviceType` 'Other' | 'Accommodation' | 'FoodAndBeverages' | 'CancellationFees' | 'NoShow' | 'CityTax' | 'SecondCityTax' | 'LocalTax' | 'ConsumptionTax', nullable: The type of the service
        - `serviceId` string, nullable: The ID of the service which might be: - The service used as a reference when creating a charge which is lately used to create the invoice line item. - The additional service to which the charge is applied. - The included service for which the charge is added.
        - `quantity` integer: The count of services provided
      - `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.
      - `sourceLineItemId` string, nullable: The id of the source line item (for allowances and split charges)
      - `quantity` integer, nullable: The count of services provided
      - `type` 'Charge' | 'Allowance' | 'TransitoryCharge' | 'DepositDeduction': The type of the invoice line item.
      - `depositEntryId` string, nullable: The deposit entry this deduction line refers to. Set only for deposit deductions.
      - `sourceDepositInvoiceId` string, nullable: The deposit invoice that originally taxed this amount. Set only for deposit deductions.
    - `lineItemGrouping` 'NoGrouping' | 'ByCharge' | 'ByRatePlanDetailed' | 'ByRatePlanSimplified' | 'ByReceipt': Grouping type used to group the line items in the invoice
    - `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` UnstableStayInfoModel
    - `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
    - `guestsNumber` integer, nullable: Number of Guests
  - `bookingInfo` BookingInfoModel
    - `bookingId` string, required: ID of the booking this invoice is for, if any.
    - `bookingName` string, nullable: Name of the booking.
    - `bookerName` string, required: Full name of the booker
    - `reservationsNumber` integer, required: Number of reservations
    - `firstArrivalDate` string, date, nullable: The first reservation arrival date
    - `lastDepartureDate` string, date, nullable: The last reservation departure date
  - `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
  - `taxRemittanceDetails` TaxRemittanceDetailsModel
    - `channelName` string, nullable: The channel name i.e. Booking.com, Expedia, etc.
    - `tax` MonetaryValueModel
      - `amount` number, double, required
      - `currency` string, required

## 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-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/revisions/72cbd31f02f4?raw)