--- updatedAt: 2026-05-27T16:52:24.000Z agentTools: projectIndex: https://developer.bill.com/llms.txt --- # Get list of received 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. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "BILL v3 API", "description": "BILL is a cloud-based financial operations platform for an organization's accounts payable (AP), accounts receivable (AR), and spend & expense (S&E) automation.\n\nThe BILL v3 API gives you access to the same infrastructure that powers the AP, AR, and S&E products. In addition, you can receive real-time event notifications with webhooks.\n\nThe BILL Developer Documentation is available at [developer.bill.com](https://developer.bill.com/docs/home).\n\n## Quickstart\nSign-up and generate a developer key for working with the BILL v3 API. With this key, you can build with the AP, AR, BILL network, and webhook workflows. See [Sandbox API sign up](https://developer.bill.com/docs/api-sandbox-sign-up) for more information.\n\n### Spend & Expense API\nAn API token is required for working with the Spend & Expense API. See [Authentication with Spend & Expense API token](https://developer.bill.com/docs/authentication-with-api-token) for more information.\n\n### BILL v3 API in Postman\nWith this collection, you have access to the BILL v3 API in Postman. When you save your sandbox API credentials as environment variables in Postman, you can simply refer to the variables when you are testing with the BILL v3 API. See [BILL v3 API in Postman](https://developer.bill.com/docs/bill-v3-api-in-postman) for more information.", "version": "1" }, "servers": [ { "url": "https://gateway.stage.bill.com/connect", "description": "sandbox" } ], "paths": { "/v3/receivable-payments": { "get": { "tags": [ "receivable-payments" ], "summary": "Get list of received payments", "description": "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.\n\nSee [Search operations with lists](https://developer.bill.com/docs/search-op-with-lists) in the Guides section for filtering, sorting, and pagination examples.", "operationId": "listReceivablePayments", "parameters": [ { "name": "sessionId", "in": "header", "schema": { "type": "string", "description": "API session ID generated with `/v3/login`", "nullable": true, "example": "{{session_id}}" } }, { "name": "devKey", "in": "header", "schema": { "type": "string", "description": "Developer key generated with your BILL developer account", "nullable": true, "example": "{{developer_key}}" } }, { "name": "max", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Maximum number of results", "format": "int32", "nullable": true, "example": 10 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "description": "Field name and sort order. Both simple and compound sorting is available.\n\nThe format is `sort={field_01}:{sort_order},{field_02}:{sort_order}`.\n\n**NOTE**: Sorting occurs in the specified order.", "nullable": true, "example": "createdTime:desc" } }, { "name": "filters", "in": "query", "schema": { "type": "string", "description": "Field name, operator, and value. Both simple and compound filtering is available.\n\nThe format is `filters={field_01}:{op}:{value},{field_02}:{op}:{value}`.", "nullable": true, "example": "id:eq:{{received_payment_id}}" } }, { "name": "page", "in": "query", "schema": { "type": "string", "description": "Next page of results.\n\nWhen 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.", "nullable": true } } ], "responses": { "200": { "description": "Get list of received payments response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListReceivablePaymentResponseDto" } } } }, "4XX": { "description": "List of errors.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BdcError" } } } } }, "5XX": { "description": "List of errors.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BdcError" } } } } } } } } }, "components": { "schemas": { "BdcError": { "required": [ "category", "code", "severity", "timestamp" ], "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "code": { "type": "string" }, "severity": { "$ref": "#/components/schemas/Severity" }, "category": { "$ref": "#/components/schemas/Category" }, "message": { "type": "string" }, "params": { "type": "array", "items": { "$ref": "#/components/schemas/Param" } }, "detail": { "type": "string" }, "help": { "type": "string" } } }, "Category": { "type": "string", "enum": [ "REQUEST", "APPLICATION", "SERVER", "DOWNSTREAM" ] }, "FundingAccount": { "type": "object", "properties": { "id": { "type": "string", "description": "BILL-generated ID of the customer funding account" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ReceivableFundingAccountTypeResponse" }, { "description": "Customer funding account type" } ] } }, "description": "Funding Account object." }, "InvoicePay": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "BILL-generated ID of the invoice to be paid. The value begins with `00e`." }, "amount": { "type": "number", "description": "Payment amount. For a payment in an international currency (not USD), this value is in the local currency." }, "paymentDate": { "type": "string", "description": "Invoice payment date. The value is in the `yyyy-MM-dd` format.", "format": "date" } }, "description": "Invoice Payment response." }, "InvoicePaymentTypeResponse": { "type": "string", "description": "Record AR payment type.", "enum": [ "CASH", "CHECK", "CREDIT_CARD", "ACH", "PAYPAL", "OTHER", "WALLET", "VIRTUAL_CARD", "UNDEFINED" ] }, "ListReceivablePaymentResponseDto": { "type": "object", "description": "List Receivable Payment response.", "allOf": [ { "$ref": "#/components/schemas/ListResponseDto_ReceivablePaymentResponseDto_" } ] }, "ListResponseDto_ReceivablePaymentResponseDto_": { "type": "object", "properties": { "nextPage": { "type": "string" }, "prevPage": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivablePaymentResponseDto" } } }, "description": "Response from a list API request with paging references." }, "Param": { "required": [ "name", "value" ], "type": "object", "properties": { "additional": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } } }, "ReceivableFundingAccountTypeResponse": { "type": "string", "description": "Receivable funding account type for receivable payment API.", "enum": [ "BANK_ACCOUNT", "CARD_ACCOUNT" ] }, "ReceivablePaymentResponseDto": { "required": [ "amount" ], "type": "object", "properties": { "id": { "type": "string", "description": "BILL-generated ID of the received payment. The value begins with `0rp`." }, "customerId": { "type": "string", "description": "BILL-generated ID of the customer. The value begins with `0cu`." }, "invoicePayments": { "type": "array", "description": "List of invoice payments", "items": { "$ref": "#/components/schemas/InvoicePay" } }, "description": { "type": "string", "description": "Invoice payment description. This value is included in the check memo or in the bank descriptor for electronic payments." }, "paymentDate": { "type": "string", "description": "Received payment date. Funds are withdrawn from the customer bank account on this date.", "format": "date" }, "fundingAccount": { "allOf": [ { "$ref": "#/components/schemas/FundingAccount" }, { "description": "Customer funding account information" } ] }, "receivablesAccount": { "allOf": [ { "$ref": "#/components/schemas/ReceivablesAccount" }, { "description": "Received payment funding account information" } ] }, "amount": { "type": "number", "description": "Received payment amount. For a payment in an international currency (not USD), this value is in the local currency." }, "unappliedAmount": { "type": "number", "description": "Unapplied received payment amount. This value is available for an overpayment, double payment, or customer payment not currently linked to an invoice." }, "convenienceFeeAmount": { "type": "number", "description": "Convenience fee charged to the customer" }, "receivablesType": { "allOf": [ { "$ref": "#/components/schemas/InvoicePaymentTypeResponse" }, { "description": "Received payment disbursement type." } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/RecordInvoicePaymentStatus" }, { "description": "Received payment status." } ] }, "referenceNumber": { "type": "string", "description": "Received payment reference number" }, "onlinePayment": { "type": "boolean", "description": "Information about how the received payment is recorded.\n* `true`: The payment is received with BILL\n* `false`: The payment is received outside BILL, and then recorded in BILL" }, "createdTime": { "type": "string", "description": "Received payment created date and time", "format": "date-time" }, "updatedTime": { "type": "string", "description": "Received payment updated date and time", "format": "date-time" } }, "description": "Receivable Payment response." }, "ReceivablesAccount": { "type": "object", "properties": { "id": { "type": "string", "description": "BILL-generated ID of the received payment funding account" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ReceivableFundingAccountTypeResponse" }, { "description": "Received payment funding account type" } ] } }, "description": "Disbursement Account object." }, "RecordInvoicePaymentStatus": { "type": "string", "description": "Record Invoice payment status enum.", "enum": [ "PAID", "VOID", "SCHEDULED", "CANCELED", "ESCHEATED", "UNDEFINED" ] }, "Severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFORMATION" ] } } } } ```