---
title: "List expected payments"
method: GET
path: "/expected_payments"
tags: ["Expected Payments"]
---

# List expected payments

`GET /expected_payments`

List and filter expected payments.

## Query parameters

- `limit` integer
- `starting_after` string, uuid
- `sort_order` 'asc' | 'desc'
- `start_date` string, date
- `end_date` string, date
- `start_expected_date` string, date
- `end_expected_date` string, date
- `direction` 'credit' | 'debit'
- `amount_from` integer
- `amount_to` integer
- `currency` string
- `canceled` boolean
- `connected_account_id` string, uuid
- `counterparty_account_number` string
- `external_account_number` string
- `counterparty_holder_name` string
- `external_account_holder_name` string
- `description` string
- `virtual_account_number` string
- `internal_account_number` string
- `reconciliation_status` 'unreconciled' | 'partially_reconciled' | 'reconciled' | 'excluded'
- `counterparty_id` string, uuid
- `external_account_holder_id` string, uuid
- `counterparty_account_id` string, uuid
- `external_account_id` string, uuid
- `idempotency_key` string

## Response `200`

200

- object
  - `records` ExpectedPaymentDetails[], required
    - `id` string, uuid, required
    - `idempotency_key` string — An idempotency key is a unique value sent by the client, which the server uses to recognize subsequent retries of the same request.
    - `object` 'expected_payment', required
    - `direction` 'credit' | 'debit', required
    - `amount_from` integer, required
    - `amount_to` integer, required
    - `currency` string, required
    - `start_date` string, date
    - `end_date` string, date
    - `connected_account_id` string, uuid
    - `counterparty_account_id` string, uuid — The UUID of the counterparty account.
    - `counterparty_account` ExpectedPaymentCounterpartyAccount, required — The account of the counterparty, which is either the debtor or the creditor depending on the payment's direction. It must be left empty if `counterparty_account_id` parameter is filled.
      - `account_number` string — The account number of the counterparty.
      - `holder_name` string — The name of the counterparty.
    - `virtual_account_id` string, uuid — The UUID of the virtual account.
    - `virtual_account` CommonVirtualAccount, required
      - `virtual_account_number` string, required — The virtual account number.
      - `name` string — The name of the virtual account.
    - `external_account_id` string, uuid — The UUID of the external account.
    - `external_account` ExpectedPaymentExternalAccount — The external account, which is either the debtor or the creditor depending on the payment's direction. It must be left empty if `external_account_id` parameter is filled.
      - `account_number` string — The number of the external account.
      - `holder_name` string — The name of the external account holder.
    - `internal_account_id` string, uuid — The UUID of the internal virtual account that the payment is expected to credit or debit.
    - `internal_account` ExpectedPaymentInternalAccount — The internal account, type 'virtual', that the payment is expected to credit or debit. It must be left empty if `internal_account_id` parameter is filled.
      - `account_number` string — The number of the internal account.
      - `name` string — The name of the internal account.
      - `type` string — The type of the internal account.
    - `reconciliation_status` 'unreconciled' | 'partially_reconciled' | 'reconciled' | 'excluded', required
    - `reconciled_amount` integer, required
    - `metadata` object, required — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata).
    - `custom_fields` CommonCustomFields, required — Custom fields in JSON `key:value` format. See [Custom fields](https://docs.numeral.io/reference/custom-fields).
    - `descriptions` string[], required — Descriptions of the expected payment
    - `virtual_account_number` string
    - `created_at` string, date-time, required
    - `canceled_at` string, date-time, nullable, required

## Other responses

- `400` — 400

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/versions/220f101cc2ef/schema)