> ## Documentation Index
> Fetch the complete documentation index at: https://docs.palomma.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtener liquidacion por fecha y ciclo

> Obtiene una liquidacion por fecha y ciclo.



## OpenAPI

````yaml /openapi-es.yaml get /settlements/{date}/{cycle}
openapi: 3.0.3
info:
  title: Palomma Rentals API
  version: 1.0.0
  description: API para crear y gestionar facturas de arriendo y liquidaciones.
  contact:
    name: Palomma
servers:
  - url: https://api.palomma.com/v1
    description: Produccion
  - url: https://sandbox.api.palomma.com/v1
    description: Sandbox
security:
  - bearerAuth: []
tags:
  - name: Facturas
    description: Crear, obtener y listar facturas.
  - name: Liquidaciones
    description: Obtener liquidaciones por fecha y ciclo.
paths:
  /settlements/{date}/{cycle}:
    get:
      tags:
        - Liquidaciones
      summary: Obtener liquidacion por fecha y ciclo
      description: Obtiene una liquidacion por fecha y ciclo.
      operationId: getSettlement
      parameters:
        - in: path
          name: date
          required: true
          description: Fecha de liquidacion en formato `YYYY-MM-DD`.
          schema:
            type: string
            format: date
          example: '2026-03-12'
        - in: path
          name: cycle
          required: true
          description: Identificador del ciclo de liquidacion.
          schema:
            type: string
          example: '1'
      responses:
        '200':
          description: Liquidacion encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settlement'
              examples:
                settlement:
                  value:
                    date: '2026-03-12'
                    cycle: '1'
                    status: paid
                    numberOfInvoices: 24
                    amountCollected: 45200000
                    fees: 610000
                    feesPostpaid: false
                    adjustments: 0
                    gateway: false
                    paymentAmount: 44590000
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    Settlement:
      type: object
      required:
        - date
        - cycle
        - status
        - numberOfInvoices
        - amountCollected
        - fees
        - feesPostpaid
        - adjustments
        - gateway
        - paymentAmount
      properties:
        date:
          type: string
          description: Fecha de liquidacion (`YYYY-MM-DD`).
        cycle:
          type: string
          description: Identificador del ciclo de liquidacion.
        status:
          type: string
          enum:
            - processing
            - paid
            - credited
            - error
          description: >-
            Estado de la liquidacion: `processing` (en proceso), `paid`
            (pagada), `credited` (acreditada) o `error`.
        numberOfInvoices:
          type: number
          description: Cantidad total de facturas incluidas en esta liquidacion.
        amountCollected:
          type: number
          description: Monto bruto recaudado en COP.
        fees:
          type: number
          description: Total de comisiones descontadas en COP.
        feesPostpaid:
          type: boolean
          description: >-
            Si las comisiones se cobran por separado (postpago) para esta
            liquidacion.
        adjustments:
          type: number
          description: Ajustes aplicados al monto de la liquidacion en COP.
        gateway:
          type: boolean
          description: Si esta es una liquidacion de tipo gateway.
        paymentAmount:
          type: number
          description: Monto neto a pagar en COP.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Mensaje de error legible.
  responses:
    BadRequest:
      description: Solicitud invalida
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidBody:
              value:
                error: Invalid JSON in request body
            schemaError:
              value:
                error: Amount must be an integer
    Unauthorized:
      description: Token invalido o ausente
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Invalid or missing token
    NotFound:
      description: Recurso no encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invoiceNotFound:
              value:
                error: Invoice not found
            settlementNotFound:
              value:
                error: Settlement not found
    InternalServerError:
      description: Error interno del servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Internal Server Error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Enviar header: `Authorization: Bearer <apiKey>`.'

````