---
title: "Gets the list of all invoices (the metadata only, not the files)."
method: GET
path: "/finance/v0-nsfw/invoices"
tags: ["Invoice"]
---

# Gets the list of all invoices (the metadata only, not the files).

`GET /finance/v0-nsfw/invoices`

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

Gets the list of all invoices (the metadata only, not the files).<br>You must have this scope: 'invoices.read'.<br>For fine-grained clients, you must have this permission: 'core.invoices.read'.

## Query parameters

- `number` string
- `status` 'FullyPaid' | 'Unpaid' | 'WrittenOff'
- `checkedOutOnAccountsReceivable` boolean
- `outstandingPaymentFilter` string[]
- `dateFilter` string[]
- `propertyIds` string[]
- `reservationIds` string[]
- `bookingIds` string[]
- `folioIds` string[]
- `nameSearch` string
- `paymentSettled` boolean
- `companyIds` string[]
- `recipientType` 'Person' | 'Company'
- `pageNumber` integer
- `pageSize` integer
- `expand` string[]

## Response `200`

Success.

- InvoiceListModel
  - `invoices` InvoiceItemModel[], required: List of invoices.
    - `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
    - `languageCode` string, required: Language which was used to create the invoice
    - `folioId` string, required: The folio for this invoice
    - `reservationId` string, nullable: The reservation for this invoice
    - `bookingId` string, nullable: The booking for this invoice
    - `propertyId` string, required: The ID of the property
    - `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
    - `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
    - `subTotal` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
    - `outstandingPayment` MonetaryValueModel
      - `amount` number, double, required
      - `currency` string, required
    - `paymentSettled` boolean, required: True, if this invoice had no outstanding payments or was settled.
    - `status` 'FullyPaid' | 'Unpaid' | 'WrittenOff', required: 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>
    - `guestName` string, nullable: Name of the guest
    - `guestCompany` string, nullable: Company the guest specified
    - `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.
    - `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
  - `count` integer, required: Total count of items

## Other responses

- `204`: No invoices found.
- `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)