Clio Clio Payments Links API
The Clio Payments Links API from Clio — 2 operation(s) for clio payments links.
OpenAPI Specification
openapi: 3.0.0
info:
title: Clio API Documentation Activities Clio Payments Links 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 Links
description: ''
paths:
/clio_payments/links.json:
get:
tags:
- Clio Payments Links
summary: Return the data for all ClioPaymentsLinks
operationId: ClioPaymentsLink#index
description: Outlines the parameters, optional and required, used when requesting the data for all ClioPaymentsLinks
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: active
in: query
description: Filter ClioPaymentsLink records based on whether or not they have expired.
required: false
schema:
type: boolean
- name: created_since
in: query
description: Filter ClioPaymentsLink records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
required: false
schema:
type: string
format: date-time
- 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 ClioPaymentsLink 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 ClioPaymentsLink 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: updated_since
in: query
description: Filter ClioPaymentsLink records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
required: false
schema:
type: string
format: date-time
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ClioPaymentsLink_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'
post:
tags:
- Clio Payments Links
summary: Create a new ClioPaymentsLink
operationId: ClioPaymentsLink#create
description: Outlines the parameters and data fields used when creating a new ClioPaymentsLink
parameters:
- 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
responses:
'201':
description: Created
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ClioPaymentsLink_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'
'422':
description: Unprocessable Entity
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'
requestBody:
description: Request Body for Links
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
amount:
type: number
format: double
description: The amount to be paid. If not provided, the client will be able to specify an amount.
currency:
type: string
description: The currency the payment will be processed in. The supported currency depends on the account's location ('USD' for a US account). The currency must be a valid ISO 4217 currency code.
description:
type: string
description: Only applicable for a direct payment. A short description of the purpose of the payment. Max 255 characters.
destination_account:
type: object
properties:
id:
type: integer
format: int64
description: The ID of the bank account that the payment will be deposited into.
required:
- id
destination_contact:
type: object
properties:
id:
type: integer
format: int64
description: Only applicable for a direct payment. The contact that the payment will be associated with. If not defined, and the payment is collecting an unallocated balance, then the payment can be associated with a contact manually within Manage after it has been made.
duration:
type: integer
format: int64
description: The amount of time, in seconds, that the payment link will be active for. The maximum allowed value is '7776000' (90 days in seconds).
email_address:
type: string
description: Pre-fills the relevant field for the client when filling out their details in the payment link.
is_allocated_as_revenue:
type: boolean
description: Only applicable for a direct payment. If true, the payment will be allocated as revenue. If false, the payment will be collected as an unallocated balance. Payments into trust can not be allocated as revenue. Defaults to false.
subject:
type: object
properties:
id:
type: integer
format: int64
description: The ID of the record associated with the payment link.
type:
type: string
enum:
- BankAccount
- Bill
- Contact
description: 'The type of the record associated with the payment link. The type of record determines the behavior of the payment link.
Type of subject object:
* ''BankAccount'' results in a payment link for a direct payment.
* ''Bill'' results in a payment link for paying an existing invoice or trust request.
* ''Contact'' results in a payment link for paying the outstanding invoices of a contact.
'
required:
- id
- type
required:
- currency
- description
- destination_account
- duration
- subject
application/x-www-form-urlencoded:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
amount:
type: number
format: double
description: The amount to be paid. If not provided, the client will be able to specify an amount.
currency:
type: string
description: The currency the payment will be processed in. The supported currency depends on the account's location ('USD' for a US account). The currency must be a valid ISO 4217 currency code.
description:
type: string
description: Only applicable for a direct payment. A short description of the purpose of the payment. Max 255 characters.
destination_account:
type: object
properties:
id:
type: integer
format: int64
description: The ID of the bank account that the payment will be deposited into.
required:
- id
destination_contact:
type: object
properties:
id:
type: integer
format: int64
description: Only applicable for a direct payment. The contact that the payment will be associated with. If not defined, and the payment is collecting an unallocated balance, then the payment can be associated with a contact manually within Manage after it has been made.
duration:
type: integer
format: int64
description: The amount of time, in seconds, that the payment link will be active for. The maximum allowed value is '7776000' (90 days in seconds).
email_address:
type: string
description: Pre-fills the relevant field for the client when filling out their details in the payment link.
is_allocated_as_revenue:
type: boolean
description: Only applicable for a direct payment. If true, the payment will be allocated as revenue. If false, the payment will be collected as an unallocated balance. Payments into trust can not be allocated as revenue. Defaults to false.
subject:
type: object
properties:
id:
type: integer
format: int64
description: The ID of the record associated with the payment link.
type:
type: string
enum:
- BankAccount
- Bill
- Contact
description: 'The type of the record associated with the payment link. The type of record determines the behavior of the payment link.
Type of subject object:
* ''BankAccount'' results in a payment link for a direct payment.
* ''Bill'' results in a payment link for paying an existing invoice or trust request.
* ''Contact'' results in a payment link for paying the outstanding invoices of a contact.
'
required:
- id
- type
required:
- currency
- description
- destination_account
- duration
- subject
multipart/form-data:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
amount:
type: number
format: double
description: The amount to be paid. If not provided, the client will be able to specify an amount.
currency:
type: string
description: The currency the payment will be processed in. The supported currency depends on the account's location ('USD' for a US account). The currency must be a valid ISO 4217 currency code.
description:
type: string
description: Only applicable for a direct payment. A short description of the purpose of the payment. Max 255 characters.
destination_account:
type: object
properties:
id:
type: integer
format: int64
description: The ID of the bank account that the payment will be deposited into.
required:
- id
destination_contact:
type: object
properties:
id:
type: integer
format: int64
description: Only applicable for a direct payment. The contact that the payment will be associated with. If not defined, and the payment is collecting an unallocated balance, then the payment can be associated with a contact manually within Manage after it has been made.
duration:
type: integer
format: int64
description: The amount of time, in seconds, that the payment link will be active for. The maximum allowed value is '7776000' (90 days in seconds).
email_address:
type: string
description: Pre-fills the relevant field for the client when filling out their details in the payment link.
is_allocated_as_revenue:
type: boolean
description: Only applicable for a direct payment. If true, the payment will be allocated as revenue. If false, the payment will be collected as an unallocated balance. Payments into trust can not be allocated as revenue. Defaults to false.
subject:
type: object
properties:
id:
type: integer
format: int64
description: The ID of the record associated with the payment link.
type:
type: string
enum:
- BankAccount
- Bill
- Contact
description: 'The type of the record associated with the payment link. The type of record determines the behavior of the payment link.
Type of subject object:
* ''BankAccount'' results in a payment link for a direct payment.
* ''Bill'' results in a payment link for paying an existing invoice or trust request.
* ''Contact'' results in a payment link for paying the outstanding invoices of a contact.
'
required:
- id
- type
required:
- currency
- description
- destination_account
- duration
- subject
required: false
/clio_payments/links/{id}.json:
get:
tags:
- Clio Payments Links
summary: Return the data for a single ClioPaymentsLink
operationId: ClioPaymentsLink#show
description: Outlines the parameters, optional and required, used when requesting the data for a single ClioPaymentsLink
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 ClioPaymentsLink.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ClioPaymentsLink_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
patch:
tags:
- Clio Payments Links
summary: Update a single ClioPaymentsLink
operationId: ClioPaymentsLink#update
description: Outlines the parameters and data fields used when updating a single ClioPaymentsLink
parameters:
- name: IF-MATCH
in: header
description: The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).
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 ClioPaymentsLink.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ClioPaymentsLink_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'
'422':
description: Unprocessable Entity
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'
'412':
description: Precondition Failed
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
requestBody:
description: Request Body for Links
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
expired:
type: boolean
description: Setting this will update the payment link to be immediately expired.
application/x-www-form-urlencoded:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
expired:
type: boolean
description: Setting this will update the payment link to be immediately expired.
multipart/form-data:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
expired:
type: boolean
description: Setting this will update the payment link to be immediately expired.
required: false
components:
schemas:
ClioPaymentsLink:
allOf:
- $ref: '#/components/schemas/ClioPaymentsLink_base'
- type: object
properties:
bank_account:
$ref: '#/components/schemas/BankAccount_base'
description: BankAccount
bill:
$ref: '#/components/schemas/Bill_base'
description: Bill
clio_payments_payment:
$ref: '#/components/schemas/ClioPaymentsPayment_base'
description: ClioPaymentsPayment
contact:
$ref: '#/components/schemas/Contact_base'
description: Contact
destination_account:
$ref: '#/components/schemas/BankAccount_base'
description: BankAccount
destination_contact:
$ref: '#/components/schemas/Contact_base'
description: Contact
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
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-clio-payments-links-api-openapi.yml