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

# Lists the payments received from clients, newest first.

> Every payment, whatever recorded it - Gorelo web, `POST /v1/payments`, or a connected
accounting system - the same payments `GET /v1/invoices/{invoiceId}` lists under
`Payments`. Every filter is optional and combining two narrows to the payments that
satisfy both. A well-formed id that matches nothing is an empty page, not a 404.

`Amount` is the whole payment; `Invoices` lists each invoice it was applied to with
that invoice's share. `PaymentDate` is a calendar date in the service provider's time
zone, and `paymentDateSince`/`paymentDateBefore` bound it on that same calendar:
the lower bound includes the day it names and the upper bound excludes it.




## OpenAPI

````yaml /api-reference/openapi.json get /v1/payments
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/payments:
    get:
      tags:
        - Billing
      summary: Lists the payments received from clients, newest first.
      description: "Every payment, whatever recorded it - Gorelo web, `POST /v1/payments`, or a connected\r\naccounting system - the same payments `GET /v1/invoices/{invoiceId}` lists under\r\n`Payments`. Every filter is optional and combining two narrows to the payments that\r\nsatisfy both. A well-formed id that matches nothing is an empty page, not a 404.\r\n\n`Amount` is the whole payment; `Invoices` lists each invoice it was applied to with\r\nthat invoice's share. `PaymentDate` is a calendar date in the service provider's time\r\nzone, and `paymentDateSince`/`paymentDateBefore` bound it on that same calendar:\r\nthe lower bound includes the day it names and the upper bound excludes it.\r\n"
      operationId: get_v1_payments
      parameters:
        - name: Cursor
          in: query
          description: >-
            Opaque pagination cursor from a previous page; omit for the first
            page. Only valid against the same filters and sort that produced it.
          schema:
            type: string
        - name: PageSize
          in: query
          description: >-
            Number of items per page, 1-200 (default 50). Out of range is
            rejected, not clamped.
          schema:
            type: integer
            format: int32
            default: 50
        - name: ClientIds
          in: query
          description: >-
            Comma-separated client ids; keeps only payments received from any of
            them.
          schema:
            type: string
        - name: InvoiceIds
          in: query
          description: >-
            Comma-separated invoice ids; keeps only payments applied to any of
            them.
          schema:
            type: string
        - name: PaymentDateSince
          in: query
          description: Keeps only payments received on or after this date.
          schema:
            type: string
            format: date-time
        - name: PaymentDateBefore
          in: query
          description: Keeps only payments received strictly before this date.
          schema:
            type: string
            format: date-time
        - name: SortOrder
          in: query
          description: >-
            Sort direction on the payment date: asc or desc (default). Any other
            value is a 400.
          schema:
            type: string
            default: desc
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PaymentModelListBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentModelListBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PaymentModelListBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    PaymentModelListBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          type: array
          items:
            $ref: '#/components/schemas/PaymentModel'
          nullable: true
        DataContext:
          $ref: '#/components/schemas/PaginationDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    PaymentModel:
      type: object
      properties:
        Id:
          type: string
          description: "Identifier of the payment, the same id an invoice's `Payments` carry. A payment recorded\r\nthrough `POST /v1/payments` can be removed with `DELETE /v1/payments/{paymentId}`."
          format: uuid
          example: 8c2d4f1a-3b5e-4c7d-9a1f-2e6b8d0c4f13
        Amount:
          type: number
          description: Total amount of the payment, across every invoice it was applied to.
          format: double
          example: 250
        PaymentDate:
          type: string
          description: >-
            Date the payment was received, a calendar date in the service
            provider's time zone.
          format: date
          example: '2026-10-01'
        Reference:
          type: string
          description: >-
            Reference recorded with the payment, such as a bank transaction or
            remittance number.
          example: BANK-20261001-118
        ClientId:
          type: integer
          description: The client the payment was received from.
          format: int64
          example: 4983
        Invoices:
          type: array
          items:
            $ref: '#/components/schemas/PaymentInvoiceModel'
          description: "The invoices the payment was applied to, each with the share of the payment applied to it,\r\noldest application first. Usually one."
      additionalProperties: false
      description: "One payment received from a client, in the shape `GET /v1/payments` and\r\n`GET /v1/payments/{paymentId}` return it."
    PaginationDataContext:
      type: object
      properties:
        Pagination:
          $ref: '#/components/schemas/PaginatedResponse'
      additionalProperties: false
      description: "The `DataContext` of a cursor-paginated success response: carries the paging metadata\r\nfor the returned page."
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
    PaymentInvoiceModel:
      type: object
      properties:
        InvoiceId:
          type: string
          description: The invoice, as `GET /v1/invoices/{invoiceId}` takes it.
          format: uuid
          example: 6f1c2a3b-4d5e-4f60-8a7b-9c0d1e2f3a4b
        Amount:
          type: number
          description: Amount of the payment applied to this invoice.
          format: double
          example: 250
      additionalProperties: false
      description: The share of a payment applied to one invoice.
    PaginatedResponse:
      type: object
      properties:
        NextCursor:
          type: string
          nullable: true
        PreviousCursor:
          type: string
          nullable: true
        HasMore:
          type: boolean
        HasPrevious:
          type: boolean
        TotalCount:
          type: integer
          format: int32
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.