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

# List invoices

> Returns a paginated list of invoices for the authenticated merchant.



## OpenAPI

````yaml /openapi.yaml get /invoices
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:
  /invoices:
    get:
      tags:
        - Invoices
      summary: List invoices
      description: Returns a paginated list of invoices for the authenticated merchant.
      operationId: listInvoices
      parameters:
        - in: query
          name: reference
          description: Filter by invoice reference.
          schema:
            type: string
          example: INV-2026-0001
        - in: query
          name: customerDocumentNumber
          description: Filter by customer document number.
          schema:
            type: string
          example: '900123456'
        - in: query
          name: contract
          description: Filter by contract identifier.
          schema:
            type: string
          example: CTR-8842
        - in: query
          name: paymentDate
          description: Filter by exact payment date.
          schema:
            type: string
            format: date
          example: '2026-03-11'
        - in: query
          name: settlementDate
          description: Filter by settlement date.
          schema:
            type: string
            format: date
          example: '2026-03-12'
        - in: query
          name: settlementCycle
          description: Filter by settlement cycle.
          schema:
            type: string
          example: '1'
        - in: query
          name: limit
          description: Number of results per page. Min 1, max 100.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          example: 20
        - in: query
          name: cursor
          description: Opaque cursor from a previous response to fetch the next page.
          schema:
            type: string
          example: eyJwayI6InJlbnRhbHMj...
      responses:
        '200':
          description: Paginated invoices list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInvoicesResponse'
              examples:
                page:
                  value:
                    items:
                      - id: 01HQY8EW1H9YGH5PAV5Y2M9R3T
                        reference: INV-2026-0001
                        status: paid
                        amount: 1850000
                        description: Canon de arrendamiento marzo 2026
                        contract: CTR-8842
                        customerDocumentNumber: '900123456'
                        createdAt: '2026-03-11T16:32:14.007Z'
                        paymentDate: '2026-03-11T18:01:03.219Z'
                        paymentMethod: pse
                        paymentSource: link
                        paymentAmount: 1850000
                        settlementDate: '2026-03-12'
                        settlementTime: '1'
                        paymentId: payin_8JkM2P
                        paymentUrl: >-
                          https://pagos.palomma.com/pay/merchant_123/01HQY8EW1H9YGH5PAV5Y2M9R3T
                    cursor: eyJwayI6InJlbnRhbHMj...
                    count: 1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ListInvoicesResponse:
      type: object
      required:
        - items
        - count
      properties:
        items:
          type: array
          description: Invoices in the current page.
          items:
            $ref: '#/components/schemas/Invoice'
        cursor:
          type: string
          nullable: true
          description: Cursor for the next page. `null` when there are no more pages.
        count:
          type: integer
          description: Number of invoices returned in this page.
    Invoice:
      type: object
      required:
        - id
        - status
        - amount
        - description
        - contract
        - customerDocumentNumber
        - createdAt
        - paymentUrl
      properties:
        id:
          type: string
          description: Unique invoice identifier.
        reference:
          type: string
          description: Merchant-provided invoice reference.
        status:
          type: string
          description: >-
            Invoice status: `ready` (payment link active), `paid`, `cancelled`,
            or `chargeback`.
          enum:
            - ready
            - paid
            - cancelled
            - chargeback
        amount:
          type: number
          description: Invoice amount in COP.
        description:
          type: string
          description: Invoice description.
        contract:
          type: string
          description: Contract identifier.
        expirationDate:
          type: string
          description: >-
            Payment link expiration datetime (ISO 8601). Invoices expire 5
            minutes after creation, so redirect the customer immediately. Once a
            transaction is in progress, it no longer expires until the
            transaction completes.
        customerDocumentNumber:
          type: string
          description: Customer's document number.
        customerName:
          type: string
          description: Customer's display name.
        createdAt:
          type: string
          description: Invoice creation datetime (ISO 8601).
        paymentDate:
          type: string
          format: date-time
          description: When the invoice was paid. Present on paid and chargeback invoices.
        paymentMethod:
          type: string
          enum:
            - pse
            - nequiButton
            - bancolombiaButton
            - breb
            - card
          description: Payment method used. Present on paid and chargeback invoices.
        paymentSource:
          type: string
          enum:
            - whatsapp
            - portal
            - link
          description: >-
            Channel through which payment was made. Present on paid and
            chargeback invoices.
        paymentAmount:
          type: number
          description: >-
            Amount actually paid in COP. Present on paid and chargeback
            invoices.
        settlementDate:
          type: string
          description: >-
            Expected settlement date (`YYYY-MM-DD`). Present on paid and
            chargeback invoices.
        settlementTime:
          type: string
          description: Expected settlement cycle. Present on paid and chargeback invoices.
        paymentId:
          type: string
          description: Payment identifier. Present on paid and chargeback invoices.
        paymentUrl:
          type: string
          format: uri
          description: Palomma hosted payment page URL for this invoice.
    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
    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>`.'

````