---
title: "Get payments"
method: GET
path: "/api/v2/payments"
tags: ["Payments"]
---

# Get payments

`GET /api/v2/payments`

List all payments.

## Query parameters

- `sort` string[]
- `filter` union — Filter schema for `payment` list endpoints — pass a single condition or a logical group.
  - 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.
  - FilterPayment — Available filter parameters for querying payments.
    - `paid_after` union — Filter payments made on or after this date (`paid_on`).
      - PaidAfter — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `contains` PaidAfter — unresolved $ref
        - `not_eq` PaidAfter — unresolved $ref
        - `not_contain` PaidAfter — unresolved $ref
        - `eq` PaidAfter — unresolved $ref
    - `amount` union — Filter by payment amount range.
      - Amount — unresolved $ref
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `not_contain` Amount — unresolved $ref
        - `eq` Amount — unresolved $ref
        - `not_eq` Amount — unresolved $ref
        - `contains` Amount — unresolved $ref
    - `written_off_on` union — Filter by write-off date range (`written_off_on`).
      - WrittenOffOn — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `contains` WrittenOffOn — unresolved $ref
        - `not_eq` WrittenOffOn — unresolved $ref
        - `eq` WrittenOffOn — unresolved $ref
        - `not_contain` WrittenOffOn — unresolved $ref
    - `company_id` union — Filter by client company (via the associated invoice).
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `eq` CompanyId — unresolved $ref
        - `contains` CompanyId — unresolved $ref
        - `not_eq` CompanyId — unresolved $ref
        - `not_contain` CompanyId — unresolved $ref
      - CompanyId — unresolved $ref
    - `id` union — Filter by payment ID.
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `not_eq` Id — unresolved $ref
        - `contains` Id — unresolved $ref
        - `not_contain` Id — unresolved $ref
        - `eq` Id — unresolved $ref
      - Id — unresolved $ref
    - `number` union — Filter by the invoice number associated with the payment.
      - object — Filter using explicit operator syntax.
        - `not_contain` Number — unresolved $ref
        - `eq` Number — unresolved $ref
        - `not_eq` Number — unresolved $ref
        - `contains` Number — unresolved $ref
      - Number — unresolved $ref
    - `paid_on` union — Filter by payment date range (`paid_on`).
      - object — Filter using explicit operator syntax.
        - `eq` PaidOn — unresolved $ref
        - `not_eq` PaidOn — unresolved $ref
        - `contains` PaidOn — unresolved $ref
        - `not_contain` PaidOn — unresolved $ref
      - PaidOn — unresolved $ref
    - `invoice_id` union — Filter by the associated invoice.
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `contains` InvoiceId — unresolved $ref
        - `not_contain` InvoiceId — unresolved $ref
        - `eq` InvoiceId — unresolved $ref
        - `not_eq` InvoiceId — unresolved $ref
      - InvoiceId — unresolved $ref
    - `external_id` union — Filter by external payment ID from an integrated system.
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `not_contain` ExternalId — unresolved $ref
        - `eq` ExternalId — unresolved $ref
        - `not_eq` ExternalId — unresolved $ref
        - `contains` ExternalId — unresolved $ref
      - ExternalId — unresolved $ref
    - `paid_before` union — Filter payments made on or before this date (`paid_on`).
      - object — Filter using explicit operator syntax.
        - `not_eq` PaidBefore — unresolved $ref
        - `eq` PaidBefore — unresolved $ref
        - `contains` PaidBefore — unresolved $ref
        - `not_contain` PaidBefore — unresolved $ref
      - PaidBefore — unresolved $ref
    - `project_id` union — Filter by the associated project.
      - object — Filter using explicit operator syntax.
        - `eq` ProjectId — unresolved $ref
        - `contains` ProjectId — unresolved $ref
        - `not_contain` ProjectId — unresolved $ref
        - `not_eq` ProjectId — unresolved $ref
      - ProjectId — unresolved $ref
    - `budget_id` union — Filter by the associated budget or deal.
      - BudgetId — unresolved $ref
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `eq` BudgetId — unresolved $ref
        - `contains` BudgetId — unresolved $ref
        - `not_contain` BudgetId — unresolved $ref
        - `not_eq` BudgetId — unresolved $ref
    - `subsidiary_id` union — Filter by the associated subsidiary (via the invoice).
      - object — Filter using explicit operator syntax.
        - `not_eq` SubsidiaryId — unresolved $ref
        - `contains` SubsidiaryId — unresolved $ref
        - `not_contain` SubsidiaryId — unresolved $ref
        - `eq` SubsidiaryId — unresolved $ref
      - SubsidiaryId — unresolved $ref
    - `query` union — Search payments by invoice number or related text.
      - Query — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `contains` Query — unresolved $ref
        - `eq` Query — unresolved $ref
        - `not_eq` Query — unresolved $ref
        - `not_contain` Query — unresolved $ref

## Headers

- `X-Organization-Id` string, required

## Response `200`

Collection payment

---

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