CLclio
Clio Payments Payments

Return the data for all ClioPaymentsPayments

Changed on

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

get/clio_payments/payments.json

Request

  • Base URL
    https://app.clio.com/api/v4
  • URL
    https://app.clio.com/api/v4/clio_payments/payments.json
  • Auth
    none declared

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

Changes

  • af66d52fa965Revision changes
    • breaking

      removed the enum value funds_available from the query request parameter state

    • info

      removed the funds_available enum value from the ////// response property for the response status

  • 0d933d547355Revision changes
    • warning

      added the new funds_available enum value to the ////// response property for the response status

    • warning

      added the new singapore enum value to the //// response property for the response status

    • info

      added the new enum value funds_available to the query request parameter state