---
title: "Get list of received payments"
method: GET
path: "/v3/receivable-payments"
tags: ["receivable-payments"]
---

# Get list of received payments

`GET /v3/receivable-payments`

Get a list of received payment objects. By default, you get 20 results on one page of results. Set `max` in your request to get up to 100 results on one page.

See [Search operations with lists](https://developer.bill.com/docs/search-op-with-lists) in the Guides section for filtering, sorting, and pagination examples.

## Query parameters

- `max` integer, nullable — Maximum number of results
- `sort` string, nullable — Field name and sort order. Both simple and compound sorting is available. The format is `sort={field_01}:{sort_order},{field_02}:{sort_order}`. **NOTE**: Sorting occurs in the specified order.
- `filters` string, nullable — Field name, operator, and value. Both simple and compound filtering is available. The format is `filters={field_01}:{op}:{value},{field_02}:{op}:{value}`.
- `page` string, nullable — Next page of results. When a list has multiple pages, the `nextPage` and `prevPage` values in the response enable you to navigate between the pages of results. Set `page` as the `nextPage` or `prevPage` value for navigation.

## Headers

- `sessionId` string, nullable — API session ID generated with `/v3/login`
- `devKey` string, nullable — Developer key generated with your BILL developer account

## Response `200`

Get list of received payments response

- ListReceivablePaymentResponseDto — Response from a list API request with paging references.
  - `nextPage` string
  - `prevPage` string
  - `results` ReceivablePaymentResponseDto[]
    - `id` string — BILL-generated ID of the received payment. The value begins with `0rp`.
    - `customerId` string — BILL-generated ID of the customer. The value begins with `0cu`.
    - `invoicePayments` InvoicePay[] — List of invoice payments
      - `invoiceId` string — BILL-generated ID of the invoice to be paid. The value begins with `00e`.
      - `amount` number — Payment amount. For a payment in an international currency (not USD), this value is in the local currency.
      - `paymentDate` string, date — Invoice payment date. The value is in the `yyyy-MM-dd` format.
    - `description` string — Invoice payment description. This value is included in the check memo or in the bank descriptor for electronic payments.
    - `paymentDate` string, date — Received payment date. Funds are withdrawn from the customer bank account on this date.
    - `fundingAccount` object — Customer funding account information
      - `id` string
      - `type` string
      - `name` string
      - `accountNumber` string
      - `last4` string
    - `receivablesAccount` object — Received payment funding account information
      - `id` string — BILL-generated ID of the received payment funding account
      - `type` 'BANK_ACCOUNT' | 'CARD_ACCOUNT' — Received payment funding account type
    - `amount` number, required — Received payment amount. For a payment in an international currency (not USD), this value is in the local currency.
    - `unappliedAmount` number — Unapplied received payment amount. This value is available for an overpayment, double payment, or customer payment not currently linked to an invoice.
    - `convenienceFeeAmount` number — Convenience fee charged to the customer
    - `receivablesType` 'CASH' | 'CHECK' | 'CREDIT_CARD' | 'ACH' | 'PAYPAL' | 'OTHER' | 'WALLET' | 'VIRTUAL_CARD' | 'UNDEFINED' — Received payment disbursement type.
    - `status` 'PAID' | 'VOID' | 'SCHEDULED' | 'CANCELED' | 'ESCHEATED' | 'UNDEFINED' — Received payment status.
    - `referenceNumber` string — Received payment reference number
    - `onlinePayment` boolean — Information about how the received payment is recorded. * `true`: The payment is received with BILL * `false`: The payment is received outside BILL, and then recorded in BILL
    - `createdTime` string, date-time — Received payment created date and time
    - `updatedTime` string, date-time — Received payment updated date and time

## Other responses

- `4XX` — List of errors.
- `5XX` — List of errors.

---

[API](https://skmtc.net/bill/apis/bill-v3-api.md) · [All operations](https://skmtc.net/bill/apis/bill-v3-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bill/bill-v3-api/revisions/0483350c434e/schema)