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

# Summarize successful payments and refunds

> PAID payments minus SUCCEEDED refunds; each uses its own occurrence date and is counted once. No proportional refund allocation to invoices, jobs or business units. One optional grouping plus time; rows order by period_start then group value (null first). Empty groups/buckets are omitted.



## OpenAPI

````yaml /openapi.json get /reports/collections
openapi: 3.0.3
info:
  title: Breezy Public Reporting API
  version: 1.0.0
  description: >-
    Read customers, team members, jobs, visits, assignments, installed
    equipment, captured form responses, time entries, configured-period
    timesheets, business reference catalogs, job leads, estimates, invoices,
    payments, refunds, recorded job financials, saved sold/earned credits, and
    financial summaries for your company. Existing API keys grant company-wide
    read access. Amounts are integer USD cents. Reads return current corrected
    records, with cursor pagination for collecting results.


    Read the [Breezy FSM guides](https://developers.getbreezyapp.com) for
    authentication, pagination, refresh limits, and business measures. All reads
    use latest corrected company records; cursors do not create a snapshot or a
    complete change feed.
servers:
  - url: https://api.getbreezyapp.com/v1
    description: Breezy FSM production API
security:
  - apiKey: []
tags:
  - name: Company
  - name: Invoices
  - name: Payments
  - name: Refunds
  - name: Reports
  - name: TeamMembers
  - name: Accounts
  - name: Contacts
  - name: Locations
  - name: Jobs
  - name: JobAppointments
  - name: JobAssignments
  - name: BusinessUnits
  - name: JobTypes
  - name: JobClasses
  - name: JobLifecycles
  - name: LeadSources
  - name: Tags
  - name: Estimates
  - name: JobLeads
  - name: Equipment
  - name: FormResponses
  - name: TimeEntries
  - name: Timesheets
  - name: JobFinancials
  - name: RevenueAttributions
externalDocs:
  description: Breezy FSM reporting guides and API reference
  url: https://developers.getbreezyapp.com
paths:
  /reports/collections:
    get:
      tags:
        - Reports
      summary: Summarize successful payments and refunds
      description: >-
        PAID payments minus SUCCEEDED refunds; each uses its own occurrence date
        and is counted once. No proportional refund allocation to invoices, jobs
        or business units. One optional grouping plus time; rows order by
        period_start then group value (null first). Empty groups/buckets are
        omitted.
      operationId: getCollections
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: >-
              Maximum parent records or report rows. Complete children are
              always included.
          required: false
          description: >-
            Maximum parent records or report rows. Complete children are always
            included.
          name: limit
          in: query
        - schema:
            type: string
            nullable: true
            minLength: 1
            default: null
            description: >-
              Repeat the original filters; any valid page size may continue.
              Foreign-company, tampered or mismatched cursors return
              INVALID_CURSOR.
          required: false
          description: >-
            Repeat the original filters; any valid page size may continue.
            Foreign-company, tampered or mismatched cursors return
            INVALID_CURSOR.
          name: cursor
          in: query
        - schema:
            type: string
            format: date
            description: Inclusive company-local date.
          required: true
          description: Inclusive company-local date.
          name: start_date
          in: query
        - schema:
            type: string
            format: date
            description: Exclusive company-local date; must be after start_date.
          required: true
          description: Exclusive company-local date; must be after start_date.
          name: end_date
          in: query
        - schema:
            type: string
            enum:
              - day
              - week
              - month
              - quarter
              - year
            default: month
          required: false
          name: bucket
          in: query
        - schema:
            type: string
            nullable: true
            format: uuid
            default: null
          required: false
          name: account_id
          in: query
        - schema:
            type: string
            nullable: true
            enum:
              - CARD
              - ACH
              - CASH
              - CHECK
              - PAYPAL
              - VENMO
              - CASHAPP
              - OTHER
              - WISETACK_LOAN
              - null
          required: false
          name: method
          in: query
        - schema:
            type: string
            nullable: true
            format: uuid
            default: null
          required: false
          name: collected_by_id
          in: query
        - schema:
            type: string
            nullable: true
            enum:
              - account
              - payment_method
              - collector
              - null
          required: false
          name: group_by
          in: query
      responses:
        '200':
          description: Successful read. Clients ignore unrecognized response fields.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionsResponse'
              example:
                data:
                  - period_start: '2026-09-01'
                    period_end: '2026-10-01'
                    group: null
                    currency: USD
                    payment_count: 1
                    refund_count: 1
                    received_cents: 80000
                    refunded_cents: 5000
                    net_collections_cents: 75000
                pagination:
                  next_cursor: null
                meta:
                  request_id: example-request
                  generated_at: '2026-09-08T19:00:00Z'
                  timezone: America/Los_Angeles
                report:
                  start_date: '2026-09-01'
                  end_date: '2026-10-01'
                  bucket: month
                  group_by: null
        '400':
          description: >-
            Malformed input, unknown query parameter, unsupported combination or
            invalid cursor.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: INVALID_REQUEST
                  message: end_date must be later than start_date
                  request_id: example-request
                  details: []
        '401':
          description: Missing, invalid or expired key, or invalid linked identity.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
            WWW-Authenticate:
              schema:
                type: string
              example: Bearer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: UNAUTHENTICATED
                  message: A valid API key is required
                  request_id: example-request
                  details: []
        '404':
          description: >-
            Missing resource or resource outside the authenticated company. Same
            response for both.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: NOT_FOUND
                  message: Resource not found
                  request_id: example-request
                  details: []
        '405':
          description: Write methods do not mutate business data and return 405.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
            Allow:
              schema:
                type: string
              example: GET, HEAD, OPTIONS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: METHOD_NOT_ALLOWED
                  message: This resource supports GET
                  request_id: example-request
                  details: []
        '429':
          description: Company request budget exhausted; retry after the indicated delay.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
            Retry-After:
              schema:
                type: integer
                minimum: 1
              description: Seconds before retrying.
              example: 30
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: RATE_LIMITED
                  message: Request limit exceeded
                  request_id: example-request
                  details: []
        '500':
          description: >-
            Unexpected failure. Share request_id with support; no stack or
            provider secrets in response.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: INTERNAL_ERROR
                  message: Unable to complete request
                  request_id: example-request
                  details: []
      security:
        - apiKey: []
components:
  schemas:
    CollectionsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CollectionsRow'
        pagination:
          $ref: '#/components/schemas/Pagination'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
        report:
          type: object
          properties:
            start_date:
              type: string
              format: date
            end_date:
              type: string
              format: date
            bucket:
              type: string
              enum:
                - day
                - week
                - month
                - quarter
                - year
            group_by:
              type: string
              nullable: true
              enum:
                - account
                - payment_method
                - collector
                - null
          required:
            - start_date
            - end_date
            - bucket
            - group_by
      required:
        - data
        - pagination
        - meta
        - report
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - INVALID_REQUEST
                - INVALID_CURSOR
                - UNAUTHENTICATED
                - NOT_FOUND
                - METHOD_NOT_ALLOWED
                - RATE_LIMITED
                - INTERNAL_ERROR
            message:
              type: string
            request_id:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - field
                  - message
          required:
            - code
            - message
            - request_id
            - details
      required:
        - error
    CollectionsRow:
      type: object
      properties:
        period_start:
          type: string
          format: date
        period_end:
          type: string
          format: date
        group:
          $ref: '#/components/schemas/SummaryGroup'
        currency:
          type: string
          enum:
            - USD
        payment_count:
          type: integer
          minimum: 0
        refund_count:
          type: integer
          minimum: 0
        received_cents:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Integer USD cents; signed where adjustments or balances permit.
        refunded_cents:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Integer USD cents; signed where adjustments or balances permit.
        net_collections_cents:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Integer USD cents; signed where adjustments or balances permit.
      required:
        - period_start
        - period_end
        - group
        - currency
        - payment_count
        - refund_count
        - received_cents
        - refunded_cents
        - net_collections_cents
    Pagination:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: >-
            Opaque continuation. Null ends traversal. Keep the same filters;
            page size may change.
      required:
        - next_cursor
    ResponseMeta:
      type: object
      properties:
        request_id:
          type: string
        generated_at:
          type: string
          format: date-time
        timezone:
          type: string
      required:
        - request_id
        - generated_at
        - timezone
      description: >-
        Generation time and company timezone. generated_at is not a snapshot or
        synchronization token.
    SummaryGroup:
      type: object
      nullable: true
      properties:
        dimension:
          type: string
          enum:
            - account
            - business_unit
            - job_type
            - job_class
            - payment_method
            - collector
        value:
          type: string
          nullable: true
        label:
          type: string
          nullable: true
      required:
        - dimension
        - value
        - label
      description: >-
        Null when ungrouped. For an unknown group the object is present and
        value/label are null.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Existing Breezy API key. Grants all published reads in its associated
        company. No app permission scopes.

````