openapi: 3.0.0
info:
title: Clio API Documentation Activities Billable Matters 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: Billable Matters
description: 'Users can see all [Matters with outstanding bills](https://help.clio.com/hc/en-us/articles/9286116462747#filter-matters-clio-manage-0-0) attached to them by filtering out all non-billable Matters under the Matters tab.
Users can [disable billing](https://help.clio.com/hc/en-us/articles/9285959663131-Create-Matters#h_01GEK791XBF1JJ0VYC8BQTG9MW) for certain Matters. They can still enter Activities on these Matters, but those Activities will not appear in the [Bills page](https://help.clio.com/hc/en-us/articles/9285169278747-Generate-Bills).
'
paths:
/billable_matters/ids.json:
get:
tags:
- Billable Matters
summary: Returns the unique identifiers of all BillableMatter
operationId: BillableMatter#ids
description: This data is retrieved asynchronously
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: client_id
in: query
description: The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.
required: false
schema:
type: integer
format: int64
- name: custom_field_values
in: query
description: 'Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,
if the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string.
The key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`
If an operator is used for a type that does not support it, an `400 Bad Request` is returned.
*Supported operators:*
* `checkbox`, `contact`, `matter`, `picklist` : `=`
e.g. `?custom_field_values[1]=42`
* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`
e.g. `?custom_field_values[1]=>=105.4`
* `email`, `text_area`, `text_line`, `url` : `=`
e.g. `?custom_field_values[1]=url_encoded`
*Multiple conditions for the same custom field:*
If you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.
e.g. `?custom_field_values[1]=[<=50, >=45]`
'
required: false
schema:
type: string
enum:
- '='
- <
- '>'
- <=
- '>='
- name: end_date
in: query
description: Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date).
required: false
schema:
type: string
format: date
- 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: limit
in: query
description: 'A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: `1000`.'
required: false
schema:
type: integer
format: int32
- name: matter_id
in: query
description: The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.
required: false
schema:
type: integer
format: int64
- name: originating_attorney_id
in: query
description: The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.
required: false
schema:
type: integer
format: int64
- name: page_token
in: query
description: A token specifying which page to return.
required: false
schema:
type: string
- name: query
in: query
description: Wildcard search for `display_number` or `number` or `description` matching a given string.
required: false
schema:
type: string
- name: responsible_attorney_id
in: query
description: The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.
required: false
schema:
type: integer
format: int64
- name: start_date
in: query
description: Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date).
required: false
schema:
type: string
format: date
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/BillableMatter_Show'
'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'
/billable_matters.json:
get:
tags:
- Billable Matters
summary: Return the data for all BillableMatters
operationId: BillableMatter#index
description: Outlines the parameters, optional and required, used when requesting the data for all BillableMatters
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: client_id
in: query
description: The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.
required: false
schema:
type: integer
format: int64
- name: custom_field_values
in: query
description: 'Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,
if the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string.
The key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`
If an operator is used for a type that does not support it, an `400 Bad Request` is returned.
*Supported operators:*
* `checkbox`, `contact`, `matter`, `picklist` : `=`
e.g. `?custom_field_values[1]=42`
* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`
e.g. `?custom_field_values[1]=>=105.4`
* `email`, `text_area`, `text_line`, `url` : `=`
e.g. `?custom_field_values[1]=url_encoded`
*Multiple conditions for the same custom field:*
If you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.
e.g. `?custom_field_values[1]=[<=50, >=45]`
'
required: false
schema:
type: string
enum:
- '='
- <
- '>'
- <=
- '>='
- name: end_date
in: query
description: Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date).
required: false
schema:
type: string
format: date
- 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: limit
in: query
description: 'A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: `1000`.'
required: false
schema:
type: integer
format: int32
- name: matter_id
in: query
description: The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.
required: false
schema:
type: integer
format: int64
- name: originating_attorney_id
in: query
description: The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.
required: false
schema:
type: integer
format: int64
- name: page_token
in: query
description: A token specifying which page to return.
required: false
schema:
type: string
- name: query
in: query
description: Wildcard search for `display_number` or `number` or `description` matching a given string.
required: false
schema:
type: string
- name: responsible_attorney_id
in: query
description: The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.
required: false
schema:
type: integer
format: int64
- name: start_date
in: query
description: Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date).
required: false
schema:
type: string
format: date
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/BillableMatter_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'
components:
schemas:
BillableMatter_List:
type: object
required:
- data
properties:
data:
type: array
description: BillableMatter List Response
items:
$ref: '#/components/schemas/BillableMatter'
Error:
type: object
required:
- error
properties:
error:
$ref: '#/components/schemas/ErrorDetail'
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*
BillableMatter:
allOf:
- $ref: '#/components/schemas/BillableMatter_base'
- type: object
properties:
client:
$ref: '#/components/schemas/Contact_base'
description: Contact
ErrorDetail:
type: object
required:
- type
- message
properties:
type:
type: string
description: Unique name for this error
message:
type: string
description: Detailed message about the error
BillableMatter_Show:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/BillableMatter'
BillableMatter_base:
type: object
properties:
currency_code:
type: string
description: The currency code
currency_id:
type: integer
format: int64
description: The currency ID
id:
type: integer
format: int64
description: Unique identifier for the *BillableMatter*
unbilled_hours:
type: number
format: double
description: The unbilled number of hours for the matter
unbilled_amount:
type: number
format: double
description: The unbilled amount for the matter
amount_in_trust:
type: number
format: double
description: The trust amount available for the matter
display_number:
type: string
description: The reference to the matter
x-tagGroups:
- name: Api
tags:
- Custom Actions
- Webhooks
- name: Activities
tags:
- Activities
- Activity Descriptions
- Activity Rates
- Expense Categories
- Timers
- Utbms Codes
- Utbms Sets
- name: Accounting
tags:
- Bank Accounts
- Bank Transactions
- Bank Transfers
- name: Billing
tags:
- Bills
- Billable Clients
- Billable Matters
- Bill Themes
- Interest Charges
- Line Items
- Outstanding Client Balances
- name: Calendars
tags:
- Calendars
- Calendar Entries
- Calendar Entry Event Types
- Calendar Visibilities
- Reminders
- name: Clio Payments
tags:
- Clio Payments Links
- Clio Payments Payments
- name: Communications
tags:
- Communications
- Conversations
- Conversation Messages
- name: Contacts
tags:
- Contacts
- Email Addresses
- Phone Numbers
- Notes
- Log Entries
- name: Court Rules
tags:
- Jurisdictions To Triggers
- Jurisdictions
- Matter Dockets
- Service Types
- name: Custom Fields
tags:
- Custom Fields
- Custom Field Sets
- name: Documents
tags:
- Documents
- Document Versions
- Folders
- Document Archives
- Document Automations
- Document Categories
- Document Templates
- Comments
- name: In-app Notifications
tags:
- My Events
- Event Metrics
- name: Matters
tags:
- Matters
- Relationships
- Clients
- Related Contacts
- Matter Contacts
- Notes
- Practice Areas
- Log Entries
- Matter Stages
- Medical Records Details
- Medical Records
- Medical Bills
- Damages
- name: Payments
tags:
- Allocations
- Credit Memos
- name: Reporting
tags:
- Reports
- Report Presets
- Report Schedules
- name: Settings
tags:
- Text Snippets
- Billing Settings
- Currencies
- Tax Rate Configurations
- name: Tasks
tags:
- Tasks
- Task Templates
- Task Template Lists
- Task Types
- name: Trust
tags:
- Trust Line Items
- Trust Requests
- name: Users
tags:
- Users
- Groups
- name: Legal Aid US
tags:
- Grants
- Grant Funding Sources
- name: Legal Aid England & Wales
tags:
- Civil Controlled Rates
- Civil Certificated Rates
- Criminal Controlled Rates
- Expense Categories