> ## 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.

# Get settlement by date and cycle

> Retrieves a single settlement by date and cycle.



## OpenAPI

````yaml /openapi.yaml get /settlements/{date}/{cycle}
openapi: 3.0.3
info:
  title: Palomma Rentals API
  version: 1.0.0
  description: API for creating and managing rental invoices and settlements.
  contact:
    name: Palomma
servers:
  - url: https://api.palomma.com/v1
    description: Production
  - url: https://sandbox.api.palomma.com/v1
    description: Sandbox
security:
  - bearerAuth: []
tags:
  - name: Invoices
    description: Create, retrieve, and list invoices.
  - name: Settlements
    description: Retrieve settlements by date and cycle.
paths:
  /settlements/{date}/{cycle}:
    get:
      tags:
        - Settlements
      summary: Get settlement by date and cycle
      description: Retrieves a single settlement by date and cycle.
      operationId: getSettlement
      parameters:
        - in: path
          name: date
          required: true
          description: Settlement date in `YYYY-MM-DD` format.
          schema:
            type: string
            format: date
          example: '2026-03-12'
        - in: path
          name: cycle
          required: true
          description: Settlement cycle identifier.
          schema:
            type: string
          example: '1'
      responses:
        '200':
          description: Settlement found
          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: Settlement date (`YYYY-MM-DD`).
        cycle:
          type: string
          description: Settlement cycle identifier.
        status:
          type: string
          enum:
            - processing
            - paid
            - credited
            - error
          description: 'Settlement status: `processing`, `paid`, `credited`, or `error`.'
        numberOfInvoices:
          type: number
          description: Total number of invoices included in this settlement.
        amountCollected:
          type: number
          description: Gross amount collected in COP.
        fees:
          type: number
          description: Total fees deducted in COP.
        feesPostpaid:
          type: boolean
          description: Whether fees are billed separately (postpaid) for this settlement.
        adjustments:
          type: number
          description: Any adjustments applied to the settlement amount in COP.
        gateway:
          type: boolean
          description: Whether this is a gateway settlement.
        paymentAmount:
          type: number
          description: Net amount paid out in COP.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
  responses:
    BadRequest:
      description: Invalid request input
      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: Invalid or missing bearer token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Invalid or missing token
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invoiceNotFound:
              value:
                error: Invoice not found
            settlementNotFound:
              value:
                error: Settlement not found
    InternalServerError:
      description: Unexpected server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Internal Server Error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Send header: `Authorization: Bearer <apiKey>`.'

````