---
title: "Folio"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/schemas/Folio"
---

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

# Folio

## 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
components:
  schemas:
    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"
    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"
```