Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Clio Payments Payments

Return the data for all ClioPaymentsPayments

Outlines the parameters, optional and required, used when requesting the data for all ClioPaymentsPayments

get/clio_payments/payments.json

Query parameters

bill_idinteger

Filter ClioPaymentsPayment records to those that are allocated to the specified bill.

contact_idinteger

Filter ClioPaymentsPayment records to those that are assigned to the specified contact.

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter ClioPaymentsPayment records to those having the specified unique identifiers.

limitinteger

A limit on the number of ClioPaymentsPayment records to be returned. Limit can range between 1 and 200. Default: 200.

page_tokenstring

A token specifying which page to return.

state'pending' | 'authorized' | 'completed' | 'voided' | 'failed' | 'canceled' | 'requires_confirmation' | 'completed_requiring_allocation'

Filter ClioPaymentsPayment records to those in a given state.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok