---
title: "Get the folio"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/operations/getFolio"
---

> Full API specification: https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78.md

# Get the folio

`GET` `/reservations/{confirmationNumber}/folio`

Operation ID: `getFolio`

An itemised statement of nightly room charges, discounts, add-ons, taxes, partner prepayments and the balance due at the property.

## Path parameters

- `confirmationNumber` (string, required)

## Responses

- `200` - Folio.
- `404` - Not found, or owned by another partner.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Kong Hotels Partner API
  version: 1.0.0
servers:
  - url: https://api.konghotels.cloud
    description: Kong Gateway
paths:
  /reservations/{confirmationNumber}/folio:
    get:
      tags:
        - Reservations
      operationId: getFolio
      summary: Get the folio
      description: An itemised statement of nightly room charges, discounts, add-ons,
        taxes, partner prepayments and the balance due at the property.
      parameters:
        - $ref: "#/components/parameters/ConfirmationNumber"
      responses:
        "200":
          description: Folio.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: "#/components/schemas/Folio"
        "404":
          $ref: "#/components/responses/NotFound"
security:
  - KongKeyAuth: []
  - KongConsumer: []
components:
  parameters:
    ConfirmationNumber:
      name: confirmationNumber
      in: path
      required: true
      schema:
        type: string
        examples:
          - KH4DEMO01
  schemas:
    Folio:
      type: object
      properties:
        confirmation_number:
          type: string
        status:
          $ref: "#/components/schemas/ReservationStatus"
        currency:
          type: string
        payment_model:
          $ref: "#/components/schemas/PaymentModel"
        lines:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
                format: date
              type:
                type: string
                enum:
                  - room
                  - discount
                  - add_on
                  - tax
                  - cancellation_fee
              description:
                type: string
              amount:
                $ref: "#/components/schemas/Money"
        total_charges:
          $ref: "#/components/schemas/Money"
        payments:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              description:
                type: string
              amount:
                $ref: "#/components/schemas/Money"
        balance_due_at_property:
          $ref: "#/components/schemas/Money"
    ReservationStatus:
      type: string
      enum:
        - confirmed
        - checked_in
        - checked_out
        - cancelled
        - no_show
    PaymentModel:
      type: string
      description: >
        `pay_at_hotel`: the guest pays the property; `partner_collect`: you
        collected payment and settle

        with Kong Hotels under your contract (shown as a prepayment on the
        folio).
      enum:
        - pay_at_hotel
        - partner_collect
    Money:
      type: string
      pattern: ^-?\d+\.\d{2}$
      description: Decimal amount in the property currency.
      examples:
        - "389.00"
    Problem:
      type: object
      description: RFC 9457 problem details. Extra members (e.g. `available_units`,
        `restrictions`, `reasons`) may be present.
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        request_id:
          type: string
      additionalProperties: true
  responses:
    NotFound:
      description: Not found, or owned by another partner.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/Problem"
          example:
            type: https://developers.konghotels.example/problems/not-found
            title: Resource not found
            status: 404
            detail: Property not found.
            instance: /properties/KXXXX
            request_id: 9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d
  securitySchemes:
    KongKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your API key, validated by Kong Gateway. The header name depends on
        the gateway's key-auth configuration.
    KongConsumer:
      type: apiKey
      in: header
      name: X-Consumer-ID
      description: "**Local development only.** Simulates the consumer identity Kong
        Gateway injects after authentication."
```