---
title: "Get payment reports"
method: GET
path: "/api/v2/reports/payment_reports"
tags: ["Reports"]
---

# Get payment reports

`GET /api/v2/reports/payment_reports`

Retrieve aggregated payment report data grouped by configurable dimensions.

## Query parameters

- `sort` string[]
- `group` 'company' | 'date' | 'invoice' | 'month' | 'organization' | 'payment' | 'quarter' | 'subsidiary' | 'week' | 'year'
- `filter` union — Filter schema for `payment_report` list endpoints — pass a single condition or a logical group.
  - FilterPaymentReport — Available filter parameters for querying aggregated payment report data.
    - `external_id` union — Filter payment report results by external id.
      - ExternalId — unresolved $ref
      - object — Filter operator object for external id.
        - `not_contain` ExternalId — unresolved $ref
        - `contains` ExternalId — unresolved $ref
        - `eq` ExternalId — unresolved $ref
        - `not_eq` ExternalId — unresolved $ref
    - `amount` union — Filter by payment amount range.
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `not_contain` Amount — unresolved $ref
        - `not_eq` Amount — unresolved $ref
        - `contains` Amount — unresolved $ref
        - `eq` Amount — unresolved $ref
      - Amount — unresolved $ref
    - `subsidiary_id` union — Filter payment report results by subsidiary id.
      - object — Filter operator object for subsidiary id.
        - `not_eq` SubsidiaryId — unresolved $ref
        - `eq` SubsidiaryId — unresolved $ref
        - `contains` SubsidiaryId — unresolved $ref
        - `not_contain` SubsidiaryId — unresolved $ref
      - SubsidiaryId — unresolved $ref
    - `invoice_id` union — Filter payment report results by invoice id.
      - object — Filter operator object for invoice id.
        - `not_eq` InvoiceId — unresolved $ref
        - `eq` InvoiceId — unresolved $ref
        - `contains` InvoiceId — unresolved $ref
        - `not_contain` InvoiceId — unresolved $ref
      - InvoiceId — unresolved $ref
    - `paid_after` union — Filter payment report results by paid after.
      - object — Filter operator object for paid after.
        - `not_eq` PaidAfter — unresolved $ref
        - `contains` PaidAfter — unresolved $ref
        - `not_contain` PaidAfter — unresolved $ref
        - `eq` PaidAfter — unresolved $ref
      - PaidAfter — unresolved $ref
    - `id` union — Filter payment report results by id.
      - Id — unresolved $ref
      - object — Filter operator object for id.
        - `eq` Id — unresolved $ref
        - `not_contain` Id — unresolved $ref
        - `contains` Id — unresolved $ref
        - `not_eq` Id — unresolved $ref
    - `query` union — Filter payment report results by query.
      - object — Filter operator object for query.
        - `not_eq` Query — unresolved $ref
        - `not_contain` Query — unresolved $ref
        - `eq` Query — unresolved $ref
        - `contains` Query — unresolved $ref
      - Query — unresolved $ref
    - `paid_on` union — Filter payment report results by paid on.
      - object — Filter operator object for paid on.
        - `not_eq` PaidOn — unresolved $ref
        - `not_contain` PaidOn — unresolved $ref
        - `contains` PaidOn — unresolved $ref
        - `eq` PaidOn — unresolved $ref
      - PaidOn — unresolved $ref
    - `formulas` union — Filter payment report results by formulas.
      - object — Filter operator object for formulas.
        - `not_eq` Formulas — unresolved $ref
        - `not_contain` Formulas — unresolved $ref
        - `eq` Formulas — unresolved $ref
        - `contains` Formulas — unresolved $ref
      - Formulas — unresolved $ref
    - `number` union — Filter payment report results by number.
      - Number — unresolved $ref
      - object — Filter operator object for number.
        - `not_contain` Number — unresolved $ref
        - `not_eq` Number — unresolved $ref
        - `eq` Number — unresolved $ref
        - `contains` Number — unresolved $ref
    - `company_id` union — Filter payment report results by company id.
      - CompanyId — unresolved $ref
      - object — Filter operator object for company id.
        - `eq` CompanyId — unresolved $ref
        - `contains` CompanyId — unresolved $ref
        - `not_contain` CompanyId — unresolved $ref
        - `not_eq` CompanyId — unresolved $ref
    - `written_off_on` union — Filter payment report results by written off on.
      - object — Filter operator object for written off on.
        - `not_contain` WrittenOffOn — unresolved $ref
        - `not_eq` WrittenOffOn — unresolved $ref
        - `eq` WrittenOffOn — unresolved $ref
        - `contains` WrittenOffOn — unresolved $ref
      - WrittenOffOn — unresolved $ref
    - `project_id` union — Filter payment report results by project id.
      - object — Filter operator object for project id.
        - `not_eq` ProjectId — unresolved $ref
        - `eq` ProjectId — unresolved $ref
        - `contains` ProjectId — unresolved $ref
        - `not_contain` ProjectId — unresolved $ref
      - ProjectId — unresolved $ref
    - `budget_id` union — Filter by the associated budget (deal) ID.
      - BudgetId — unresolved $ref
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `not_eq` BudgetId — unresolved $ref
        - `contains` BudgetId — unresolved $ref
        - `eq` BudgetId — unresolved $ref
        - `not_contain` BudgetId — unresolved $ref
    - `paid_before` union — Filter payment report results by paid before.
      - PaidBefore — unresolved $ref
      - object — Filter operator object for paid before.
        - `eq` PaidBefore — unresolved $ref
        - `not_contain` PaidBefore — unresolved $ref
        - `not_eq` PaidBefore — unresolved $ref
        - `contains` PaidBefore — unresolved $ref
  - object — A logical filter group — combine multiple conditions with the `$op` operator.
    - `$op` 'or' | 'and', required — Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match.

## Headers

- `X-Organization-Id` string, required

## Response `200`

Collection payment report

---

[API](https://skmtc.dev/productive/apis/api-documentation.md) · [All operations](https://skmtc.dev/productive/apis/api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/productive/api-documentation/revisions/bbf5057edf0d/schema)