---
title: "Get invoices (PMS)"
method: GET
path: "/consumers/{consumer_id}/pms/invoices"
tags: ["Property Management System", "Invoices"]
---

# Get invoices (PMS)

`GET /consumers/{consumer_id}/pms/invoices`

Returns a list of the invoices

## Path parameters

- `consumer_id` string, uuid, required

## Query parameters

- `page` integer
- `size` integer
- `date_from` string, date, required
- `date_to` string, date, required
- `location_id` string, nullable

## Response `200`

Successful Response

- ChiftPagePMSInvoiceFullItem
  - `items` PMSInvoiceFullItem[], required
    - `id` string, required — Technical id in Chift
    - `source_ref` Ref, required
      - `id` string, nullable — Technical id in the target software
      - `model` string, nullable — Name of the model/entity in the target software
    - `invoice_number` string, nullable, required — Number/sequence
    - `creation_date` string, date-time, nullable — Creation date of the invoice
    - `closing_date` string, date-time, nullable — Closing date of the invoice
    - `partners` InvoicePartnerItem[], nullable — List of partners related to the invoice
      - `id` string, required — Technical id in Chift
      - `source_ref` Ref, required
        - `id` string, nullable — Technical id in the target software
        - `model` string, nullable — Name of the model/entity in the target software
      - `type` 'owner' | 'account', required
      - `address` AddressItem
        - `address_type` string, nullable — Type of the address
        - `name` string, nullable — Name given to the address (e.g. 'home')
        - `street` string, nullable — Street name
        - `number` string, nullable — Number of the address
        - `box` string, nullable — Box of the address
        - `city` string, nullable — City name
        - `postal_code` string, nullable — Postal code of the address
        - `country` string, nullable — Country, format: ISO 3166-1 codes.
      - `first_name` string, nullable — First name of the partner. In case the partner is an individual.
      - `last_name` string, nullable — Last name of the partner. In case the partner is an individual.
      - `company_name` string, nullable — Company name of the partner. In case the partner is a company.
    - `items` PMSOrderLineItem[], required — List of items related to the invoice
      - `id` string, required — Unique identifier of the order line item
      - `source_ref` Ref, required
        - `id` string, nullable — Technical id in the target software
        - `model` string, nullable — Name of the model/entity in the target software
      - `type` 'menu' | 'product' | 'service' | 'general_discount'
      - `menu_id` string, nullable — Unique identifier of the menu
      - `quantity` number, required — Quantity of the order line item
      - `unit_price` number, required — Unit price (without tax) of the order line item
      - `total` number, required — Total amount including tax of the order line item
      - `tax_amount` number, required — Total amount of the taxes of the order line item
      - `tax_rate` number, nullable — Tax rate of the order line item
      - `tax_id` string, nullable — Unique identifier of the tax of the order line item
      - `description` string, nullable — Description of the order line item
      - `discounts` DiscountItem[], nullable — List of discounts of the order line item. Discounts of items are always part of the total discount of the order
        - `name` string, nullable — Name of the discount
        - `total` number, required — Total amount of the discount
        - `type` 'OFFERED' | 'UNKNOWN' | 'LOSS'
      - `product_id` string, nullable — Reference to the product related to this item
      - `accounting_category_id` string, nullable — Sometimes used by a POS to give a specific accounting category to an order item
    - `payments` PMSPaymentItem[], required — List of payments related to the invoice
      - `id` string, nullable — Unique identifier of the payment
      - `source_ref` Ref, required
        - `id` string, nullable — Technical id in the target software
        - `model` string, nullable — Name of the model/entity in the target software
      - `payment_method_id` string, nullable — Unique identifier of the payment method used for the payment
      - `payment_method_name` string, nullable — Chift's name of the payment method used for the payment
      - `total` number, required — Total amount of the payment
      - `tip` number, nullable — Total amount of the tips of the payment. Tips are not part of the total of the payment
      - `status` 'Pending' | 'Completed' | 'Canceled' | 'Failed' | 'Unknown' | 'Authorised'
      - `currency` string, nullable — Currency of the payment
      - `date` string, date-time, nullable — Date of the payment
      - `invoice_ref` string, nullable — Reference of the invoice linked to the payment
      - `partner_id` ChiftId
        - `id` string, required — Technical id in Chift
        - `source_ref` Ref, required
          - `id` string, nullable — Technical id in the target software
          - `model` string, nullable — Name of the model/entity in the target software
      - `description` string, nullable — Description of the payment
    - `service_id` string, nullable — Reference to the service related to this order
    - `reservation` ReservationItem
      - `id` string, required — Technical id in Chift
      - `source_ref` Ref, required
        - `id` string, nullable — Technical id in the target software
        - `model` string, nullable — Name of the model/entity in the target software
      - `start_date` string, date-time, nullable — Start date of the reservation
      - `end_date` string, date-time, nullable — End date of the reservation
      - `creation_date` string, date-time, nullable — Creation date of the reservation
      - `resource_id` ChiftId
        - `id` string, required — Technical id in Chift
        - `source_ref` Ref, required
          - `id` string, nullable — Technical id in the target software
          - `model` string, nullable — Name of the model/entity in the target software
      - `resource_name` string, nullable — Name of the resource related to the reservation
      - `resource_identifier` string, nullable — Identifier of the resource related to the reservation
    - `tax_amount` number, required — Taxes amount
    - `untaxed_amount` number, required — Untaxed amount
    - `total` number, required — Total amount incl. taxes
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required

## Other responses

- `400` — Bad Request
- `405` — Method Not Allowed
- `422` — Validation Error
- `502` — Bad Gateway

---

[API](https://skmtc.net/chift/apis/chift-api.md) · [All operations](https://skmtc.net/chift/apis/chift-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chift/chift-api/revisions/b5f1214a482a/schema)