List Payments

Lists payments in a paginated format with details such as ID, amount, date, status, invoice reference, and payment method information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

For schema of payment object refer - Payment Data Model

This API may not return all fields defined in the response schema; for additional details, use the Get Payment by Id API.


Supported Apps

Here is the list of apps that supports this API

AppApp ID
Xeroxero
QuickBooksquickbooks
Zohobookzohobook
Microsoft Dynamics Business Centralmicrosoft-dynamics-business-central
Netsuitenetsuite
Odoo Accounting Onlineodoo
Sage 200 Standardsage200
📘

To see the list of supported filters for an app, refer - ACCOUNTING List Payments Filter Support Matrix


Query Params
string
enum
required
Allowed:
string
Defaults to null
boolean
Defaults to false
string

Filters payment which were created after the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

string

Filters payment which were created before the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

string

Filters payment which were updated after the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

string

Filters payment which were updated before the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

string

Filters payment by one or more invoiceAccountId. Supports multiple values as a comma-separated list. Example: invoiceAccountId=45678,67897

string

Filters payment by one or more billAccountId. Supports multiple values as a comma-separated list. Example: billAccountId=45678,67897

string

Filters payment by one or more vendorId. Supports multiple values as a comma-separated list. Example: vendorId=45678,67897

string

Filters payment by one or more customerId. Supports multiple values as a comma-separated list. Example: customerId=45678,67897

string

Filters payment by one or more status. Supports multiple values as a comma-separated list. Example: status=SUCCESS,FAILURE,PENDING

Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json