Payments allow users to record that funds (from checks, cash, credit cards, etc.) have been transferred from a client to the firm. In order to pay Bills, Payments must be [allocated](https://help.clio.com/hc/articles/9285641955355-Record-Edit-and-Delete-Payments). [Support Link](https://help.clio.com/hc/articles/9285641955355-Record-Edit-and-Delete-Payments)
openapi: 3.0.0
info:
title: Clio API Documentation Activities Clio Payments Payments API
contact:
name: Clio API Support
email: api@clio.com
description: "# Developer Support and Feedback\n* Clio takes the availability and stability of our API seriously; please report any **degradations** or **breakages** to Clio's API Support team at [api@clio.com](mailto:api@clio.com).\n* For business and partnership inquiries, contact our API Partnerships team at [api.partnerships@clio.com](mailto:api.partnerships@clio.com).\n* For best practices and tips from the Clio development community, join the conversation in the [Clio Developer Slack Channel](https://join.slack.com/t/clio-public/shared_invite/zt-36i0eqgo1-7POORPtMJpp2N0~_auL2IQ).\n\nA community-driven [Clio Developers Stack Overflow Group](https://stackoverflow.com/questions/tagged/clio-api) also exists where you can connect and ask questions from other Clio API users.\n# Getting Started\n> **Note:** The API is available in four distinct data regions: Australia (au.app.clio.com), Canada (ca.app.clio.com), EU (eu.app.clio.com) and US (app.clio.com).\n>\n> Likewise, the developer portal is available at region-specific links for the [Australia](https://au.developers.clio.com), [Canada](https://ca.developers.clio.com), [EU](https://eu.developers.clio.com), and [US](https://developers.clio.com) regions.\n>\n> This document assumes the US region is being used (app.clio.com). If you're building in one of the other regions, you should adapt the links and examples as necessary.\n\nTo start building on the Clio API, you’ll need a Clio account – you can review our [Developer Handbook](https://docs.developers.clio.com/) and follow the steps to sign up for an account.\n\nOnce you have an account, you can [create a developer application](https://docs.developers.clio.com/api-docs/applications) from the [Developer Portal](https://developers.clio.com) and start building!\n# Authorization with OAuth 2.0\nSee our [Authorization documentation →](https://docs.developers.clio.com/api-docs/authorization)\n# Permissions\nSee our [Permissions documentation →](https://docs.developers.clio.com/api-docs/permissions)\n# Fields\nSee our [Fields documentation →](https://docs.developers.clio.com/api-docs/fields)\n# Rate Limiting\nSee our [Rate Limits documentation →](https://docs.developers.clio.com/api-docs/rate-limits)\n# Paging\nSee our [Pagination documentation →](https://docs.developers.clio.com/api-docs/paging)\n# ETags\nSee our [ETags documentation →](https://docs.developers.clio.com/api-docs/etags)\n# Minor Versions\nAPI v4 supports multiple minor versions. Versions are of the form '4.X.Y'. To request a specific version, you can use an `X-API-VERSION` header in your request, with the header value set to the API version you're requesting. If this header is omitted, it will be treated as a request for the default API version. If the header is present but invalid, it will return a `410 Gone` response. If the header is present and valid, but it is no longer supported, it will return a `410 Gone` response.\n\nAn `X-API-VERSION` will be included in all successful responses, with the value being set to the API version used.\n\nYou can find our [API Versioning Policy and Guidelines](https://docs.developers.clio.com/api-docs/api-versioning-policy) in our documentation hub.\n\nThe [API Changelog](https://docs.developers.clio.com/api-docs/api-changelog) explains each version's changes in further detail.\n### [4.0.4](https://docs.developers.clio.com/api-docs/api-changelog#404)\n\n * Update `quantity` field to return values in seconds rather than hours for Activities\n\n### [4.0.5](https://docs.developers.clio.com/api-docs/api-changelog#405)\n\n * Remove `matter_balances` field from Bills\n* Standardize status/state enum values\n* Add a Document association to completed DocumentAutomations\n* Add rate visibility handling for Activity's price and total\n\n### [4.0.6](https://docs.developers.clio.com/api-docs/api-changelog#406)\n\n * Remove `document_versions` collection field from Documents\n\n### [4.0.7](https://docs.developers.clio.com/api-docs/api-changelog#407)\n\n * Change secure link format\n\n### [4.0.8](https://docs.developers.clio.com/api-docs/api-changelog#408)\n\n * `Activity` hours are redacted in the response based on the activity hours visibility setting for the user\n * Add `quantity_redacted` field to activities\n\n### [4.0.9](https://docs.developers.clio.com/api-docs/api-changelog#409)\n\n * Contacts are filtered and redacted in the response based on the new 'Contacts Visibility' user permission setting.\n\n### [4.0.10](https://docs.developers.clio.com/api-docs/api-changelog#4010)\n\n * Fixed validation of `type` query parameter when querying Notes\n\n### [4.0.12](https://docs.developers.clio.com/api-docs/api-changelog#4012)\n\n * Restrict fields for CalendarEntry that should only be visible to event owners, editors, and viewers\n\n### [4.0.13](https://docs.developers.clio.com/api-docs/api-changelog#4013)\n\n **This is the default version**\n\n * Add association limits to Contacts\n* Returns 422 Unprocessable Entity when association limits are exceeded\n\n\n"
version: v4
x-logo:
url: https://www.clio.com/wp-content/uploads/2015/05/Container-5-Logo.png
servers:
- url: https://app.clio.com/api/v4
description: US region Production Server
- url: https://eu.app.clio.com/api/v4
description: Europe region Production Server
- url: https://ca.app.clio.com/api/v4
description: Canada region Production Server
- url: https://au.app.clio.com/api/v4
description: Australia region Production Server
tags:
- name: Clio Payments Payments
description: 'Payments allow users to record that funds (from checks, cash, credit cards, etc.) have been transferred from a client to the firm. In order to pay Bills, Payments must be [allocated](https://help.clio.com/hc/articles/9285641955355-Record-Edit-and-Delete-Payments).
[Support Link](https://help.clio.com/hc/articles/9285641955355-Record-Edit-and-Delete-Payments)
'
paths:
/clio_payments/payments.json:
get:
tags:
- Clio Payments Payments
summary: Return the data for all ClioPaymentsPayments
operationId: ClioPaymentsPayment#index
description: Outlines the parameters, optional and required, used when requesting the data for all ClioPaymentsPayments
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: bill_id
in: query
description: Filter ClioPaymentsPayment records to those that are allocated to the specified bill.
required: false
schema:
type: integer
format: int64
- name: contact_id
in: query
description: Filter ClioPaymentsPayment records to those that are assigned to the specified contact.
required: false
schema:
type: integer
format: int64
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
- name: ids[]
in: query
description: Filter ClioPaymentsPayment records to those having the specified unique identifiers.
required: false
schema:
type: integer
format: int64
- name: limit
in: query
description: 'A limit on the number of ClioPaymentsPayment records to be returned. Limit can range between 1 and 200. Default: `200`.'
required: false
schema:
type: integer
format: int32
- name: page_token
in: query
description: A token specifying which page to return.
required: false
schema:
type: string
- name: state
in: query
description: Filter ClioPaymentsPayment records to those in a given state.
required: false
schema:
type: string
enum:
- pending
- authorized
- completed
- voided
- failed
- canceled
- requires_confirmation
- completed_requiring_allocation
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ClioPaymentsPayment_List'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
/clio_payments/payments/{id}.json:
get:
tags:
- Clio Payments Payments
summary: Return the data for a single ClioPaymentsPayment
operationId: ClioPaymentsPayment#show
description: Outlines the parameters, optional and required, used when requesting the data for a single ClioPaymentsPayment
parameters:
- name: IF-MODIFIED-SINCE
in: header
description: The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).
required: false
schema:
type: string
format: date
- name: IF-NONE-MATCH
in: header
description: The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.
required: false
schema:
type: string
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
- name: id
in: path
description: The unique identifier for the ClioPaymentsPayment.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ClioPaymentsPayment_Show'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'304':
description: Not Modified
components:
schemas:
ClioPaymentsLink_base:
type: object
properties:
active:
type: boolean
description: Whether or not the payment link is active.
amount:
type: number
format: double
description: The defined amount of the payment link, if set.
created_at:
type: string
format: date-time
description: The time the *ClioPaymentsLink* was created (as a ISO-8601 timestamp)
currency:
type: string
description: The currency the payment link will collect.
description:
type: string
description: The defined description of the payment link, if set.
email_address:
type: string
description: The email address to pre-fill the field on the the payment link, if set.
etag:
type: string
description: ETag for the *ClioPaymentsLink*
expires_at:
type: string
format: date-time
description: The ISO 8601 date and time the payment link will expire.
id:
type: integer
format: int64
description: Unique identifier for the *ClioPaymentsLink*
is_allocated_as_revenue:
type: boolean
description: Whether the payment link is allocated as revenue.
redirect_url:
type: string
description: The URL to redirect the client to after the payment has been made.
url:
type: string
description: The URL of the payment link.
Error:
type: object
required:
- error
properties:
error:
$ref: '#/components/schemas/ErrorDetail'
Bill_base:
type: object
properties:
id:
type: integer
format: int64
description: Unique identifier for the *Bill*
etag:
type: string
description: ETag for the *Bill*
number:
type: string
description: The *Bill* identifier (not necessarily numeric)'
issued_at:
type: string
format: date
description: The time the *Bill* was issued (as a ISO-8601 date)
created_at:
type: string
format: date-time
description: The time the *Bill* was created (as a ISO-8601 timestamp)
due_at:
type: string
format: date
description: The date the *Bill* is due (as a ISO-8601 date)
tax_rate:
type: number
format: double
description: The tax rate to the *Bill*
secondary_tax_rate:
type: number
format: double
description: A secondary tax rate applied to the *Bill*
updated_at:
type: string
format: date-time
description: The time the *Bill* was last updated (as a ISO-8601 timestamp)
subject:
type: string
description: The subject of the *Bill*
purchase_order:
type: string
description: The purchase order of the *Bill*
type:
type: string
enum:
- MatterBill
- ClientBill
description: The type of the *Bill*
memo:
type: string
description: A memo for the *Bill*
start_at:
type: string
format: date
description: The time the billing period starts (as a ISO-8601 date)
end_at:
type: string
format: date
description: The time the billing period ends (as a ISO-8601 date)
balance:
type: number
format: double
description: The outstanding balance of the *Bill*
state:
type: string
enum:
- draft
- awaiting_approval
- awaiting_payment
- paid
- void
- deleted
description: The billing state the *Bill* is in
kind:
type: string
enum:
- revenue_kind
- summary_kind
- trust_kind
- aggregate_all
- aggregate_split
- aggregate_services
- aggregate_expenses
description: The kind of the *Bill*
total:
type: number
format: double
description: The total with interest of the *Bill*
paid:
type: number
format: double
description: The total amount paid for the *Bill*
paid_at:
type: string
format: date-time
description: The date of the last payment on the *Bill*
pending:
type: number
format: double
description: The amount of pending credit card payments on the *Bill*
due:
type: number
format: double
description: The total amount of the *Bill* with interest and less discounts
discount_services_only:
type: string
description: The selected discount is applied to services only.
can_update:
type: boolean
description: This value indicates if your *Bill*'s line items and information can be updated.
credits_issued:
type: number
format: double
description: The total credits issued for the *Bill*
shared:
type: boolean
description: Whether the *Bill* is a shared
last_sent_at:
type: string
format: date-time
description: The last time the *Bill* was sent (as a ISO-8601 date)
services_secondary_tax:
type: number
format: double
description: The total secondary tax of the bill's line items of a service kind
services_sub_total:
type: number
format: double
description: The sub total of all the bill's line items of a service kind
services_tax:
type: number
format: double
description: The total tax of the bill's line items of a service kind
services_taxable_sub_total:
type: integer
format: int64
description: The services portion of the bill's primary tax
services_secondary_taxable_sub_total:
type: integer
format: int64
description: The services portion of the bill's secondary tax
taxable_sub_total:
type: integer
format: int64
description: The total taxable bill amount
secondary_taxable_sub_total:
type: integer
format: int64
description: The subtotal of the bill's secondary tax
sub_total:
type: number
format: double
description: Sub total for the *Bill*
tax_sum:
type: number
format: double
description: Sum of primary tax for the model
secondary_tax_sum:
type: number
format: double
description: Sum of secondary tax for the model
total_tax:
type: number
format: double
description: The total amount of tax for the bill.
available_state_transitions:
type: array
items:
type: string
enum:
- awaiting_approval
- awaiting_payment
- paid
- void
- deleted
description: The available *Bill* state transitions.
BankTransaction_base:
type: object
properties:
id:
type: integer
format: int64
description: Unique identifier for the *BankTransaction*
type:
type: string
description: The type of the *BankTransaction*
etag:
type: string
description: ETag for the *BankTransaction*
created_at:
type: string
format: date-time
description: The time the *BankTransaction* was created (as a ISO-8601 timestamp)
updated_at:
type: string
format: date-time
description: The time the *BankTransaction* was last updated (as a ISO-8601 timestamp)
bank_account_id:
type: integer
format: int64
description: The associated bank account.
source:
type: string
description: Where the transaction came from.
confirmation:
type: string
description: The reference code for the transaction.
date:
type: string
format: date
description: The date of the transaction.
amount:
type: number
format: double
description: The amount of the transaction.
currency:
type: string
description: The currency of the transaction.
currency_id:
type: integer
format: int64
description: The id of the currency of the transaction.
description:
type: string
description: The description of the transaction.
exchange_rate:
type: number
format: double
description: The exchange rate of the transaction.
transaction_type:
type: string
description: What kind of transaction.
funds_in:
type: number
format: double
description: The amount of funds received in this transaction.
funds_out:
type: number
format: double
description: The amount of funds withdrawn in this transaction.
clio_payments_transaction:
type: boolean
description: Whether the transaction was created through online payments.
current_account_balance:
type: number
format: double
description: The current account balance.
read_only_confirmation:
type: boolean
description: Whether the transaction's reference code is read-only.
ClioPaymentsPayment_Show:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/ClioPaymentsPayment'
Contact_base:
type: object
properties:
id:
type: integer
format: int64
description: Unique identifier for the *Contact*
etag:
type: string
description: ETag for the *Contact*
name:
type: string
description: The full name of the *Contact*
first_name:
type: string
description: First name of the Person
middle_name:
type: string
description: Middle name of the Person
last_name:
type: string
description: Last name of the Person
date_of_birth:
type: string
format: date
description: Date of birth
type:
type: string
enum:
- Company
- Person
description: The type of the *Contact*
created_at:
type: string
format: date-time
description: The time the *Contact* was created (as a ISO-8601 timestamp)
updated_at:
type: string
format: date-time
description: The time the *Contact* was last updated (as a ISO-8601 timestamp)
prefix:
type: string
description: The prefix of the *Contact* (Mr, Mrs, etc)
title:
type: string
description: The designated title of the *Contact*
initials:
type: string
description: The initials of the *Contact*
clio_connect_email:
type: string
description: Clio Connect email if the *Contact* is a ClioConnect User
locked_clio_connect_email:
type: boolean
description: A boolean indicating if the ability to modify this *Contacts Clio connect email is locked.
client_connect_user_id:
type: integer
format: int64
description: The ID for the Clio Connect user associated with this *Contact*
primary_email_address:
type: string
description: The primary email address associated with this *Contact*.
secondary_email_address:
type: string
description: The secondary email address associated with this *Contact*.
primary_phone_number:
type: string
description: The primary phone number associated with this *Contact*.
secondary_phone_number:
type: string
description: The secondary phone number of the *Contact*.
ledes_client_id:
type: string
description: LEDES client id of the Contact
has_clio_for_clients_permission:
type: boolean
description: True if at least one resource has been shared with the contact using Clio for Clients.
is_client:
type: boolean
description: Whether or not the Contact is a client
is_clio_for_client_user:
type: boolean
description: Whether or not this contact has client_login and client_user (can be created due to addition to client portal or client_share_permissions)
is_co_counsel:
type: boolean
description: Whether or not the Contact has matters shared as co-counsel
is_bill_recipient:
type: boolean
description: Whether the Contact is a bill recipient on at least one matter.
sales_tax_number:
type: string
description: The sales tax number of the *Contact*
currency:
type: object
description: Currency of the *Contact*
Matter_base:
type: object
properties:
id:
type: integer
format: int64
description: Unique identifier for the *Matter*
etag:
type: string
description: ETag for the *Matter*
number:
type: integer
format: int32
description: The number given to the *Matter* within an account
display_number:
type: string
description: The reference and label of the *Matter*. Depending on the account's manual_matter_numbering setting, this is either read only (generated) or customizable.
custom_number:
type: string
description: User defined custom number of the *Matter*
currency:
type: object
description: Currency of the matter
description:
type: string
description: The detailed description of the *Matter*
status:
type: string
enum:
- Pending
- Open
- Closed
description: The current status of the *Matter*
location:
type: string
description: The location of the *Matter*
client_reference:
type: string
description: Client Reference string for external uses
client_id:
type: integer
format: int64
description: Client ID
billable:
type: boolean
description: Whether this matter is billable
maildrop_address:
type: string
description: A unique Maildrop email address for the matter
billing_method:
type: string
enum:
- flat
- contingency
- hourly
description: Billing method of this matter
open_date:
type: string
format: date
description: The date the matter was set to open (as a ISO-8601 date)
close_date:
type: string
format: date
description: The date the matter was set to closed (as a ISO-8601 date)
pending_date:
type: string
format: date
description: The date the matter was set to pending (as a ISO-8601 date)
created_at:
type: string
format: date-time
description: The time the *Matter* was created (as a ISO-8601 timestamp)
updated_at:
type: string
format: date-time
description: The time the *Matter* was last updated (as a ISO-8601 timestamp)
shared:
type: boolean
description: Whether the matter is currently shared with Clio Connect
has_tasks:
type: boolean
description: Whether or not the matter has any tasks.
last_activity_date:
type: string
format: date
description: The greatest date out of all of the activities on the matter (as a ISO-8601 date)
matter_stage_updated_at:
type: string
format: date-time
description: The date the matter stage was last updated (as a ISO-8601 date)
Allocation_base:
type: object
properties:
id:
type: integer
format: int64
description: Unique identifier for the *Allocation*
etag:
type: string
description: ETag for the *Allocation*
date:
type: string
format: date
description: The date the allocation was applied (as a ISO-8601 date)
amount:
type: number
format: double
description: The total amount of money that the user has allocated
interest:
type: boolean
description: Whether the allocation is applied to interest amount
voided_at:
type: string
format: date-time
description: Time the *Allocation* was voided (as a ISO-8601 timestamp)
created_at:
type: string
format: date-time
description: The time the *Allocation* was created (as a ISO-8601 timestamp)
updated_at:
type: string
format: date-time
description: The time the *Allocation* was last updated (as a ISO-8601 timestamp)
description:
type: string
description: The description from the associated Credit Memo (if applicable)
has_online_payment:
type: boolean
description: Whether this allocation is associated with an online payment or not
destroyable:
type: boolean
description: Whether the record can be deleted or not
payment_type:
type: string
description: A string indicating whether the payment is a card or an eCheck payment.
ClioPaymentsPayment:
allOf:
- $ref: '#/components/schemas/ClioPaymentsPayment_base'
- type: object
properties:
bank_transaction:
$ref: '#/components/schemas/BankTransaction_base'
description: BankTransaction
clio_payments_link:
$ref: '#/components/schemas/ClioPaymentsLink_base'
description: ClioPaymentsLink
contact:
$ref: '#/components/schemas/Contact_base'
description: Contact
destination_account:
$ref: '#/components/schemas/BankAccount_base'
description: BankAccount
user:
$ref: '#/components/schemas/User_base'
description: User
allocations:
type: array
items:
$ref: '#/components/schemas/Allocation_base'
description: Allocation
bills:
type: array
items:
$ref: '#/components/schemas/Bill_base'
description: Bill
matters:
type: array
items:
$ref: '#/components/schemas/Matter_base'
description: Matter
User_base:
type: object
properties:
account_owner:
type: boolean
description: Whether the *User* is the owner of the account
clio_connect:
type: boolean
description: Whether the *User* is a Clio Connect user
court_rules_default_attendee:
type: boolean
description: Whether the *User* is a default attendee for court rules events
created_at:
type: string
format: date-time
description: The time the *User* was created (as a ISO-8601 timestamp)
default_calendar_id:
type: integer
format: int64
description: Default calendar id for *User*.
email:
type: string
description: The email of the *User*
enabled:
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-clio-payments-payments-api-openapi.yml