A community-driven Clio Developers Stack Overflow Group also exists where you can connect and ask questions from other Clio API users.
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).
Likewise, the developer portal is available at region-specific links for the Australia, Canada, EU, and US regions.
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.
To start building on the Clio API, you’ll need a Clio account – you can review our Developer Handbook and follow the steps to sign up for an account.
Once you have an account, you can create a developer application from the Developer Portal and start building!
See our Authorization documentation →
See our Permissions documentation →
See our Fields documentation →
See our Rate Limits documentation →
See our Pagination documentation →
See our ETags documentation →
API 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.
An X-API-VERSION
will be included in all successful responses, with the value being set to the API version used.
You can find our API Versioning Policy and Guidelines in our documentation hub.
The API Changelog explains each version's changes in further detail.
4.0.4
Update quantity
field to return values in seconds rather than hours for Activities
4.0.5
matter_balances
field from Bills4.0.6
Remove document_versions
collection field from Documents
4.0.7
Change secure link format
4.0.8
Activity
hours are redacted in the response based on the activity hours visibility setting for the userquantity_redacted
field to activities4.0.9
This is the default version
Contacts are filtered and redacted in the response based on the new 'Contacts Visibility' user permission setting.
4.0.10
Fixed validation of type
query parameter when querying Notes
In Clio, applications can create custom actions in our interface. Links are unique across an application, user, location in the UI (ui_reference
) and label. When the user clicks on a custom action, Clio will open a new browser tab at the target_url
.
Clio will add a few URL parameters to the target_url
, including the custom action ID, the ID of the user who clicked the link and the URL of the object(s) which the link was clicked on. The third party application must then look up the relevant OAuth token associated with the user and custom action, and make an authenticated request to the subject_url
. This request both lets you validate the request was made by who you expected, that they have access to the record and lets you pull down any extra information you may need.
Currently supported for: Activities, Contacts, Documents and Matters
As custom actions require an unauthorized GET request, which can be faked, Clio has provided a way to validate that a user has actually performed an action.
When a request is sent to the URL specified on the custom action, we will include a custom_action_nonce
parameter. If you send us back the custom_action_nonce
in your next request to the API, Clio will use it to validate that the user who clicked the custom action matches your oauth token request. If no match is made, an error will be returned.
Outlines the parameters, optional and required, used when requesting the data for all CustomActions
created_since | string <date-time> Filter CustomAction records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter CustomAction records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of CustomAction records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter CustomAction records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "target_url": "string",
- "ui_reference": "activities/show"
}
]
}
Outlines the parameters and data fields used when creating a new CustomAction
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Custom Actions
required | object | ||||||
|
{- "data": {
- "label": "string",
- "target_url": "string",
- "ui_reference": "activities/show"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "target_url": "string",
- "ui_reference": "activities/show"
}
}
Outlines the parameters, optional and required, used when requesting the data for a single CustomAction
id required | integer <int64> The unique identifier for the CustomAction. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "target_url": "string",
- "ui_reference": "activities/show"
}
}
Outlines the parameters and data fields used when updating a single CustomAction
id required | integer <int64> The unique identifier for the CustomAction. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Custom Actions
required | object | ||||||
|
{- "data": {
- "label": "string",
- "target_url": "string",
- "ui_reference": "activities/show"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "target_url": "string",
- "ui_reference": "activities/show"
}
}
Outlines the parameters, optional and required, used when deleting the record for a single CustomAction
id required | integer <int64> The unique identifier for the CustomAction. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Webhooks are a way of detecting events in Clio without the need for polling.
A webhook can be subscribed to a number of events
on a model. Some events will be different depending on the chosen model, but (with one exception) all models support the following events:
created
updated
deleted
To subscribe to any or all events for a model, create a webhook record with the URL that you want webhooks to be sent to, a model, and the list of events
you care about. Whenever an event happens on that model in Clio that the user is authorized to see, an HTTP request will be made to the supplied URL with details about the event. A webhook will automatically expire after a set period of time. If no expires_at
parameter is provided, the webhook will expire after 3 days. The maximum duration you can set a webhook to expire after is 31 days. If you require longer than that, you can manually extend it by updating the expires_at
field.
Your application needs to have the corresponding model OAuth scope when creating or updating a webhook. For example, when creating/updating a folder webhook you need the document Oauth Scope and the webhook Oauth Scope. The list of models supported by webhooks with their corresponding string identifier and ID is presented in the following table:
Name | String Identifier | ID | Oauth Scope |
---|---|---|---|
Matter | matter | 1 | Matters |
Activity | activity | 2 | Activities |
Bill | bill | 3 | Billing |
Calendar Entry | calendar_entry | 4 | Calendars |
Communication | communication | 5 | Communications |
Contact | contact | 6 | Contacts |
Task | task | 7 | Tasks |
Document | document | 8 | Documents |
Folder | folder | 9 | Documents |
Clio Payments payment | clio_payments_payment | 10 | Clio Payments |
Please note that all webhooks MUST be using a url with the https
scheme. All other schemes, including http
, will be rejected.
When a webhook is sent, the payload will not include the entire object for the record. To select specific fields from the record, you can use the fields parameter when creating the webhook. For example: when creating a webhook listening for new Activity records being created, you can pass the value “id,etag,quantity,price” into the fields parameter. When an Activity is created, the id, etag, quantity, and price fields of the new Activity will be included in the webhook's payload.
For update
webhooks, the fields parameter is also used to specify fields that will be “watched” by the webhook. Clio will only send a webhook when at least one of the selected fields has changed on a record.
An important note If you have never received a webhook for an object before, you will receive a webhook for that object if any fields have changed on that object, including fields you haven't subscribed to. For example: if you create a webhook that subscribes to updates to Activities and provide "price" as the field parameter value, the first time an Activity is updated after the Webhook is live will trigger a webhook event – even if the price hasn't changed. Subsequent webhook events for that Activity will only be sent when the price field changes.
Note that there is a hard limit to the size of the fields
parameter. Any request containing a fields
size over 1000 characters will be rejected.
Tip: Use the minimum set of fields to reduce how frequently your endpoint is hit.
As mentioned previously, almost all models support the created, updated, and deleted events. Some models also support events specific to their life cycle.
created
is fired whenever a payment is createdupdated
is fired whenever a payment is updatedcreated
is fired whenever a model is createdupdated
is fired whenever a model is updateddeleted
is fired whenever a model is deletedmatter_opened
is fired whenever a matter's status changes to "Open"matter_pended
is fired whenever a matter's status changes to "Pending"matter_closed
is fired whenever a matter's status changes to "Close"More model-specific events will be coming soon.
A response status code of 2xx
, 3xx
, or 410 GONE
indicate that the action was successfully processed. When a 410 GONE
response is received, the webhook subscription will be disabled. All other responses will be considered unsuccessful, and they will be retried using an exponential backoff strategy.
Clio will wait a short period of time before the request will timeout. We will consider it an unsuccessful response and retry using an exponential backoff strategy. It is important to respond quickly. Failure to do so repeatedly may result in your webhook being disabled. If you need to do lengthy processing with the webhook, it is recommended that you defer the processing until after you have sent a response back to Clio.
To ensure that a URL actually intends to receive webhooks from Clio, and to ensure that the payloads are actually from Clio, we will share a secret in the initial handshake.
A POST request will be made immediately after a webhook is setup, or whenever the URL changes. This request will have a unique secret in a X-Hook-Secret
header along with the id of the webhook that was just created. There are two ways of confirming the webhook using this secret:
Upon initially receiving this secret, the endpoint can return a 200 OK
response and include the same secret in a X-Hook-Secret
header.
After receiving the secret, make a PUT request to /api/v4/webhooks/:webhook_id/activate
with the secret in a X-Hook-Secret
header.
Note that a webhook will not be enabled until this handshake is successful.
To prove that Clio is sending all subsequent messages, Clio will sign all of the requests.
Clio will compute an HMAC-SHA256 signature based on the shared secret and the request body. That signature will then be placed in a X-Hook-Signature
header. The endpoint can then verify the signature to know if the message is authentic. Verification is as simple as computing an HMAC-SHA256 signature using the shared secret as the key and the request body as the message, and comparing it to the X-Hook-Signature
header.
A Webhook can be created for the Activities model, to trigger on any events and return the id and etag fields:
{
"data":{
"url":"https://my/callback/url",
"fields":"id,etag",
"model":"activity",
"events":["created","deleted","updated"]
}
}
This webhook would have the following responses for different actions. It would trigger on any events for the model, and return the id and etag fields for that model, and the event type.
Notes:
model
field accepts both the string identifier of the model as in the example, or its ID. In the latter case, you would have provided the ID parameter: "model":2
. Refer to the table listing the models supported by webhooks for matching the model name with its ID.In the event of an Activity being created, your URL would receive the following JSON:
{
"data":{
"id":152,
"etag":"\"9a103be2201ae758992733a91f02903f\""
},
"meta":{
"event":"created",
"webhook_id":1234
}
}
In the event of an Activity being updated, your URL would receive the following JSON:
{
"data":{
"id":152,
"etag":"\"9d9ef9fb42a505976d90d564c1596f11\""
},
"meta":{
"event":"updated",
"webhook_id":1234
}
}
In the event of an Activity being deleted, your URL would receive the following JSON:
{
"data":{
"id":152,
"etag":"\"3cc31bfbd6cfc16d3d7123423e437079\""
},
"meta":{
"event":"deleted",
"webhook_id":1234
}
}
Outlines the parameters, optional and required, used when requesting the data for all Webhooks
created_since | string <date-time> Filter Webhook records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Webhook records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Webhook records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" Orders the Webhook records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter Webhook records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "url": "string",
- "fields": "string",
- "shared_secret": "string",
- "model": "activity",
- "status": "pending",
- "events": [
- "created"
], - "expires_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new Webhook
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Webhooks
required | object | ||||||||||
|
{- "data": {
- "events": [
- "created"
], - "expires_at": "2019-08-24T14:15:22Z",
- "fields": "string",
- "model": "activity",
- "url": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "url": "string",
- "fields": "string",
- "shared_secret": "string",
- "model": "activity",
- "status": "pending",
- "events": [
- "created"
], - "expires_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Webhook
id required | integer <int64> The unique identifier for the Webhook. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "url": "string",
- "fields": "string",
- "shared_secret": "string",
- "model": "activity",
- "status": "pending",
- "events": [
- "created"
], - "expires_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single Webhook
id required | integer <int64> The unique identifier for the Webhook. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Webhooks
required | object | ||||||||||
|
{- "data": {
- "events": [
- "created"
], - "expires_at": "2019-08-24T14:15:22Z",
- "fields": "string",
- "model": "activity",
- "url": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "url": "string",
- "fields": "string",
- "shared_secret": "string",
- "model": "activity",
- "status": "pending",
- "events": [
- "created"
], - "expires_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Webhook
id required | integer <int64> The unique identifier for the Webhook. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Activities (Time Entries and Expense Entries) track work done at a firm. Activities are recorded in Clio and then posted on bills to clients.
Time Entries can be either be hourly-billable or flat-rate. An hourly-billable Time Entry is valued at the billing rate multiplied by the time entered. Examples could be a phone call, or a research session. A flat-rate Time Entry has a set value. Examples could be a visa application, or a contract review.
Expenses are reimbursable costs the firm pays on behalf of a client (for example, postage, copy fees, etc.).
Outlines the parameters, optional and required, used when requesting the data for all Activities
activity_description_id | integer <int64> The unique identifier for a single ActivityDescription. Use the keyword |
calendar_entry_id | integer <int64> The unique identifier for a single CalendarEntry. Use the keyword |
communication_id | integer <int64> The unique identifier for a single Communication. Use the keyword |
contact_note_id | integer <int64> The unique identifier for a single Note. Use the keyword |
created_since | string <date-time> Filter Activity records to those having the |
end_date | string <date-time> Filter Activity records to those whose |
expense_category_id | integer <int64> The unique identifier for a single ExpenseCategory. Use the keyword |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
flat_rate | boolean Filter Activity TimeEntry records to those that have a flat rate, or not. |
grant_id | integer <int64> The unique identifier for a single Grant. Use the keyword |
ids[] | integer <int64> Filter Activity records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Activity records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
matter_note_id | integer <int64> The unique identifier for a single Note. Use the keyword |
only_unaccounted_for | boolean Only unaccounted for activities. |
order | string Enum: "id(asc)" "id(desc)" "display_number(asc)" "display_number(desc)" "user.name(asc)" "user.name(desc)" "price(asc)" "price(desc)" "total(asc)" "total(desc)" "type(asc)" "type(desc)" "date(asc)" "date(desc)" "note(asc)" "note(desc)" "updated_at(asc)" "updated_at(desc)" "vendor.name(asc)" "vendor.name(desc)" "expense_category.name(asc)" "expense_category.name(desc)" "non_billable(asc)" "non_billable(desc)" "non_billable_total(asc)" "non_billable_total(desc)" Orders the Activity records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
start_date | string <date-time> Filter Activity records to those whose |
status | string Enum: "billed" "draft" "unbilled" "non_billable" "billable" "written_off" Filter Activity records to those that are draft, billed, unbilled or non-billable. |
task_id | integer <int64> The unique identifier for a single Task. Use the keyword |
type | string Enum: "TimeEntry" "ExpenseEntry" "HardCostEntry" "SoftCostEntry" Filter Activity records to those of a specific type. |
updated_since | string <date-time> Filter Activity records to those having the |
user_id | integer <int64> The unique identifier for a single User. Use the keyword |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": { }
}, - "expense_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": { }
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "communication": {
- "id": 0,
- "etag": "string",
- "subject": "string",
- "body": "string",
- "type": "EmailCommunication",
- "date": "2019-08-24",
- "time_entries_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "received_at": "2019-08-24T14:15:22Z"
}, - "client_portal": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unread_count": 0,
- "unread_notifiable_count": 0
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "matter_note": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "contact_note": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "subject": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}, - "timer": {
- "id": 0,
- "etag": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "elapsed_time": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "utbms_expense": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "vendor": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "calendar_entry": {
- "id": "string",
- "etag": "string",
- "calendar_owner_id": 0
}, - "task": {
- "id": 0,
- "etag": "string"
}, - "text_message_conversation": {
- "id": 0,
- "etag": "string"
}, - "document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}, - "legal_aid_uk_activity": {
- "activity_sub_category": "string",
- "advocacy": 0,
- "base_rate": 0.1,
- "bolt_ons": "string",
- "bolt_ons_summary": "string",
- "court": 0,
- "eligible_for_sqm": true,
- "expert": 0,
- "form_of_civil_legal_service": 0,
- "id": 0,
- "is_custom_rate": true,
- "json_key": "string",
- "region": 0,
- "tax_exclusive": true,
- "uplift": 0.1,
- "user_type": 0
}
}
]
}
Outlines the parameters and data fields used when creating a new Activity
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Activities
required | object | ||||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "activity_description": {
- "id": 0,
- "utbms_task_id": 0,
- "utbms_activity_id": 0
}, - "calendar_entry": {
- "id": 0
}, - "client_portal": {
- "id": 0
}, - "communication": {
- "id": 0
}, - "contact_note": {
- "id": 0
}, - "date": "2019-08-24",
- "expense_category": {
- "id": 0
}, - "matter": {
- "id": 0
}, - "matter_note": {
- "id": 0
}, - "no_charge": true,
- "non_billable": true,
- "note": "string",
- "price": 0.1,
- "quantity": 0.1,
- "reference": "string",
- "start_timer": true,
- "task": {
- "id": 0
}, - "tax_setting": "no_tax",
- "text_message_conversation": {
- "id": 0
}, - "type": "TimeEntry",
- "user": {
- "id": 0
}, - "utbms_expense": {
- "id": 0
}, - "vendor": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": { }
}, - "expense_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": { }
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "communication": {
- "id": 0,
- "etag": "string",
- "subject": "string",
- "body": "string",
- "type": "EmailCommunication",
- "date": "2019-08-24",
- "time_entries_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "received_at": "2019-08-24T14:15:22Z"
}, - "client_portal": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unread_count": 0,
- "unread_notifiable_count": 0
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "matter_note": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "contact_note": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "subject": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}, - "timer": {
- "id": 0,
- "etag": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "elapsed_time": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "utbms_expense": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "vendor": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "calendar_entry": {
- "id": "string",
- "etag": "string",
- "calendar_owner_id": 0
}, - "task": {
- "id": 0,
- "etag": "string"
}, - "text_message_conversation": {
- "id": 0,
- "etag": "string"
}, - "document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}, - "legal_aid_uk_activity": {
- "activity_sub_category": "string",
- "advocacy": 0,
- "base_rate": 0.1,
- "bolt_ons": "string",
- "bolt_ons_summary": "string",
- "court": 0,
- "eligible_for_sqm": true,
- "expert": 0,
- "form_of_civil_legal_service": 0,
- "id": 0,
- "is_custom_rate": true,
- "json_key": "string",
- "region": 0,
- "tax_exclusive": true,
- "uplift": 0.1,
- "user_type": 0
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Activity
id required | integer <int64> The unique identifier for the Activity. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": { }
}, - "expense_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": { }
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "communication": {
- "id": 0,
- "etag": "string",
- "subject": "string",
- "body": "string",
- "type": "EmailCommunication",
- "date": "2019-08-24",
- "time_entries_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "received_at": "2019-08-24T14:15:22Z"
}, - "client_portal": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unread_count": 0,
- "unread_notifiable_count": 0
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "matter_note": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "contact_note": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "subject": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}, - "timer": {
- "id": 0,
- "etag": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "elapsed_time": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "utbms_expense": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "vendor": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "calendar_entry": {
- "id": "string",
- "etag": "string",
- "calendar_owner_id": 0
}, - "task": {
- "id": 0,
- "etag": "string"
}, - "text_message_conversation": {
- "id": 0,
- "etag": "string"
}, - "document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}, - "legal_aid_uk_activity": {
- "activity_sub_category": "string",
- "advocacy": 0,
- "base_rate": 0.1,
- "bolt_ons": "string",
- "bolt_ons_summary": "string",
- "court": 0,
- "eligible_for_sqm": true,
- "expert": 0,
- "form_of_civil_legal_service": 0,
- "id": 0,
- "is_custom_rate": true,
- "json_key": "string",
- "region": 0,
- "tax_exclusive": true,
- "uplift": 0.1,
- "user_type": 0
}
}
}
Outlines the parameters and data fields used when updating a single Activity
id required | integer <int64> The unique identifier for the Activity. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Activities
required | object | ||||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "activity_description": {
- "id": 0,
- "utbms_task_id": 0,
- "utbms_activity_id": 0
}, - "calendar_entry": {
- "id": 0
}, - "client_portal": {
- "id": 0
}, - "communication": {
- "id": 0
}, - "contact_note": {
- "id": 0
}, - "date": "2019-08-24",
- "expense_category": {
- "id": 0
}, - "matter": {
- "id": 0
}, - "matter_note": {
- "id": 0
}, - "no_charge": true,
- "non_billable": true,
- "note": "string",
- "price": 0.1,
- "quantity": 0.1,
- "reference": "string",
- "start_timer": true,
- "task": {
- "id": 0
}, - "tax_setting": "no_tax",
- "text_message_conversation": {
- "id": 0
}, - "type": "TimeEntry",
- "user": {
- "id": 0
}, - "utbms_expense": {
- "id": 0
}, - "vendor": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": { }
}, - "expense_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": { }
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "communication": {
- "id": 0,
- "etag": "string",
- "subject": "string",
- "body": "string",
- "type": "EmailCommunication",
- "date": "2019-08-24",
- "time_entries_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "received_at": "2019-08-24T14:15:22Z"
}, - "client_portal": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unread_count": 0,
- "unread_notifiable_count": 0
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "matter_note": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "contact_note": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "subject": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}, - "timer": {
- "id": 0,
- "etag": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "elapsed_time": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "utbms_expense": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "vendor": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "calendar_entry": {
- "id": "string",
- "etag": "string",
- "calendar_owner_id": 0
}, - "task": {
- "id": 0,
- "etag": "string"
}, - "text_message_conversation": {
- "id": 0,
- "etag": "string"
}, - "document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}, - "legal_aid_uk_activity": {
- "activity_sub_category": "string",
- "advocacy": 0,
- "base_rate": 0.1,
- "bolt_ons": "string",
- "bolt_ons_summary": "string",
- "court": 0,
- "eligible_for_sqm": true,
- "expert": 0,
- "form_of_civil_legal_service": 0,
- "id": 0,
- "is_custom_rate": true,
- "json_key": "string",
- "region": 0,
- "tax_exclusive": true,
- "uplift": 0.1,
- "user_type": 0
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Activity
id required | integer <int64> The unique identifier for the Activity. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Activity Descriptions are custom Time Entry templates. Activity Descriptions help firms expedite their process for recording Time Entries, and ensure that their Time Entry descriptions are consistent.
Outlines the parameters, optional and required, used when requesting the data for all ActivityDescriptions
created_since | string <date-time> Filter ActivityDescription records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
flat_rate | boolean Filter ActivityDescription records to those that have a flat rate, or not. |
ids[] | integer <int64> Filter ActivityDescription records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of ActivityDescription records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
rate_for[matter_id] | integer <int64> Matter id for rate calculation. |
rate_for[user_id] | integer <int64> User id for rate calculation. If not provided, the user associated to the API request is assumed. |
type | string Enum: "utbms" "clio" Filter ActivityDescription records to those of a specific type. |
updated_since | string <date-time> Filter ActivityDescription records to those having the |
user_id | integer <int64> The unique identifier for a single User. The keyword |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "rate": {
- "amount": 0.1,
- "non_billable_amount": 0.1,
- "type": "User",
- "hierarchy": "Default"
}, - "utbms_task": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "utbms_activity": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new ActivityDescription
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Activity Descriptions
required | object | ||||||||||||
|
{- "data": {
- "currency": { },
- "default": true,
- "groups": [
- {
- "id": 0
}
], - "name": "string",
- "rate": {
- "amount": 0,
- "non_billable_amount": 0,
- "type": "User"
}, - "visible_to_co_counsel": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "rate": {
- "amount": 0.1,
- "non_billable_amount": 0.1,
- "type": "User",
- "hierarchy": "Default"
}, - "utbms_task": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "utbms_activity": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single ActivityDescription
id required | integer <int64> The unique identifier for the ActivityDescription. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "rate": {
- "amount": 0.1,
- "non_billable_amount": 0.1,
- "type": "User",
- "hierarchy": "Default"
}, - "utbms_task": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "utbms_activity": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single ActivityDescription
id required | integer <int64> The unique identifier for the ActivityDescription. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Activity Descriptions
required | object | ||||||||||||
|
{- "data": {
- "currency": { },
- "default": true,
- "groups": [
- {
- "id": 0,
- "_deleted": true
}
], - "name": "string",
- "rate": {
- "amount": 0,
- "non_billable_amount": 0,
- "type": "User"
}, - "visible_to_co_counsel": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "rate": {
- "amount": 0.1,
- "non_billable_amount": 0.1,
- "type": "User",
- "hierarchy": "Default"
}, - "utbms_task": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "utbms_activity": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single ActivityDescription
id required | integer <int64> The unique identifier for the ActivityDescription. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all ActivityRates
co_counsel_contact_id | integer <int64> The unique identifier for a single Contact. The keyword |
contact_id | integer <int64> The unique identifier for a single Contact. The keyword |
created_since | string <date-time> Filter ActivityRate records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter ActivityRate records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of ActivityRate records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter ActivityRate records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0,
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new ActivityRate
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Activity Rates
required | object | ||||||||
|
{- "data": {
- "co_counsel_contact_id": 0,
- "contact_id": 0,
- "flat_rate": true,
- "rate": 0.1
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0,
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single ActivityRate
id required | integer <int64> The unique identifier for the ActivityRate. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0,
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single ActivityRate
id required | integer <int64> The unique identifier for the ActivityRate. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Activity Rates
required | object | ||||||||
|
{- "data": {
- "co_counsel_contact_id": 0,
- "contact_id": 0,
- "flat_rate": true,
- "rate": 0.1
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0,
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single ActivityRate
id required | integer <int64> The unique identifier for the ActivityRate. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
This endpoint provides the Legal Aid expense category rates, which are the prescribed reimbursement rates for legal services provided under the Legal Aid Scheme.
Outlines the parameters, optional and required, used when requesting the data for all ExpenseCategories
created_since | string <date-time> Filter ExpenseCategory records to those having the |
entry_type | string Enum: "hard_cost" "soft_cost" "unassociated" Filter ExpenseCategory records to those that match the given type. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
limit | integer <int32> A limit on the number of ExpenseCategory records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" "rate(asc)" "rate(desc)" "entry_type(asc)" "entry_type(desc)" Orders the ExpenseCategory records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Allows matching search on expense category name. |
updated_since | string <date-time> Filter ExpenseCategory records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "utbms_code": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new ExpenseCategory
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Expense Categories
required | object | ||||||||||||
|
{- "data": {
- "currency": { },
- "entry_type": "hard_cost",
- "groups": [
- {
- "id": 0,
- "_deleted": true
}
], - "name": "string",
- "rate": 0.1,
- "utbms_code": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "utbms_code": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single ExpenseCategory
id required | integer <int64> The unique identifier for the ExpenseCategory. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "utbms_code": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single ExpenseCategory
id required | integer <int64> The unique identifier for the ExpenseCategory. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Expense Categories
required | object | ||||||||||||
|
{- "data": {
- "currency": { },
- "entry_type": "hard_cost",
- "groups": [
- {
- "id": 0,
- "_deleted": true
}
], - "name": "string",
- "rate": 0.1,
- "utbms_code": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "utbms_code": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single ExpenseCategory
id required | integer <int64> The unique identifier for the ExpenseCategory. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all LaukExpenseCategories
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
key | string Filter by key. |
limit | integer <int32> A limit on the number of LaukExpenseCategory records to be returned. Limit can range between 1 and 200. Default: |
name | string Filter by expense name. |
page_token | string A token specifying which page to return. |
practice_area | string Filter by expense practice area. |
region required | string Sets the expense rate returned based on the region. If the region is set to London, it will return the London rate; otherwise, it will return the non-London rate. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "certificated": true,
- "civil": true,
- "created_at": "2019-08-24T14:15:22Z",
- "criminal": true,
- "etag": "string",
- "id": 0,
- "key": "string",
- "name": "string",
- "rate": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Timers are used to track time spent on billable work. They are used with hourly-billable Time Entries.
The Timer modal is accessed by clicking the timer in the application's header, or by clicking the Timer icon on a Time Entry.
Used within Clio in the timer modal which can be accessed by clicking the timer in the header or on the create/edit Time Entry form.
Outlines the parameters, optional and required, used when requesting the data for a single Timer
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "elapsed_time": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "activity": {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Timer
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters and data fields used when creating a new Timer
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Timers
required | object | ||||||
|
{- "data": {
- "activity": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "elapsed_time": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "activity": {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
}
}
UTBMS codes standardize Time and Expense entries across the legal profession. Clio users can enter their Activities using UTBMS codes in order to provide electronic invoices.
Outlines the parameters, optional and required, used when requesting the data for all UtbmsCodes
created_since | string <date-time> Filter UtbmsCode records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter UtbmsCode records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of UtbmsCode records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "name(asc)" "name(desc)" "id(asc)" "id(desc)" "set(asc)" "set(desc)" Orders the UtbmsCode records by the given field. Default: |
page_token | string A token specifying which page to return. |
type | string Enum: "UtbmsTask" "UtbmsActivity" "UtbmsExpense" Filter UtbmsCode records to those of a given type. |
updated_since | string <date-time> Filter UtbmsCode records to those having the |
utbms_set_id | integer <int64> The unique identifier for a single UtbmsSet. Use the keyword |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single UtbmsCode
id required | integer <int64> The unique identifier for the UtbmsCode. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
UTBMS codes are divided into code sets. Each set includes Activities relevant to a certain type of law (for example, litigation, bankruptcy, etc.). Clio users can enable one or more of these sets in the UTBMS settings menu. Enabling a UTBMS code set means that users will be able to select Activities from that list when adding Time or Expense Entries into Clio.
Outlines the parameters, optional and required, used when requesting the data for all UtbmsSets
created_since | string <date-time> Filter UtbmsSet records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter UtbmsSet records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of UtbmsSet records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "name(asc)" "name(desc)" "id(asc)" "id(desc)" Orders the UtbmsSet records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter UtbmsSet records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "enabled": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
These accounts are meant to mirror the firm’s accounts at their financial institution. Users can add a bank account to Clio to use with Clio Payments, and for use as an audit and reconciliation tool.
Outlines the parameters, optional and required, used when requesting the data for all BankAccounts
created_since | string <date-time> Filter BankAccount records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter BankAccount records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of BankAccount records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" "institution(asc)" "institution(desc)" "account_number(asc)" "account_number(desc)" "transit_number(asc)" "transit_number(desc)" "currency(asc)" "currency(desc)" "updated_at(asc)" "updated_at(desc)" "type(asc)" "type(desc)" Orders the BankAccount records by the given field. Default: |
page_token | string A token specifying which page to return. |
show_empty_accounts | boolean Filter BankAccount records to those having a zero or non zero balance. |
type | string Enum: "OperatingAccount" "TrustAccount" Filter BankAccount records to those having a specific type. |
updated_since | string <date-time> Filter BankAccount records to those having the |
user_id | integer <int64> The unique identifier for a single User. Use the keyword |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new BankAccount
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Bank Accounts
required | object | ||||||||||||||||||||||||||
|
{- "data": {
- "account_number": "string",
- "balance": 0.1,
- "controlled_account": true,
- "currency": "string",
- "default_account": true,
- "domicile_branch": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating"
}
}
{- "data": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single BankAccount
id required | integer <int64> The unique identifier for the BankAccount. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single BankAccount
id required | integer <int64> The unique identifier for the BankAccount. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Bank Accounts
required | object | ||||||||||||||||||||||
|
{- "data": {
- "account_number": "string",
- "controlled_account": true,
- "currency": "string",
- "default_account": true,
- "domicile_branch": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string"
}
}
{- "data": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single BankAccount
id required | integer <int64> The unique identifier for the BankAccount. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all BankTransactions
bank_account_id | integer <int64> The unique identifier for a single BankAccount. The keyword |
client_id | integer <int64> The unique identifier for a single Contact. The keyword |
created_since | string <date-time> Filter BankTransaction records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter BankTransaction records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of BankTransaction records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. The keyword |
order | string Orders the BankTransaction records by the given field. Default: |
page_token | string A token specifying which page to return. |
type | string Enum: "asset" "liability" Filter BankTransaction records to those having a specific type. |
updated_since | string <date-time> Filter BankTransaction records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "type": "string",
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "bank_account_id": 0,
- "source": "string",
- "confirmation": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "currency": "string",
- "currency_id": 0,
- "description": "string",
- "exchange_rate": 0.1,
- "transaction_type": "string",
- "funds_in": 0.1,
- "funds_out": 0.1,
- "clio_payments_transaction": true,
- "current_account_balance": 0.1,
- "read_only_confirmation": true,
- "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "allocation": {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "interest": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "has_online_payment": true,
- "destroyable": true,
- "payment_type": "string"
}
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single BankTransaction
id required | integer <int64> The unique identifier for the BankTransaction. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "type": "string",
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "bank_account_id": 0,
- "source": "string",
- "confirmation": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "currency": "string",
- "currency_id": 0,
- "description": "string",
- "exchange_rate": 0.1,
- "transaction_type": "string",
- "funds_in": 0.1,
- "funds_out": 0.1,
- "clio_payments_transaction": true,
- "current_account_balance": 0.1,
- "read_only_confirmation": true,
- "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "allocation": {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "interest": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "has_online_payment": true,
- "destroyable": true,
- "payment_type": "string"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single BankTransfer
id required | integer <int64> The unique identifier for the BankTransfer. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "amount": 0.1,
- "date": "2019-08-24T14:15:22Z",
- "description": "string",
- "primary_authorizer": "string",
- "secondary_authorizer": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "source_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Bills are statements of what a user’s client owes for their services over a particular billing period, including legal fees, expenses, and taxes.
Users customize, preview, edit, and approve bills before sending them to a client.
This endpoint returns a pre-rendered HTML object that you can use to view a preview of your bills. The HTML provided contains all of the CSS rules it requires to show the bill correctly, as well as the DOCTYPE setting it requires. It's best to use an iframe, or similar object, to render the results of this endpoint.
id required | integer <int64> The unique identifier for the Bill. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all Bills
client_id | integer <int64> The unique identifier for a single Contact. The keyword |
created_since | string <date-time> Filter Bill records to those having the |
currency_id | integer <int64> Filter Bill records to those of a specific currency. |
custom_field_values | string Enum: "=" "<" ">" "<=" ">=" 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. Supported operators:
e.g.
e.g.
e.g. 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. |
due_after | string <date> Filter Bill records to those that have a |
due_at | string <date> Filter Bill records to those that have a specific |
due_before | string <date> Filter Bill records to those that have a |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Bill records to those having the specified unique identifiers. |
issued_after | string <date> Filter Bill records to those that have an |
issued_before | string <date> Filter Bill records to those that have an |
last_sent_end_date | string <date> Filter Bill records for those whose bills have been sent before the specified date |
last_sent_start_date | string <date> Filter Bill records for those whose bills have been sent after the specified date |
limit | integer <int32> A limit on the number of Bill records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
order | string Enum: "id(asc)" "id(desc)" "due_at(asc)" "due_at(desc)" "issued_at(asc)" "issued_at(desc)" "paid_at(asc)" "paid_at(desc)" "last_sent_at(asc)" "last_sent_at(desc)" "client_name(asc)" "client_name(desc)" "matter_display_number(asc)" "matter_display_number(desc)" "balance(asc)" "balance(desc)" "number(asc)" "number(desc)" Orders the Bill records by the given field. Default: |
originating_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
overdue_only | boolean Filter Bill records to those that are overdue. |
page_token | string A token specifying which page to return. |
query | integer <int32> Allows matching search on invoice number. |
responsible_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
state | string Enum: "draft" "awaiting_approval" "awaiting_payment" "paid" "void" "deleted" Filter Bill records to those in a given state. |
status | string Enum: "all" "overdue" Filter Bill records to those with particular payment status. |
type | string Enum: "revenue" "trust" Filter Bill records to those of a specific type. |
updated_since | string <date-time> Filter Bill records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
], - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "discount": {
- "rate": 0.1,
- "type": "percentage",
- "note": "string",
- "early_payment_rate": 0,
- "early_payment_period": 0
}, - "interest": {
- "balance": 0.1,
- "period": 0,
- "rate": 0.1,
- "total": 0.1,
- "type": "simple"
}, - "matters": [
- {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
], - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "bill_theme": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "account_id": 0,
- "default": true,
- "name": "string",
- "config": "string"
}, - "original_bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "balances": [
- {
- "id": 0,
- "amount": 0.1,
- "type": "Matter",
- "interest_amount": 0.1,
- "due": 0.1
}
], - "matter_totals": [
- {
- "id": 0,
- "amount": 0.1
}
], - "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "billing_setting": {
- "id": 0,
- "etag": "string",
- "rounded_duration": 0.1,
- "rounding": 0,
- "use_decimal_rounding": true,
- "currency": "string",
- "currency_sign": "string",
- "tax_rate": 0.1,
- "tax_name": "string",
- "apply_tax_by_default": true,
- "time_on_flat_rate_contingency_matters_is_non_billable": true,
- "use_secondary_tax": true,
- "secondary_tax_rate": 0.1,
- "secondary_tax_rule": "Pre",
- "secondary_tax_name": "string",
- "notify_after_bill_created": true,
- "use_utbms_codes": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "multi_currency_billing": true,
- "billing_currencies": [
- { }
]
}, - "client_addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "legal_aid_uk_bill": {
- "additional_travel_payment": true,
- "adjourned_hearing_fee": "string",
- "advocacy_costs": 0.1,
- "advice_time": 0,
- "bill_type": 0,
- "case_concluded": "2019-08-24",
- "case_stage_level": 0,
- "cla_exemption_code": "string",
- "cla_reference": "string",
- "cmrh_oral": 0,
- "cmrh_telephone": 0,
- "cost_of_counsel": "string",
- "costs_are_those_of": 0,
- "court_location": "string",
- "date_of_claim": "2019-08-24",
- "designated_accredited_representative": 0,
- "detention_travel_and_waiting_costs": "string",
- "disbursements_vat": 0.1,
- "exceptional_case_funding_reference": "string",
- "exemption_criteria_satisfied": 0,
- "follow_on_work": 0,
- "ho_interview": 0,
- "ho_ucn": 0,
- "id": 0,
- "independent_medical_reports_claimed": "string",
- "jr_form_filling": "string",
- "maat_id": "string",
- "meetings_attended": 0,
- "mht_ref_no": "string",
- "net_disbursements": 0.1,
- "net_profit_costs": 0.1,
- "niat_disbursement_prior_authority_number": "string",
- "number_of_attendances": 0,
- "outcome_for_the_client": 0,
- "profit_costs_ex_vat": 0,
- "prior_authority_reference": "string",
- "representation_order_date": "2019-08-24",
- "stage_reached": 0,
- "substantive_hearing": 0,
- "travel_and_waiting_costs": 0.1,
- "travel_time": 0,
- "value_of_costs": "string",
- "waiting_time": 0
}, - "split_invoice": {
- "id": 0,
- "bill_id": 0,
- "linked_invoices_display_numbers": [
- "string"
], - "linked_invoices_ids": [
- 0
], - "split_connection_id": "string",
- "split_portion": 0.1,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single Bill
id required | integer <int64> The unique identifier for the Bill. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
navigation.next | integer <int32> The id of the next Bill available for viewing |
navigation.previous | integer <int32> The id of the previous Bill available for viewing |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
], - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "discount": {
- "rate": 0.1,
- "type": "percentage",
- "note": "string",
- "early_payment_rate": 0,
- "early_payment_period": 0
}, - "interest": {
- "balance": 0.1,
- "period": 0,
- "rate": 0.1,
- "total": 0.1,
- "type": "simple"
}, - "matters": [
- {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
], - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "bill_theme": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "account_id": 0,
- "default": true,
- "name": "string",
- "config": "string"
}, - "original_bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "balances": [
- {
- "id": 0,
- "amount": 0.1,
- "type": "Matter",
- "interest_amount": 0.1,
- "due": 0.1
}
], - "matter_totals": [
- {
- "id": 0,
- "amount": 0.1
}
], - "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "billing_setting": {
- "id": 0,
- "etag": "string",
- "rounded_duration": 0.1,
- "rounding": 0,
- "use_decimal_rounding": true,
- "currency": "string",
- "currency_sign": "string",
- "tax_rate": 0.1,
- "tax_name": "string",
- "apply_tax_by_default": true,
- "time_on_flat_rate_contingency_matters_is_non_billable": true,
- "use_secondary_tax": true,
- "secondary_tax_rate": 0.1,
- "secondary_tax_rule": "Pre",
- "secondary_tax_name": "string",
- "notify_after_bill_created": true,
- "use_utbms_codes": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "multi_currency_billing": true,
- "billing_currencies": [
- { }
]
}, - "client_addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "legal_aid_uk_bill": {
- "additional_travel_payment": true,
- "adjourned_hearing_fee": "string",
- "advocacy_costs": 0.1,
- "advice_time": 0,
- "bill_type": 0,
- "case_concluded": "2019-08-24",
- "case_stage_level": 0,
- "cla_exemption_code": "string",
- "cla_reference": "string",
- "cmrh_oral": 0,
- "cmrh_telephone": 0,
- "cost_of_counsel": "string",
- "costs_are_those_of": 0,
- "court_location": "string",
- "date_of_claim": "2019-08-24",
- "designated_accredited_representative": 0,
- "detention_travel_and_waiting_costs": "string",
- "disbursements_vat": 0.1,
- "exceptional_case_funding_reference": "string",
- "exemption_criteria_satisfied": 0,
- "follow_on_work": 0,
- "ho_interview": 0,
- "ho_ucn": 0,
- "id": 0,
- "independent_medical_reports_claimed": "string",
- "jr_form_filling": "string",
- "maat_id": "string",
- "meetings_attended": 0,
- "mht_ref_no": "string",
- "net_disbursements": 0.1,
- "net_profit_costs": 0.1,
- "niat_disbursement_prior_authority_number": "string",
- "number_of_attendances": 0,
- "outcome_for_the_client": 0,
- "profit_costs_ex_vat": 0,
- "prior_authority_reference": "string",
- "representation_order_date": "2019-08-24",
- "stage_reached": 0,
- "substantive_hearing": 0,
- "travel_and_waiting_costs": 0.1,
- "travel_time": 0,
- "value_of_costs": "string",
- "waiting_time": 0
}, - "split_invoice": {
- "id": 0,
- "bill_id": 0,
- "linked_invoices_display_numbers": [
- "string"
], - "linked_invoices_ids": [
- 0
], - "split_connection_id": "string",
- "split_portion": 0.1,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single Bill
id required | integer <int64> The unique identifier for the Bill. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Bills
required | object | ||||||||||||||||||||||||||||
|
{- "data": {
- "bill_theme": {
- "id": 0
}, - "currency_id": 0,
- "discount": {
- "rate": 0.1,
- "type": "percentage",
- "note": "string"
}, - "due_at": "2019-08-24",
- "interest": {
- "rate": 0.1,
- "type": "simple",
- "period": 0
}, - "issued_at": "2019-08-24",
- "memo": "string",
- "number": "string",
- "purchase_order": "string",
- "secondary_tax_rate": 0.1,
- "state": "draft",
- "subject": "string",
- "tax_rate": 0.1,
- "use_grace_period": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
], - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "discount": {
- "rate": 0.1,
- "type": "percentage",
- "note": "string",
- "early_payment_rate": 0,
- "early_payment_period": 0
}, - "interest": {
- "balance": 0.1,
- "period": 0,
- "rate": 0.1,
- "total": 0.1,
- "type": "simple"
}, - "matters": [
- {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
], - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "bill_theme": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "account_id": 0,
- "default": true,
- "name": "string",
- "config": "string"
}, - "original_bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "balances": [
- {
- "id": 0,
- "amount": 0.1,
- "type": "Matter",
- "interest_amount": 0.1,
- "due": 0.1
}
], - "matter_totals": [
- {
- "id": 0,
- "amount": 0.1
}
], - "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "billing_setting": {
- "id": 0,
- "etag": "string",
- "rounded_duration": 0.1,
- "rounding": 0,
- "use_decimal_rounding": true,
- "currency": "string",
- "currency_sign": "string",
- "tax_rate": 0.1,
- "tax_name": "string",
- "apply_tax_by_default": true,
- "time_on_flat_rate_contingency_matters_is_non_billable": true,
- "use_secondary_tax": true,
- "secondary_tax_rate": 0.1,
- "secondary_tax_rule": "Pre",
- "secondary_tax_name": "string",
- "notify_after_bill_created": true,
- "use_utbms_codes": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "multi_currency_billing": true,
- "billing_currencies": [
- { }
]
}, - "client_addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "legal_aid_uk_bill": {
- "additional_travel_payment": true,
- "adjourned_hearing_fee": "string",
- "advocacy_costs": 0.1,
- "advice_time": 0,
- "bill_type": 0,
- "case_concluded": "2019-08-24",
- "case_stage_level": 0,
- "cla_exemption_code": "string",
- "cla_reference": "string",
- "cmrh_oral": 0,
- "cmrh_telephone": 0,
- "cost_of_counsel": "string",
- "costs_are_those_of": 0,
- "court_location": "string",
- "date_of_claim": "2019-08-24",
- "designated_accredited_representative": 0,
- "detention_travel_and_waiting_costs": "string",
- "disbursements_vat": 0.1,
- "exceptional_case_funding_reference": "string",
- "exemption_criteria_satisfied": 0,
- "follow_on_work": 0,
- "ho_interview": 0,
- "ho_ucn": 0,
- "id": 0,
- "independent_medical_reports_claimed": "string",
- "jr_form_filling": "string",
- "maat_id": "string",
- "meetings_attended": 0,
- "mht_ref_no": "string",
- "net_disbursements": 0.1,
- "net_profit_costs": 0.1,
- "niat_disbursement_prior_authority_number": "string",
- "number_of_attendances": 0,
- "outcome_for_the_client": 0,
- "profit_costs_ex_vat": 0,
- "prior_authority_reference": "string",
- "representation_order_date": "2019-08-24",
- "stage_reached": 0,
- "substantive_hearing": 0,
- "travel_and_waiting_costs": 0.1,
- "travel_time": 0,
- "value_of_costs": "string",
- "waiting_time": 0
}, - "split_invoice": {
- "id": 0,
- "bill_id": 0,
- "linked_invoices_display_numbers": [
- "string"
], - "linked_invoices_ids": [
- 0
], - "split_connection_id": "string",
- "split_portion": 0.1,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
This endpoint will transition a bill to either its deleted or voided state. A bill can only be deleted or voided if it has no payments recorded and its current state is one of the following:
A bill will automatically be moved to a deleted or void state based on its current state. The mappings for this are:
id required | integer <int64> The unique identifier for the Bill. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Users can view all Billable Clients, or clients with outstanding Bills, on the Billable Clients page, located under the Bills tab.
Outlines the parameters, optional and required, used when requesting the data for all BillableClients
client_id | integer <int64> The unique identifier for a single Contact. The keyword |
custom_field_values | string Enum: "=" "<" ">" "<=" ">=" 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. Supported operators:
e.g.
e.g.
e.g. 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. |
end_date | string <date> Filter BillableClient records to those that have Matters with unbilled Activities on or before this date (Expects an ISO-8601 date). |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
limit | integer <int32> A limit on the number of BillableClient records to be returned. Limit can range between 1 and 25. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. The keyword |
originating_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
responsible_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
start_date | string <date> Filter BillableClient records to those that have Matters with unbilled Activities on or after this date (Expects an ISO-8601 date). |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "unbilled_hours": 0.1,
- "unbilled_amount": 0.1,
- "amount_in_trust": 0.1,
- "name": "string",
- "billable_matters_count": 0,
- "billable_matters": [
- {
- "currency_code": "string",
- "currency_id": 0,
- "id": 0,
- "unbilled_hours": 0.1,
- "unbilled_amount": 0.1,
- "amount_in_trust": 0.1,
- "display_number": "string"
}
]
}
]
}
Users can see all Matters with outstanding bills attached to them by filtering out all non-billable Matters under the Matters tab.
Users can disable billing for certain Matters. They can still enter Activities on these Matters, but those Activities will not appear in the Bills page.
This data is retrieved asynchronously
client_id | integer <int64> The unique identifier for a single Contact. The keyword |
custom_field_values | string Enum: "=" "<" ">" "<=" ">=" 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. Supported operators:
e.g.
e.g.
e.g. 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. |
end_date | string <date> Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date). |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
limit | integer <int32> A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. The keyword |
originating_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
responsible_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
start_date | string <date> Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date). |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "currency_code": "string",
- "currency_id": 0,
- "id": 0,
- "unbilled_hours": 0.1,
- "unbilled_amount": 0.1,
- "amount_in_trust": 0.1,
- "display_number": "string",
- "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
}
Outlines the parameters, optional and required, used when requesting the data for all BillableMatters
client_id | integer <int64> The unique identifier for a single Contact. The keyword |
custom_field_values | string Enum: "=" "<" ">" "<=" ">=" 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. Supported operators:
e.g.
e.g.
e.g. 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. |
end_date | string <date> Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date). |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
limit | integer <int32> A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. The keyword |
originating_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
responsible_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
start_date | string <date> Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date). |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "currency_code": "string",
- "currency_id": 0,
- "id": 0,
- "unbilled_hours": 0.1,
- "unbilled_amount": 0.1,
- "amount_in_trust": 0.1,
- "display_number": "string",
- "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
]
}
Outlines the parameters, optional and required, used when requesting the data for all BillThemes
created_since | string <date-time> Filter BillTheme records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter BillTheme records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of BillTheme records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter BillTheme records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "account_id": 0,
- "default": true,
- "name": "string",
- "config": "string"
}
]
}
Outlines the parameters and data fields used when updating a single BillTheme
id required | integer <int64> The unique identifier for the BillTheme. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Bill Themes
required | object | ||||
|
{- "data": {
- "config": "string",
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "account_id": 0,
- "default": true,
- "name": "string",
- "config": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all InterestCharges
bill_id | integer <int64> The unique identifier for a single Bill. The keyword |
created_since | string <date-time> Filter InterestCharge records to those having the |
exclude_ids[] | integer <int64> Array containing InterestCharge identifiers that should be excluded from the query. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter InterestCharge records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of InterestCharge records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter InterestCharge records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "description": "string",
- "total": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "balances": [
- {
- "id": 0,
- "amount": 0.1,
- "type": "Matter",
- "interest_amount": 0.1,
- "due": 0.1
}
], - "matters": [
- {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters, optional and required, used when deleting the record for a single InterestCharge
id required | integer <int64> The unique identifier for the InterestCharge. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all LineItems
activity_id | integer <int64> The unique identifier for a single Activity. Use the keyword |
bill_id | integer <int64> The unique identifier for a single Bill. The keyword |
created_since | string <date-time> Filter LineItem records to those having the |
display | boolean Set this flag to true to return only LineItems displayed on the bill. |
exclude_ids[] | integer <int64> Array containing LineItem identifiers that should be excluded from the query. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
group_ordering | integer <int32> Filters LineItem records to match given group ordering. |
ids[] | integer <int64> Filter LineItem records to those having the specified unique identifiers. |
kind | string The kind of LineItem. |
limit | integer <int32> A limit on the number of LineItem records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
updated_since | string <date-time> Filter LineItem records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "type": "ActivityLineItem",
- "description": "string",
- "date": "2019-08-24",
- "price": 0.1,
- "taxable": true,
- "kind": "Service",
- "note": "string",
- "secondary_taxable": true,
- "total": 0.1,
- "tax": 0.1,
- "secondary_tax": 0.1,
- "sub_total": 0.1,
- "quantity": 0.1,
- "group_ordering": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "activity": {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "discount": {
- "rate": 0.1,
- "type": "percentage",
- "note": "string",
- "early_payment_rate": 0,
- "early_payment_period": 0
}, - "included_line_item_totals": {
- "quantity": 0.1,
- "price": 0.1,
- "discount_percent": 0.1,
- "total": 0.1,
- "sub_total": 0.1
}
}
]
}
Outlines the parameters and data fields used when updating a single LineItem
id required | integer <int64> The unique identifier for the LineItem. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Line Items
required | object | ||||||||||||||||||||||||||||
|
{- "data": {
- "activity": {
- "id": 0
}, - "bill": {
- "id": 0
}, - "date": "2019-08-24",
- "description": "string",
- "discount": {
- "rate": 0.1,
- "type": true
}, - "group_ordering": 0,
- "kind": "Expense",
- "matter": {
- "id": 0
}, - "note": "string",
- "price": 0.1,
- "quantity": 0.1,
- "secondary_taxable": true,
- "taxable": true,
- "update_original_record": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "ActivityLineItem",
- "description": "string",
- "date": "2019-08-24",
- "price": 0.1,
- "taxable": true,
- "kind": "Service",
- "note": "string",
- "secondary_taxable": true,
- "total": 0.1,
- "tax": 0.1,
- "secondary_tax": 0.1,
- "sub_total": 0.1,
- "quantity": 0.1,
- "group_ordering": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "activity": {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "discount": {
- "rate": 0.1,
- "type": "percentage",
- "note": "string",
- "early_payment_rate": 0,
- "early_payment_period": 0
}, - "included_line_item_totals": {
- "quantity": 0.1,
- "price": 0.1,
- "discount_percent": 0.1,
- "total": 0.1,
- "sub_total": 0.1
}
}
}
A LineItem can not be deleted if it's Bill is not editable
id required | integer <int64> The unique identifier for the LineItem. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all OutstandingClientBalances
contact_id | integer <int64> The unique identifier for a single Contact. Use the keyword |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
last_paid_end_date | string <date> Filter OutstandingClientBalance records for those whose bills have been paid before the specified date |
last_paid_start_date | string <date> Filter OutstandingClientBalance records for those whose bills have been paid after the specified date |
limit | integer <int32> A limit on the number of OutstandingClientBalance records to be returned. Limit can range between 1 and 200. Default: |
newest_bill_due_end_date | string <date> Filter OutstandingClientBalance records for the contact's newest bill due date before the specified date |
newest_bill_due_start_date | string <date> Filter OutstandingClientBalance records for the contact's newest bill due date after the specified date |
originating_attorney_id | integer <int64> Filters OutstandingClientBalance records to those with matters that have a matching originating attorney. |
page_token | string A token specifying which page to return. |
responsible_attorney_id | integer <int64> Filter OutstandingClientBalance records to those with matters that have a matching responsible attorney |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "associated_matter_ids": [
- 0
], - "etag": "string",
- "id": 0,
- "last_payment_date": "2019-08-24",
- "last_shared_date": "2019-08-24",
- "newest_issued_bill_due_date": "2019-08-24",
- "pending_payments_total": 0.1,
- "reminders_enabled": true,
- "total_outstanding_balance": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "outstanding_bills": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}
], - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Calendars contain Calendar Entries. All Clio accounts contain one firm Calendar ("AccountCalendar"), personal Calendars for each user ("UserCalendar"), and any number of manually created Calendars ("AdhocCalendar"). Calendar sharing settings determine if a Calendar is visible to a User, and if that User is able to create or edit Calendar Entries on that Calendar.
Outlines the parameters, optional and required, used when requesting the data for all Calendars
created_since | string <date-time> Filter Calendar records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
filter_inactive_users | boolean Filter any shared UserCalendar records whose owner is inactive. |
ids[] | integer <int64> Filter Calendar records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Calendar records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "name(asc)" "name(desc)" "id(asc)" "id(desc)" Orders the Calendar records by the given field. Default: |
owner | boolean Filter Calendar records to those that the user owns. |
page_token | string A token specifying which page to return. |
source | string Enum: "web" "mobile" Filter Calendar records to those having a specific calendar visibility source (mobile, web). |
type | string Enum: "AccountCalendar" "AdhocCalendar" "UserCalendar" Filter Calendar records to those of the specified type. |
updated_since | string <date-time> Filter Calendar records to those having the |
visible | boolean Filter Calendar records to those that are visible. |
writeable | boolean Filter Calendar records to those which the user can write to. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web",
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new Calendar
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Calendars
required | object | ||||||||
|
{- "data": {
- "color": "#367B9C",
- "name": "string",
- "source": "web",
- "visible": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web",
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Calendar
id required | integer <int64> The unique identifier for the Calendar. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web",
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single Calendar
id required | integer <int64> The unique identifier for the Calendar. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Calendars
required | object | ||||||||
|
{- "data": {
- "color": "#367B9C",
- "name": "string",
- "source": "web",
- "visible": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web",
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Calendar
id required | integer <int64> The unique identifier for the Calendar. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Calendar Entries are used to track appointments or deadlines. Users can view Calendar Entries on any Calendar that they have “Viewer” or “Editor” permission for. Users can create Calendar Entries on any Calendar that they have “Editor” permission for.
null
, offer the following 3 options for the update/deletion, as well as the note:Outlines the parameters, optional and required, used when requesting the data for all CalendarEntries
calendar_id | integer <int64> The unique identifier for a single Calendar. The keyword |
created_since | string <date-time> Filter CalendarEntry records to those having the |
expanded | boolean Returns a record for each occurrence of a recurring calendar event. Non-recurring calendar events are unaffected and returned as separate records regardless of the expanded setting. |
external_property_name | string Filter records to only those with the given external property(s) name set. e.g. |
external_property_value | string Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
from | string <date-time> Filter CalendarEntry records to those that end on or after the provided time (Expects an ISO-8601 timestamp). |
has_court_rule | boolean Allows matching court rule on calendar entry. |
ids[] | integer <int64> Filter CalendarEntry records to those having the specified unique identifiers. |
is_all_day | boolean Filter CalendarEntry records to those that are marked as all day events. |
limit | integer <int32> A limit on the number of CalendarEntry records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
owner_entries_across_all_users | boolean Returns CalendarEntry records for all users related to a matter. Requires matter id. |
page_token | string A token specifying which page to return. |
query | string Allows matching search on calendar entry. |
source | string Enum: "web" "mobile" Filter CalendarEntry records to those having a specific calendar visibility source (mobile, web). |
to | string <date-time> Filter CalendarEntry records to those that begin on or before the provided time (Expects an ISO-8601 timestamp). |
updated_since | string <date-time> Filter CalendarEntry records to those having the |
visible | boolean Filter CalendarEntry records to those that are visible. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0,
- "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "conference_meeting": {
- "conference_id": 0,
- "conference_password": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "id": 0,
- "join_url": "string",
- "type": "string",
- "source_id": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "matter_docket": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "start_date": "2019-08-24",
- "start_time": "2019-08-24T14:15:22Z",
- "status": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "calendar_owner": {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web"
}, - "parent_calendar_entry": {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0
}, - "calendar_entry_event_type": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "color": "#367B9C",
- "name": "string"
}, - "attendees": [
- {
- "id": 0,
- "etag": "string",
- "type": "Contact",
- "name": "string",
- "enabled": true,
- "email": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "calendars": [
- {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web"
}
], - "reminders": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new CalendarEntry
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Calendar Entries
required | object | ||||||||||||||||||||||||||||||
|
{- "data": {
- "_deleted": "single",
- "all_day": true,
- "attendees": [
- {
- "id": 0,
- "type": "string",
- "_destroy": true
}
], - "calendar_entry_event_type": {
- "id": 0
}, - "calendar_owner": {
- "id": 0
}, - "conference_meeting": {
- "type": "zoom"
}, - "description": "string",
- "end_at": "2019-08-24T14:15:22Z",
- "external_properties": [
- {
- "name": "string",
- "value": "string"
}
], - "location": "string",
- "matter": {
- "id": 0
}, - "recurrence_rule": "string",
- "send_email_notification": true,
- "start_at": "2019-08-24T14:15:22Z",
- "summary": "string"
}
}
{- "data": {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0,
- "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "conference_meeting": {
- "conference_id": 0,
- "conference_password": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "id": 0,
- "join_url": "string",
- "type": "string",
- "source_id": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "matter_docket": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "start_date": "2019-08-24",
- "start_time": "2019-08-24T14:15:22Z",
- "status": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "calendar_owner": {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web"
}, - "parent_calendar_entry": {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0
}, - "calendar_entry_event_type": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "color": "#367B9C",
- "name": "string"
}, - "attendees": [
- {
- "id": 0,
- "etag": "string",
- "type": "Contact",
- "name": "string",
- "enabled": true,
- "email": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "calendars": [
- {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web"
}
], - "reminders": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single CalendarEntry
id required | integer <int64> The unique identifier for the CalendarEntry. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0,
- "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "conference_meeting": {
- "conference_id": 0,
- "conference_password": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "id": 0,
- "join_url": "string",
- "type": "string",
- "source_id": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "matter_docket": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "start_date": "2019-08-24",
- "start_time": "2019-08-24T14:15:22Z",
- "status": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "calendar_owner": {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web"
}, - "parent_calendar_entry": {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0
}, - "calendar_entry_event_type": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "color": "#367B9C",
- "name": "string"
}, - "attendees": [
- {
- "id": 0,
- "etag": "string",
- "type": "Contact",
- "name": "string",
- "enabled": true,
- "email": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "calendars": [
- {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web"
}
], - "reminders": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters and data fields used when updating a single CalendarEntry
id required | integer <int64> The unique identifier for the CalendarEntry. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Calendar Entries
required | object | ||||||||||||||||||||||||||||||
|
{- "data": {
- "_deleted": "single",
- "all_day": true,
- "attendees": [
- {
- "id": 0,
- "type": "string",
- "_destroy": true
}
], - "calendar_entry_event_type": {
- "id": 0
}, - "calendar_owner": {
- "id": 0
}, - "conference_meeting": {
- "type": "zoom"
}, - "description": "string",
- "end_at": "2019-08-24T14:15:22Z",
- "external_properties": [
- {
- "id": 0,
- "name": "string",
- "value": "string",
- "_destroy": true
}
], - "location": "string",
- "matter": {
- "id": 0
}, - "recurrence_rule": "string",
- "send_email_notification": true,
- "start_at": "2019-08-24T14:15:22Z",
- "summary": "string"
}
}
{- "data": {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0,
- "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "conference_meeting": {
- "conference_id": 0,
- "conference_password": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "id": 0,
- "join_url": "string",
- "type": "string",
- "source_id": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "matter_docket": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "start_date": "2019-08-24",
- "start_time": "2019-08-24T14:15:22Z",
- "status": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "calendar_owner": {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web"
}, - "parent_calendar_entry": {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0
}, - "calendar_entry_event_type": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "color": "#367B9C",
- "name": "string"
}, - "attendees": [
- {
- "id": 0,
- "etag": "string",
- "type": "Contact",
- "name": "string",
- "enabled": true,
- "email": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "calendars": [
- {
- "id": 0,
- "etag": "string",
- "color": "#367B9C",
- "light_color": "#5DA5C7",
- "court_rules_default_calendar": true,
- "name": "string",
- "permission": "owner",
- "type": "AccountCalendar",
- "visible": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "source": "web"
}
], - "reminders": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single CalendarEntry
id required | integer <int64> The unique identifier for the CalendarEntry. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all CalendarEntryEventTypes
created_since | string <date-time> Filter CalendarEntryEventType records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter CalendarEntryEventType records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of CalendarEntryEventType records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter CalendarEntryEventType records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "color": "#367B9C",
- "name": "string"
}
Outlines the parameters and data fields used when creating a new CalendarEntryEventType
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Calendar Entry Event Types
required | object | ||||
|
{- "data": {
- "color": "#367B9C",
- "name": "string"
}
}
{- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "color": "#367B9C",
- "name": "string"
}
Outlines the parameters, optional and required, used when requesting the data for a single CalendarEntryEventType
id required | integer <int64> The unique identifier for the CalendarEntryEventType. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "color": "#367B9C",
- "name": "string"
}
Outlines the parameters and data fields used when updating a single CalendarEntryEventType
id required | integer <int64> The unique identifier for the CalendarEntryEventType. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Calendar Entry Event Types
required | object | ||||
|
{- "data": {
- "color": "#367B9C",
- "name": "string"
}
}
{- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "color": "#367B9C",
- "name": "string"
}
Outlines the parameters, optional and required, used when deleting the record for a single CalendarEntryEventType
id required | integer <int64> The unique identifier for the CalendarEntryEventType. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all CalendarVisibilities
created_since | string <date-time> Filter CalendarVisibility records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter CalendarVisibility records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of CalendarVisibility records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter CalendarVisibility records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "color": "#658CDA",
- "light_color": "#5DA5C7",
- "visible": true,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single CalendarVisibility
id required | integer <int64> The unique identifier for the CalendarVisibility. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "color": "#658CDA",
- "light_color": "#5DA5C7",
- "visible": true,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Outlines the parameters and data fields used when updating a single CalendarVisibility
id required | integer <int64> The unique identifier for the CalendarVisibility. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Task Calendars
required | object | ||||
|
{- "data": {
- "color": "#367B9C",
- "visible": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "color": "#658CDA",
- "light_color": "#5DA5C7",
- "visible": true,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Reminders can be added to Tasks or Calendar Entries. Reminder emails can be sent by a User to themselves, other Users, Clio For Co-Counsel/Clio Connect Contacts, or any authorized email. An in-Clio pop-up reminder can also be sent by a User to themself.
Outlines the parameters, optional and required, used when requesting the data for all Reminders
created_since | string <date-time> Filter Reminder records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Reminder records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Reminder records to be returned. Limit can range between 1 and 200. Default: |
notification_method_id | integer <int64> The unique identifier for a single NotificationMethod. The keyword |
order | string Enum: "next_delivery_at(asc)" "next_delivery_at(desc)" "id(asc)" "id(desc)" Orders the Reminder records by the given field. Default: |
page_token | string A token specifying which page to return. |
state | string Enum: "initializing" "scheduling" "rescheduling" "scheduled" "attempting_delivery" "delivery_failed" "delivered" "delivery_skipped" "invalid_user" Filter Reminder records to those with a given state. |
subject_id | integer <int64> The unique identifier for a single CalendarEntry or Task. The keyword |
subject_type | string Enum: "calendar_entry" "task" Filter Reminder records to those of a given subject type, required if using subject_id. |
updated_since | string <date-time> Filter Reminder records to those having the |
user_id | integer <int64> The unique identifier for a single User. The keyword |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "notification_method": {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "subject": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}
}
]
}
Outlines the parameters and data fields used when creating a new Reminder
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Reminders
required | object | ||||||||
|
{- "data": {
- "duration_unit": "weeks",
- "duration_value": 0,
- "notification_method": {
- "id": 0
}, - "subject": {
- "id": 0,
- "type": "CalendarEntry"
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "notification_method": {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "subject": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Reminder
id required | integer <int64> The unique identifier for the Reminder. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "notification_method": {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "subject": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}
}
}
Outlines the parameters and data fields used when updating a single Reminder
id required | integer <int64> The unique identifier for the Reminder. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Reminders
required | object | ||||||
|
{- "data": {
- "duration_unit": "weeks",
- "duration_value": 0,
- "notification_method": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "notification_method": {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "subject": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Reminder
id required | integer <int64> The unique identifier for the Reminder. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all ClioPaymentsLinks
active | boolean Filter ClioPaymentsLink records based on whether or not they have expired. |
created_since | string <date-time> Filter ClioPaymentsLink records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter ClioPaymentsLink records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of ClioPaymentsLink records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter ClioPaymentsLink records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "active": true,
- "amount": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "email_address": "string",
- "etag": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "id": 0,
- "is_allocated_as_revenue": true,
- "redirect_url": "string",
- "url": "string",
- "bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "clio_payments_payment": {
- "amount": 0.1,
- "confirmation_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "deposit_as_revenue": true,
- "description": "string",
- "email_address": "string",
- "id": 0,
- "state": "pending",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "destination_contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
]
}
Outlines the parameters and data fields used when creating a new ClioPaymentsLink
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Links
required | object | ||||||||||||||||||
|
{- "data": {
- "amount": 0.1,
- "currency": "string",
- "description": "string",
- "destination_account": {
- "id": 0
}, - "destination_contact": {
- "id": 0
}, - "duration": 0,
- "email_address": "string",
- "is_allocated_as_revenue": true,
- "subject": {
- "id": 0,
- "type": "BankAccount"
}
}
}
{- "data": {
- "active": true,
- "amount": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "email_address": "string",
- "etag": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "id": 0,
- "is_allocated_as_revenue": true,
- "redirect_url": "string",
- "url": "string",
- "bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "clio_payments_payment": {
- "amount": 0.1,
- "confirmation_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "deposit_as_revenue": true,
- "description": "string",
- "email_address": "string",
- "id": 0,
- "state": "pending",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "destination_contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single ClioPaymentsLink
id required | integer <int64> The unique identifier for the ClioPaymentsLink. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "active": true,
- "amount": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "email_address": "string",
- "etag": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "id": 0,
- "is_allocated_as_revenue": true,
- "redirect_url": "string",
- "url": "string",
- "bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "clio_payments_payment": {
- "amount": 0.1,
- "confirmation_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "deposit_as_revenue": true,
- "description": "string",
- "email_address": "string",
- "id": 0,
- "state": "pending",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "destination_contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
}
Outlines the parameters and data fields used when updating a single ClioPaymentsLink
id required | integer <int64> The unique identifier for the ClioPaymentsLink. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Links
required | object | ||
|
{- "data": {
- "expired": true
}
}
{- "data": {
- "active": true,
- "amount": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "email_address": "string",
- "etag": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "id": 0,
- "is_allocated_as_revenue": true,
- "redirect_url": "string",
- "url": "string",
- "bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "clio_payments_payment": {
- "amount": 0.1,
- "confirmation_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "deposit_as_revenue": true,
- "description": "string",
- "email_address": "string",
- "id": 0,
- "state": "pending",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "destination_contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
}
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.
Outlines the parameters, optional and required, used when requesting the data for all ClioPaymentsPayments
bill_id | integer <int64> Filter ClioPaymentsPayment records to those that are allocated to the specified bill. |
contact_id | integer <int64> Filter ClioPaymentsPayment records to those that are assigned to the specified contact. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter ClioPaymentsPayment records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of ClioPaymentsPayment records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
state | string Enum: "pending" "authorized" "completed" "voided" "failed" "canceled" "requires_confirmation" "completed_requiring_allocation" Filter ClioPaymentsPayment records to those in a given state. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "amount": 0.1,
- "confirmation_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "deposit_as_revenue": true,
- "description": "string",
- "email_address": "string",
- "id": 0,
- "state": "pending",
- "updated_at": "2019-08-24T14:15:22Z",
- "bank_transaction": {
- "id": 0,
- "type": "string",
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "bank_account_id": 0,
- "source": "string",
- "confirmation": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "currency": "string",
- "currency_id": 0,
- "description": "string",
- "exchange_rate": 0.1,
- "transaction_type": "string",
- "funds_in": 0.1,
- "funds_out": 0.1,
- "clio_payments_transaction": true,
- "current_account_balance": 0.1,
- "read_only_confirmation": true
}, - "clio_payments_link": {
- "active": true,
- "amount": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "email_address": "string",
- "etag": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "id": 0,
- "is_allocated_as_revenue": true,
- "redirect_url": "string",
- "url": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "allocations": [
- {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "interest": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "has_online_payment": true,
- "destroyable": true,
- "payment_type": "string"
}
], - "bills": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}
], - "matters": [
- {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single ClioPaymentsPayment
id required | integer <int64> The unique identifier for the ClioPaymentsPayment. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "amount": 0.1,
- "confirmation_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "deposit_as_revenue": true,
- "description": "string",
- "email_address": "string",
- "id": 0,
- "state": "pending",
- "updated_at": "2019-08-24T14:15:22Z",
- "bank_transaction": {
- "id": 0,
- "type": "string",
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "bank_account_id": 0,
- "source": "string",
- "confirmation": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "currency": "string",
- "currency_id": 0,
- "description": "string",
- "exchange_rate": 0.1,
- "transaction_type": "string",
- "funds_in": 0.1,
- "funds_out": 0.1,
- "clio_payments_transaction": true,
- "current_account_balance": 0.1,
- "read_only_confirmation": true
}, - "clio_payments_link": {
- "active": true,
- "amount": 0.1,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "email_address": "string",
- "etag": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "id": 0,
- "is_allocated_as_revenue": true,
- "redirect_url": "string",
- "url": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "destination_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "allocations": [
- {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "interest": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "has_online_payment": true,
- "destroyable": true,
- "payment_type": "string"
}
], - "bills": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}
], - "matters": [
- {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Users can view all logged phone calls and emails under the Communications tab in Clio. This is also where they can use Clio internal messages.
Communications can be filtered to show those attached to certain Matters or dates, or to show those with or without time entries.
Outlines the parameters, optional and required, used when requesting the data for all Communications
contact_id | integer <int64> The unique identifier for a single Contact. The keyword |
created_since | string <date-time> Filter Communication records to those having the |
date | string <date> Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date). |
external_property_name | string Filter records to only those with the given external property(s) name set. e.g. |
external_property_value | string Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
having_time_entries | boolean Filter Communication records to those that do or do not have time entries. |
ids[] | integer <int64> Filter Communication records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Communication records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
order | string Enum: "id(asc)" "id(desc)" "date(asc)" "date(desc)" "received_at(asc)" "received_at(desc)" "matter(asc)" "matter(desc)" Orders the Communication records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
received_at | string <date-time> Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date-time). |
received_before | string <date-time> Filter Communication records to those whose |
received_since | string <date-time> Filter Communication records to those whose |
type | string Enum: "EmailCommunication" "PhoneCommunication" Filter Communication records to those of the specified type. |
updated_since | string <date-time> Filter Communication records to those having the |
user_id | integer <int64> The unique identifier for a single User. The keyword |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "subject": "string",
- "body": "string",
- "type": "EmailCommunication",
- "date": "2019-08-24",
- "time_entries_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "received_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "communication_eml_file": {
- "id": 0
}, - "senders": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}
], - "receivers": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}
], - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new Communication
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Communications
required | object | ||||||||||||||||||
|
{- "data": {
- "body": "string",
- "external_properties": [
- {
- "name": "string",
- "value": "string"
}
], - "matter": {
- "id": 0
}, - "notification_event_subscribers": [
- {
- "user_id": "string"
}
], - "received_at": "string",
- "receivers": [
- {
- "_deleted": true,
- "id": 0,
- "type": "User"
}
], - "senders": [
- {
- "_deleted": true,
- "id": 0,
- "type": "User"
}
], - "subject": "string",
- "type": "PhoneCommunication"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "subject": "string",
- "body": "string",
- "type": "EmailCommunication",
- "date": "2019-08-24",
- "time_entries_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "received_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "communication_eml_file": {
- "id": 0
}, - "senders": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}
], - "receivers": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}
], - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Communication
id required | integer <int64> The unique identifier for the Communication. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "subject": "string",
- "body": "string",
- "type": "EmailCommunication",
- "date": "2019-08-24",
- "time_entries_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "received_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "communication_eml_file": {
- "id": 0
}, - "senders": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}
], - "receivers": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}
], - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters and data fields used when updating a single Communication
id required | integer <int64> The unique identifier for the Communication. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Communications
required | object | ||||||||||||||||||
|
{- "data": {
- "body": "string",
- "external_properties": [
- {
- "id": 0,
- "name": "string",
- "value": "string",
- "_destroy": true
}
], - "matter": {
- "id": 0
}, - "notification_event_subscribers": [
- {
- "user_id": "string",
- "id": 0,
- "_destroy": true
}
], - "received_at": "string",
- "receivers": [
- {
- "_deleted": true,
- "id": 0,
- "type": "User"
}
], - "senders": [
- {
- "_deleted": true,
- "id": 0,
- "type": "User"
}
], - "subject": "string",
- "type": "PhoneCommunication"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "subject": "string",
- "body": "string",
- "type": "EmailCommunication",
- "date": "2019-08-24",
- "time_entries_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "received_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "communication_eml_file": {
- "id": 0
}, - "senders": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}
], - "receivers": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}
], - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Communication
id required | integer <int64> The unique identifier for the Communication. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all Conversations
archived | boolean Filter archived Conversation records. |
contact_id | integer <int64> Filter Conversation records for the contact. |
created_since | string <date-time> Filter Conversation records to those having the |
date | string <date> Filter Conversation records created on a given date. (Expects an ISO-8601 date). |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
for_user | boolean If set to true, filter Conversation records accessible to any groups of the user. Note that the user may not be member of the conversations. If set to false, filter Conversation records of which the user is a member. |
ids[] | integer <int64> Filter Conversation records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Conversation records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
order | string Enum: "id(asc)" "id(desc)" "last_message_id(asc)" "last_message_id(desc)" "matter_id(asc)" "matter_id(desc)" Orders the Conversation records by the given field. Default: |
page_token | string A token specifying which page to return. |
read_status | boolean Filter Conversation records to those which have been read. |
time_entries | boolean Filter Conversation records to those with or without associated time entries. |
updated_since | string <date-time> Filter Conversation records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "archived": true,
- "read_only": true,
- "current_user_is_member": true,
- "subject": "string",
- "message_count": 0,
- "time_entries_count": 0,
- "read": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "last_message": {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "first_message": {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "messages": [
- {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
], - "memberships": [
- {
- "id": 0,
- "etag": "string",
- "read": true,
- "archived": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "member": { }
}
]
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single Conversation
id required | integer <int64> The unique identifier for the Conversation. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "archived": true,
- "read_only": true,
- "current_user_is_member": true,
- "subject": "string",
- "message_count": 0,
- "time_entries_count": 0,
- "read": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "last_message": {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "first_message": {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "messages": [
- {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
], - "memberships": [
- {
- "id": 0,
- "etag": "string",
- "read": true,
- "archived": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "member": { }
}
]
}
}
Outlines the parameters and data fields used when updating a single Conversation
id required | integer <int64> The unique identifier for the Conversation. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Conversations
required | object | ||||||
|
{- "data": {
- "archived": true,
- "matter": {
- "id": 0
}, - "read": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "archived": true,
- "read_only": true,
- "current_user_is_member": true,
- "subject": "string",
- "message_count": 0,
- "time_entries_count": 0,
- "read": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "last_message": {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "first_message": {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "messages": [
- {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
], - "memberships": [
- {
- "id": 0,
- "etag": "string",
- "read": true,
- "archived": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "member": { }
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for all ConversationMessages
conversation_id required | integer <int64> The unique identifier for a single Conversation. Use the keyword |
created_since | string <date-time> Filter ConversationMessage records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter ConversationMessage records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of ConversationMessage records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" Orders the ConversationMessage records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
updated_since | string <date-time> Filter ConversationMessage records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sender": { },
- "document": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}, - "conversation": {
- "id": 0,
- "etag": "string",
- "archived": true,
- "read_only": true,
- "current_user_is_member": true,
- "subject": "string",
- "message_count": 0,
- "time_entries_count": 0,
- "read": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "receivers": [
- { }
]
}
]
}
Outlines the parameters and data fields used when creating a new ConversationMessage
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Conversation Messages
required | object | ||||||||||||
|
{- "data": {
- "attachment": {
- "document_id": 0,
- "document_version_id": 0
}, - "body": "string",
- "conversation": {
- "id": 0
}, - "matter": {
- "id": 0
}, - "receivers": [
- {
- "id": 0,
- "type": "Contact"
}
], - "subject": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sender": { },
- "document": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}, - "conversation": {
- "id": 0,
- "etag": "string",
- "archived": true,
- "read_only": true,
- "current_user_is_member": true,
- "subject": "string",
- "message_count": 0,
- "time_entries_count": 0,
- "read": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "receivers": [
- { }
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single ConversationMessage
id required | integer <int64> The unique identifier for the ConversationMessage. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "date": "string",
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sender": { },
- "document": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}, - "conversation": {
- "id": 0,
- "etag": "string",
- "archived": true,
- "read_only": true,
- "current_user_is_member": true,
- "subject": "string",
- "message_count": 0,
- "time_entries_count": 0,
- "read": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "receivers": [
- { }
]
}
}
All clients, prospective clients, companies, and external co-counsels can be viewed as Contacts under the Contacts tab in Clio Manage.
When creating a contact of type "Person" you must provide at least a first name or a last name. This can be done in one of two ways:
first_name
and last_name
parameters.name
parameter, you can provide the person's full name (e.g. "John Smith") and Clio will attempt to infer the individual components of the name. If it is unable to do so, you will receive a "422 Unprocessable Entity: At least one of first name or last name must be provided" Error.We recommend using the individual name fields when possible to avoid any ambiguities.
A Contact can be persisted with its associations in a single request. The followings detail the nested attributes to persist the associations.
Checkout the sample request to update the Addresses of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
addresses: [
// update
{ id: 1, name: "Work", country: "Canada" },
// create
{ name: "Home", street: "1234 Main Street", city: "Burnaby", province: "BC", country: "Canada", postal_code: "V1A 1A1" },
// destroy
{ id: 2, _destroy: true }
]
}
A CustomFieldValue contains the value of a CustomField for a Contact. Below are some examples of how to create, read, update, and destroy the CustomFieldValues of a Contact:
Note: The value of id
used here is the value of the id
parameter in the response received when creating a new CustomField or one returned in a query of an existing CustomField.
Request
PATCH /api/v4/contacts/1.json
{
data: {
custom_field_values: [
{ custom_field: { id: 2 }, value: "Initial value" }
]
}
}
Note: The id
of the CustomFieldValue is a composite value including the custom field type. Use this id
to update and destroy the CustomFieldValue.
The id
of the associated Custom Field can be found by querying the custom_field
for all CustomFieldValues related to the Contact, e.g.: /api/v4/contacts/1?fields=id,display_number,custom_field_values{id,value,custom_field}
Note: The id
may be NULL
when the CustomField is displayed by default but has not yet been given a value.
Request
GET /api/v4/contacts/1.json?fields=custom_field_values{id,value,custom_field}
{
data: {
custom_field_values: [
{
id: "text_line-1",
value: "Current value",
custom_field: { id: 2 }
}
]
}
}
Note: The value of the CustomFieldValue id
used here is a composite value and can be found by querying for all CustomFieldValues related to the Contact, e.g.: /api/v4/contacts/1?fields=id,name,custom_field_values{id,value,custom_field}
Note: If the id
is NULL
, you must provide custom_field{id}
to create the CustomFieldValue and assign a value (see Create).
Request
PATCH /api/v4/contacts/1.json
{
data: {
custom_field_values: [
{ id: "text_line-1", value: "Updated value" }
]
}
}
Note: The value of the CustomFieldValue id
used here is a composite value and can be found by querying for all CustomFieldValues related to the Contact, e.g.: /api/v4/contacts/1?fields=id,name,custom_field_values{id,value}
Request
PATCH /api/v4/contacts/1.json
{
data: {
custom_field_values: [
{ id: "picklist-2", _destroy: true }
]
}
}
Checkout the sample request to update the Email Addresses of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
email_addresses: [
// update
{ id: 1, name: "Work", address: "demo@clio.com" },
// create
{ name: "Home", address: "home@clio.com" },
// destroy
{ id: 2, _destroy: true }
]
}
Checkout the sample request to update the Instant Messengers of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
instant_messengers: [
// update
{ id: 1, name: "Work", address: "https://twitter.com/goclio" },
// create
{ name: "Other", address: "https://www.facebook.com/GoClio/" },
// destroy
{ id: 2, _destroy: true }
]
}
Checkout the sample request to update the Phone Numbers of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
phone_numbers: [
// update
{ id: 1, name: "Work", number: "123-456-7890" },
// create
{ name: "Other", number: "000-000-0000" },
// destroy
{ id: 2, _destroy: true }
]
}
Checkout the sample request to update the Web Site of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
web_sites: [
// update
{ id: 1, name: "Work", address: "https://help.clio.com/" },
// create
{ name: "Other", address: "https://www.clio.com/about/careers/" },
// destroy
{ id: 2, _destroy: true }
]
}
Outlines the parameters, optional and required, used when requesting the data for all Contacts
client_only | boolean Filter Contact records to those that are clients. |
clio_connect_only | boolean Filter Contact records to those that are Clio Connect users. |
created_since | string <date-time> Filter Contact records to those having the |
custom_field_ids[] | integer <int64> Filter Contact's custom_field_values to only include values for the given custom field unique identifiers. |
custom_field_values | string Enum: "=" "<" ">" "<=" ">=" 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. Supported operators:
e.g.
e.g.
e.g. 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. |
email_only | boolean Filter Contact records to those that have email addresses. |
exclude_ids[] | integer <int64> Filter Contact records to those who are not included in the given list of unique identifiers. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Contact records to those having the specified unique identifiers. |
initial | string Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z" Filter Contact records to those where the last name or company name start with the given initial. |
limit | integer <int32> A limit on the number of Contact records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" "shared_at(asc)" "shared_at(desc)" Orders the Contact records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for name, title, email address, address, phone number, web site, instant messenger address, custom fields, related matter name, or company name matching a given string. |
shared_resource_id | integer <int64> Filter Contact records to those that currently have access to a given shared resource. |
type | string Enum: "Company" "Person" Filter Contact records to those that match the given type. |
updated_since | string <date-time> Filter Contact records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "activity_rates": [
- {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0
}
], - "addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true,
- "custom_field": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "picklist_option": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "display_number": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "custom_field_set_associations": [
- {
- "id": 0,
- "etag": "string",
- "display_order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "email_addresses": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "string",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "instant_messengers": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "phone_numbers": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "name": "Work",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "web_sites": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "notification_methods": [
- {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "account_balances": [
- {
- "id": 0,
- "balance": 0.1,
- "type": "string",
- "name": "string",
- "currency_id": 0
}
], - "related_contacts": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
], - "primary_work_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "primary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "secondary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "company": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "payment_profile": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "billing_setting_id": 0,
- "name": "string",
- "terms": 0,
- "discount_rate": 0.1,
- "discount_period": 0,
- "interest_rate": 0.1,
- "interest_period": 0,
- "interest_type": "simple"
}, - "folder": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "co_counsel_rate": {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0
}, - "primary_web_site": {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "legal_aid_uk_contact": {
- "id": 0,
- "disability": 0,
- "disability_code": "string",
- "ethnicity": 0,
- "ethnicity_title": "string",
- "financially_eligible": true,
- "gender": 0,
- "gender_title": "string",
- "national_insurance_number": "string"
}
}
]
}
Outlines the parameters and data fields used when creating a new Contact
custom_field_ids[] | integer <int64> Filter Contact's custom_field_values to only include values for the given custom field unique identifiers. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Contacts
required | object | ||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "addresses": [
- {
- "name": "Work",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string"
}
], - "avatar": {
- "image": "string",
- "_destroy": true
}, - "clio_connect_email": "string",
- "co_counsel_rate": {
- "rate": 0.1
}, - "company": {
- "id": 0
}, - "currency": { },
- "custom_field_set_associations": [
- {
- "display_order": 0,
- "custom_field_set": {
- "id": 0
}
}
], - "custom_field_values": [
- {
- "value": "string",
- "custom_field": {
- "id": 0
}
}
], - "date_of_birth": "2019-08-24",
- "email_addresses": [
- {
- "name": "Work",
- "address": "string",
- "default_email": true
}
], - "first_name": "string",
- "instant_messengers": [
- {
- "name": "Work",
- "address": "string"
}
], - "last_name": "string",
- "ledes_client_id": "string",
- "middle_name": "string",
- "name": "string",
- "phone_numbers": [
- {
- "name": "Work",
- "number": "string",
- "default_number": true
}
], - "prefix": "string",
- "sales_tax_number": "string",
- "title": "string",
- "type": "Person",
- "web_sites": [
- {
- "name": "Work",
- "address": "string",
- "default_web_site": true
}
]
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "activity_rates": [
- {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0
}
], - "addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true,
- "custom_field": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "picklist_option": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "display_number": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "custom_field_set_associations": [
- {
- "id": 0,
- "etag": "string",
- "display_order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "email_addresses": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "string",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "instant_messengers": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "phone_numbers": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "name": "Work",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "web_sites": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "notification_methods": [
- {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "account_balances": [
- {
- "id": 0,
- "balance": 0.1,
- "type": "string",
- "name": "string",
- "currency_id": 0
}
], - "related_contacts": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
], - "primary_work_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "primary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "secondary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "company": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "payment_profile": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "billing_setting_id": 0,
- "name": "string",
- "terms": 0,
- "discount_rate": 0.1,
- "discount_period": 0,
- "interest_rate": 0.1,
- "interest_period": 0,
- "interest_type": "simple"
}, - "folder": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "co_counsel_rate": {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0
}, - "primary_web_site": {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "legal_aid_uk_contact": {
- "id": 0,
- "disability": 0,
- "disability_code": "string",
- "ethnicity": 0,
- "ethnicity_title": "string",
- "financially_eligible": true,
- "gender": 0,
- "gender_title": "string",
- "national_insurance_number": "string"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Contact
id required | integer <int64> The unique identifier for the Contact. |
custom_field_ids[] | integer <int64> Filter Contact's custom_field_values to only include values for the given custom field unique identifiers. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "activity_rates": [
- {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0
}
], - "addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true,
- "custom_field": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "picklist_option": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "display_number": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "custom_field_set_associations": [
- {
- "id": 0,
- "etag": "string",
- "display_order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "email_addresses": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "string",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "instant_messengers": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "phone_numbers": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "name": "Work",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "web_sites": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "notification_methods": [
- {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "account_balances": [
- {
- "id": 0,
- "balance": 0.1,
- "type": "string",
- "name": "string",
- "currency_id": 0
}
], - "related_contacts": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
], - "primary_work_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "primary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "secondary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "company": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "payment_profile": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "billing_setting_id": 0,
- "name": "string",
- "terms": 0,
- "discount_rate": 0.1,
- "discount_period": 0,
- "interest_rate": 0.1,
- "interest_period": 0,
- "interest_type": "simple"
}, - "folder": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "co_counsel_rate": {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0
}, - "primary_web_site": {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "legal_aid_uk_contact": {
- "id": 0,
- "disability": 0,
- "disability_code": "string",
- "ethnicity": 0,
- "ethnicity_title": "string",
- "financially_eligible": true,
- "gender": 0,
- "gender_title": "string",
- "national_insurance_number": "string"
}
}
}
Outlines the parameters and data fields used when updating a single Contact
id required | integer <int64> The unique identifier for the Contact. |
custom_field_ids[] | integer <int64> Filter Contact's custom_field_values to only include values for the given custom field unique identifiers. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Contacts
required | object | ||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "addresses": [
- {
- "name": "Work",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "id": 0,
- "_destroy": true
}
], - "avatar": {
- "image": "string",
- "_destroy": true
}, - "clio_connect_email": "string",
- "co_counsel_rate": {
- "rate": 0.1
}, - "company": {
- "id": 0
}, - "currency": { },
- "custom_field_set_associations": [
- {
- "id": 0,
- "display_order": 0,
- "custom_field_set": {
- "id": 0
}, - "_destroy": true
}
], - "custom_field_values": [
- {
- "value": "string",
- "custom_field": {
- "id": 0
}, - "id": 0,
- "_destroy": true
}
], - "date_of_birth": "2019-08-24",
- "email_addresses": [
- {
- "id": 0,
- "name": "Work",
- "address": "string",
- "default_email": true,
- "_destroy": true
}
], - "first_name": "string",
- "instant_messengers": [
- {
- "name": "Work",
- "address": "string",
- "id": 0,
- "_destroy": true
}
], - "last_name": "string",
- "ledes_client_id": "string",
- "middle_name": "string",
- "name": "string",
- "phone_numbers": [
- {
- "name": "Work",
- "number": "string",
- "default_number": true,
- "id": 0,
- "_destroy": true
}
], - "prefix": "string",
- "sales_tax_number": "string",
- "title": "string",
- "type": "Person",
- "web_sites": [
- {
- "name": "Work",
- "address": "string",
- "id": 0,
- "default_web_site": true,
- "_destroy": true
}
]
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "activity_rates": [
- {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0
}
], - "addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true,
- "custom_field": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "picklist_option": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "display_number": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "custom_field_set_associations": [
- {
- "id": 0,
- "etag": "string",
- "display_order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "email_addresses": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "string",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "instant_messengers": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "phone_numbers": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "name": "Work",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "web_sites": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "notification_methods": [
- {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "account_balances": [
- {
- "id": 0,
- "balance": 0.1,
- "type": "string",
- "name": "string",
- "currency_id": 0
}
], - "related_contacts": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
], - "primary_work_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "primary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "secondary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "company": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "payment_profile": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "billing_setting_id": 0,
- "name": "string",
- "terms": 0,
- "discount_rate": 0.1,
- "discount_period": 0,
- "interest_rate": 0.1,
- "interest_period": 0,
- "interest_type": "simple"
}, - "folder": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "co_counsel_rate": {
- "id": 0,
- "etag": "string",
- "rate": 0.1,
- "flat_rate": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "contact_id": 0,
- "co_counsel_contact_id": 0
}, - "primary_web_site": {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "legal_aid_uk_contact": {
- "id": 0,
- "disability": 0,
- "disability_code": "string",
- "ethnicity": 0,
- "ethnicity_title": "string",
- "financially_eligible": true,
- "gender": 0,
- "gender_title": "string",
- "national_insurance_number": "string"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Contact
id required | integer <int64> The unique identifier for the Contact. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Email Addresses are email addresses associated with a Contact. This endpoint returns all email addresses associated with a Contact.
Outlines the parameters, optional and required, used when requesting the data for all EmailAddresses
contact_id required | integer <int64> ID of the Contact |
created_since | string <date-time> Filter EmailAddress records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter EmailAddress records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of EmailAddress records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter EmailAddress records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "string",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Phone Numbers are phone numbers associated with a Contact. This endpoint returns all phone numbers associated with a Contact.
Outlines the parameters, optional and required, used when requesting the data for all PhoneNumbers
contact_id required | integer <int64> ID of the Contact |
created_since | string <date-time> Filter PhoneNumber records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter PhoneNumber records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of PhoneNumber records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter PhoneNumber records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "name": "Work",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Notes can be added to Matters or Contacts in Clio to record meeting notes, research, or anything else a user might want. The field can hold hundreds of pages, so users can add plenty of information.
Notes can be found either on the Matters or Contacts page under the Notes sub tab.
Outlines the parameters, optional and required, used when requesting the data for all Notes
contact_id | integer <int64> The unique identifier for a single Contact. The keyword |
created_since | string <date-time> Filter Note records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
has_time_entries | boolean Filter Note records to those with or without associated time entries. |
ids[] | integer <int64> Filter Note records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Note records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. The keyword |
order | string Enum: "id(asc)" "id(desc)" "date(asc)" "date(desc)" "author(asc)" "author(desc)" "updated_at(asc)" "updated_at(desc)" Orders the Note records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search across note subject and detail. |
type required | string Enum: "Matter" "Contact" Filter Note records to those of the specified type. |
updated_since | string <date-time> Filter Note records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "author": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new Note
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Notes
required | object | ||||||||||||||||
|
{- "data": {
- "contact": {
- "id": 0
}, - "date": "2019-08-24",
- "detail": "string",
- "detail_text_type": "plain_text",
- "matter": {
- "id": 0
}, - "notification_event_subscribers": [
- {
- "user_id": "string"
}
], - "subject": "string",
- "type": "Matter"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "author": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Note
id required | integer <int64> The unique identifier for the Note. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "author": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters and data fields used when updating a single Note
id required | integer <int64> The unique identifier for the Note. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Notes
required | object | ||||||||||
|
{- "data": {
- "date": "2019-08-24",
- "detail": "string",
- "detail_text_type": "plain_text",
- "notification_event_subscribers": [
- {
- "user_id": "string",
- "id": 0,
- "_destroy": true
}
], - "subject": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "author": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Note
id required | integer <int64> The unique identifier for the Note. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Log Entries populate the “Recents” dropdown in the header. The “Recent” section displays the ten Matters and Contacts that the user most recently accessed.
When a user accesses a Contact or a Matter, a Log Entry is created.
Outlines the parameters, optional and required, used when requesting the data for all LogEntries
created_since | string <date-time> Filter LogEntry records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter LogEntry records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of LogEntry records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "accessed_at(asc)" "accessed_at(desc)" Orders the LogEntry records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter LogEntry records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "type": "MatterLogEntry",
- "accessed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Jurisdictions-to-Triggers calculates the effective dates of related court and agency rules that a lawyer must do for a Trigger. A Trigger is an activity or event which a lawyer or court does in a jurisdiction.
These activities and events have corresponding deadlines, which the firm must be aware of. These deadlines can be before or after the Trigger. Example Triggers are “Mediation-Session Completed, “Notice of Appeal Filed,” ” or “Settlement Conference.”
Jurisdiction Triggers are part of the Court Rules feature which is not available to all plan types. See here for feature support across different plans.
Note that only account Administrators can add Court Rules jurisdictions.
Outlines the parameters, optional and required, used when requesting the data for all JurisdictionsToTriggers
jurisdiction_id required | integer <int64> The unique identifier for the Jurisdiction. |
created_since | string <date-time> Filter JurisdictionsToTrigger records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter JurisdictionsToTrigger records to those having the specified unique identifiers. |
is_requirements_required | boolean Filter JurisdictionsToTrigger records to those which require addition requirements to be checked (usually specifying trigger time). |
is_served | boolean Filter JurisdictionsToTrigger records to those which require a service type to be selected. |
limit | integer <int32> A limit on the number of JurisdictionsToTrigger records to be returned. Limit can range between 1 and 1000. Default: |
order | string Enum: "description(asc)" "description(desc)" "id(asc)" "id(desc)" Orders the JurisdictionsToTrigger records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
updated_since | string <date-time> Filter JurisdictionsToTrigger records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "system_id": 0,
- "description": "string",
- "do_not_recalculate": true,
- "is_served": true,
- "is_requirements_required": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single JurisdictionsToTrigger
id required | integer <int64> The unique identifier for the JurisdictionsToTrigger. |
jurisdiction_id required | integer <int64> The unique identifier for the Jurisdiction. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "system_id": 0,
- "description": "string",
- "do_not_recalculate": true,
- "is_served": true,
- "is_requirements_required": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
There are over 1000 jurisdictions available to choose from when using Court Rules. These jurisdictions contain state, federal, appellate, and bankruptcy courts from across the United States.
Jurisdictions are part of the Court Rules feature which is not available to all plan types. See here for feature support across different plans.
Outlines the parameters, optional and required, used when requesting the data for all Jurisdictions
created_since | string <date-time> Filter Jurisdiction records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
for_current_account | boolean Filter Jurisdiction records to those set up for this account. |
ids[] | integer <int64> Filter Jurisdiction records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Jurisdiction records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "description(asc)" "description(desc)" "id(asc)" "id(desc)" Orders the Jurisdiction records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
updated_since | string <date-time> Filter Jurisdiction records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true,
- "display_timezone": "string",
- "valid_subscription": true,
- "is_local_timezone": true,
- "service_types": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true
}
]
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single Jurisdiction
id required | integer <int64> The unique identifier for the Jurisdiction. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true,
- "display_timezone": "string",
- "valid_subscription": true,
- "is_local_timezone": true,
- "service_types": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true
}
]
}
}
A Matter Docket connects a Matter with a Court Rule (and all of the Calendar Entries associated with the Court Rule). Matter Dockets are viewable on the Matter Edit screen under the Court Rules heading.
Matter Dockets are part of the Court Rules feature which is not available to all plan types. See here for feature support across different plans.
Preview calendar dates for the docket
event_prefix | string The prefix that will be added to the beginning of all court rule event titles |
jurisdiction[id] required | integer <int64> The unique identifier for a single Jurisdiction. The keyword |
service_type[id] required | integer <int64> The unique identifier for a single ServiceType. The keyword |
start_date required | string <date-time> The date the MatterDocket should start. (Expects an ISO-8601 date). |
start_time required | string <date-time> The time the MatterDocket should start. (Expects an ISO-8601 timestamp). |
trigger[id] required | integer <int64> The unique identifier for a single JurisdictionsToTrigger. The keyword |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all MatterDockets
created_since | string <date-time> Filter MatterDocket records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter MatterDocket records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of MatterDocket records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. The keyword |
matter_status | string Enum: "open" "closed" "pending" Filter MatterDocket records to those with Matters having a specific status. |
order | string Enum: "id(asc)" "id(desc)" "date(asc)" "date(desc)" Orders the MatterDocket records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
service_type_id | integer <int64> The unique identifier for a single ServiceType. Use the keyword |
status | string Enum: "not_started," "in_progress," "failed," "completed" Filter MatterDocket records to those having a specific status. |
updated_since | string <date-time> Filter MatterDocket records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "start_date": "2019-08-24",
- "start_time": "2019-08-24T14:15:22Z",
- "status": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "jurisdiction": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true,
- "display_timezone": "string",
- "valid_subscription": true,
- "is_local_timezone": true
}, - "trigger": {
- "id": 0,
- "etag": "string",
- "system_id": 0,
- "description": "string",
- "do_not_recalculate": true,
- "is_served": true,
- "is_requirements_required": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "service_type": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true
}, - "calendar_entries": [
- {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0
}
]
}
]
}
Outlines the parameters and data fields used when creating a new MatterDocket
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Matter Dockets
required | object | ||||||||||
|
{- "data": {
- "jurisdiction": {
- "id": 0
}, - "name": "string",
- "start_date": "2019-08-24",
- "start_time": "2019-08-24T14:15:22Z",
- "trigger": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "start_date": "2019-08-24",
- "start_time": "2019-08-24T14:15:22Z",
- "status": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "jurisdiction": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true,
- "display_timezone": "string",
- "valid_subscription": true,
- "is_local_timezone": true
}, - "trigger": {
- "id": 0,
- "etag": "string",
- "system_id": 0,
- "description": "string",
- "do_not_recalculate": true,
- "is_served": true,
- "is_requirements_required": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "service_type": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true
}, - "calendar_entries": [
- {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single MatterDocket
id required | integer <int64> The unique identifier for the MatterDocket. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "start_date": "2019-08-24",
- "start_time": "2019-08-24T14:15:22Z",
- "status": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "jurisdiction": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true,
- "display_timezone": "string",
- "valid_subscription": true,
- "is_local_timezone": true
}, - "trigger": {
- "id": 0,
- "etag": "string",
- "system_id": 0,
- "description": "string",
- "do_not_recalculate": true,
- "is_served": true,
- "is_requirements_required": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "service_type": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true
}, - "calendar_entries": [
- {
- "id": "string",
- "etag": "string",
- "summary": "string",
- "description": "string",
- "location": "string",
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "all_day": true,
- "recurrence_rule": "string",
- "parent_calendar_entry_id": 0,
- "court_rule": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "permission": "string",
- "calendar_owner_id": 0,
- "start_at_time_zone": "string",
- "time_entries_count": 0
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single MatterDocket
id required | integer <int64> The unique identifier for the MatterDocket. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Service Types are used when creating new Court Rules involving the delivery of documents. In order to calculate the correct deadline to send the document, an account will specify their Service Type.
Current Service Types;
Service Types are part of the Court Rules feature which is not available to all plan types. See here for feature support across different plans.
Outlines the parameters, optional and required, used when requesting the data for all ServiceTypes
created_since | string <date-time> Filter ServiceType records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter ServiceType records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of ServiceType records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "description(asc)" "description(desc)" "id(asc)" "id(desc)" Orders the ServiceType records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter ServiceType records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single ServiceType
id required | integer <int64> The unique identifier for the ServiceType. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "system_id": 0,
- "description": "string",
- "default": true
}
}
Outlines the parameters, optional and required, used when requesting the data for all CustomFields
created_since | string <date-time> Filter CustomField records to those having the |
deleted | boolean Filter CustomField records to those that have been deleted for future use. |
field_type | string Enum: "checkbox" "contact" "currency" "date" "time" "email" "matter" "numeric" "picklist" "text_area" "text_line" "url" Field type of this custom field |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter CustomField records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of CustomField records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" "display_order(asc)" "display_order(desc)" Orders the CustomField records by the given field. Default: |
page_token | string A token specifying which page to return. |
parent_type | string Enum: "matter" "contact" Filter CustomField records to those that have the specified |
query | string Wildcard search for |
updated_since | string <date-time> Filter CustomField records to those having the |
visible_and_required | boolean Filter CustomField records to those that are visible and required. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new CustomField
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Custom Fields
required | object | ||||||||||||||
|
{- "data": {
- "display_order": 0,
- "displayed": true,
- "field_type": "checkbox",
- "name": "string",
- "parent_type": "Contact",
- "picklist_options": [
- {
- "id": 0,
- "option": "string",
- "_deleted": true
}
], - "required": false
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single CustomField
id required | integer <int64> The unique identifier for the CustomField. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters and data fields used when updating a single CustomField
id required | integer <int64> The unique identifier for the CustomField. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Custom Fields
required | object | ||||||||||
|
{- "data": {
- "display_order": 0,
- "displayed": true,
- "name": "string",
- "picklist_options": [
- {
- "id": 0,
- "option": "string",
- "_deleted": true
}
], - "required": false
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single CustomField
id required | integer <int64> The unique identifier for the CustomField. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all CustomFieldSets
created_since | string <date-time> Filter CustomFieldSet records to those having the |
displayed | boolean Filter CustomFieldSet records to those that should be displayed by default. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter CustomFieldSet records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of CustomFieldSet records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "name(asc)" "name(desc)" "id(asc)" "id(desc)" "parent_type(asc)" "parent_type(desc)" Orders the CustomFieldSet records by the given field. Default: |
page_token | string A token specifying which page to return. |
parent_type | string Enum: "Matter" "Contact" Filter CustomFieldSet records to those that have the specified |
query | string Wildcard search for |
updated_since | string <date-time> Filter CustomFieldSet records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "parent_type": "Contact",
- "displayed": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom_fields": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0
}
]
}
]
}
Outlines the parameters and data fields used when creating a new CustomFieldSet
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Custom Field Sets
required | object | ||||||
|
{- "data": {
- "displayed": true,
- "name": "string",
- "parent_type": "Contact"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "parent_type": "Contact",
- "displayed": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom_fields": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single CustomFieldSet
id required | integer <int64> The unique identifier for the CustomFieldSet. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "parent_type": "Contact",
- "displayed": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom_fields": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0
}
]
}
}
Outlines the parameters and data fields used when updating a single CustomFieldSet
id required | integer <int64> The unique identifier for the CustomFieldSet. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Custom Field Sets
required | object | ||||||
|
{- "data": {
- "displayed": true,
- "name": "string",
- "parent_type": "Contact"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "parent_type": "Contact",
- "displayed": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom_fields": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single CustomFieldSet
id required | integer <int64> The unique identifier for the CustomFieldSet. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Clio Documents are files uploaded to Clio. Files uploaded to Clio’s document integrations (e.g. Google Drive and Office365) are inaccessible through the API.
Create a document to a parent that can refer to a Matter
or a Folder
. Ensure to ask for the fields, id
and latest_document_version{uuid,put_url,put_headers}
. The put_url
is a signed URL with security credentials for uploading the document. The put_headers
are required request headers for uploading the document. Check out the example to upload a new document to the matter folder of Matter
with id 1
:
Request
POST api/v4/documents?fields=id,latest_document_version{uuid,put_url,put_headers}
"data": {
"name": "file.jpg",
"parent": {
"id": 1,
"type": "Matter"
}
}
Response
{
"data": {
"id": 1234,
"latest_document_version": {
"uuid": "a51faa2c-859e-4c08-a996-2d0bb385df90",
"put_url": "https://s3.us-west-2.amazonaws.com/iris-production/uploads/document_version/file/a51faa2c-859e-4c08-a996-2d0bb385df90/file.jpg?X-Amz-Expires=28800&X-Amz-Date=20171024T214532Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential={aws_access_key}/20171024/us-west-2/s3/aws4_request&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Signature=afe5000df0972d02884a2219f913bfa62fe2531c75b4fcd1edbcb84d267d2b8e",
"put_headers": [
{
"name": "x-amz-server-side-encryption",
"value": "AES256"
},
{
"name": "Content-Type",
"value": "image/jpeg"
}
]
}
}
}
If the extension is listed in the IANA Media Types registry Clio will apply the corresponding content type as determined by the file extension when content_type
is blank. One of the nine possible content types content_type
= “text” / “image” / “audio” / “video” / “application” / “font” / “model” / “message” / “multipart” must be submitted if the file type is uncommon, not listed in the IANA Media Types registry or not obvious from the extension.
Upload the document to the put_url
with the headers from puts_headers
given in the response of the previous step. Typically the headers include Content-Type
and x-amz-server-side-encryption
to match with the signature in the put_url
. Check out the example to upload the file content using curl:
curl -X PUT -T file.jpg
-H "Content-Type: image/jpeg"
-H "x-amz-server-side-encryption: AES256"
"https://s3.us-west-2.amazonaws.com/iris-production/uploads/document_version/file/a51faa2c-859e-4c08-a996-2d0bb385df90/file.jpg?X-Amz-Expires=28800&X-Amz-Date=20171024T214532Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential={aws_access_key}/20171024/us-west-2/s3/aws4_request&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Signature=afe5000df0972d02884a2219f913bfa62fe2531c75b4fcd1edbcb84d267d2b8e"
If you need MD5 checksum, you should use multipart upload.
After successfully completing the upload, mark the document fully uploaded with fully_uploaded
as true
, and uuid
given in the first step. Clio will verify if the file is uploaded successfully. If not, it raises UploadNotFoundError
error. It is possible for the verification to time out, which will return an UploadTimeoutError
error. When that happens, you will need to retry the request.
Request
PATCH api/v4/documents/1234?fields=id,latest_document_version{fully_uploaded}
"data": {
"uuid": "a51faa2c-859e-4c08-a996-2d0bb385df90",
"fully_uploaded": "true"
}
}
Response (success)
{
"data": {
"id": 12345,
"latest_document_version": {
"fully_uploaded": true
}
}
}
Response (error)
{
"error": {
"type": "UploadNotFoundError",
"message": "A matching remote file was not found for the file named file.jpg with UUID a51faa2c-859e-4c08-a996-2d0bb385df90"
}
}
Response (timeout)
{
"error": {
"type": "UploadTimeoutError",
"message": "A timeout occurred verifying the remote file. Please try the request again."
}
}
The file is now visible in Clio documents and is available to the user for download.
It is same as uploading a new document to Clio except setting the parent
to an existing Document
. Check out the example to upload a new document version for the document with id 1234
:
Request
POST api/v4/documents?fields=id,latest_document_version{uuid,put_url,put_headers}
"data": {
"name": "file.jpg",
"parent": {
"id": 1234,
"type": "Document"
}
}
}
The remaining steps are same as uploading a new document to Clio.
In general, when a file reaches 100 MB, you should consider using multipart upload instead of uploading in a single operation. Except the last part, each part should be at least 5 MB. Determine the number of file parts and split the file. Optionally, you may compute the base64-encoded 128-bit MD5 mechanism as an end-to-end integrity check for each file part. To determine the base64 MD5 checksum for a file part, you may use openssl
. Check out the example to split a big pdf and get the checksums of the file parts:
split -b 31457280 big.pdf big.pdf. # break the file to max. 30MB size
openssl md5 -binary big.pdf.aa | base64 # F16pda4G0h4lzH7d2/Jbdw==
openssl md5 -binary big.pdf.ab | base64 # cRbxEG//GK9rIze5tdYzcg==
openssl md5 -binary big.pdf.ac | base64 # Tck0KKU4SrmSp8hsSCuSYg==
openssl md5 -binary big.pdf.ad | base64 # CrIt7lbZzVhMV7JzVTkUvw==
Create a document, specify multiparts
for multipart upload, and ensure to ask for the fields, id
, and latest_document_version{uuid,multiparts}
. A multipart
consists of part_number
, content_length
, and optional content_md5
. In the response, a put_url
is appended to the multipart
. A put_url
is a signed URL with security credentials for uploading a file part. The signed URL expires in 8 hours. The API can handle maximum 50 multiparts
in one request. If the upload is split to more than 50 parts, make a PUT request with uuid
, fully_uploaded
as false
, and another set of multiparts
. It returns a set of put_url
for the specified multiparts
. Check out the example to upload a new document to the matter folder of Matter
with id 1
:
Request
POST api/v4/documents?fields=id,latest_document_version{uuid,put_headers,multiparts}
"data": {
"name": "big.pdf",
"parent": {
"id": 1,
"type": "Matter"
}
"multiparts": [
{
"part_number": 1,
"content_length": 31457280,
"content_md5": "F16pda4G0h4lzH7d2/Jbdw=="
},
{
"part_number": 2,
"content_length": 31457280,
"content_md5": "cRbxEG//GK9rIze5tdYzcg=="
},
{
"part_number": 3,
"content_length": 31457280,
"content_md5": "Tck0KKU4SrmSp8hsSCuSYg=="
},
{
"part_number": 4,
"content_length": 7316647,
"content_md5": "CrIt7lbZzVhMV7JzVTkUvw=="
}
]
}
Response
{
"data": {
"id": 1234,
"latest_document_version": {
"uuid": "eba78724-31e8-4529-b6e2-0f2eef6feeec",
"put_headers": [
{
"name": "x-amz-server-side-encryption",
"value": "AES256"
},
{
"name": "Content-Type",
"value": "application/pdf"
}
],
"multiparts": [
{
"part_number": 1,
"put_url": "https://s3.us-west-2.amazonaws.com/iris-production/uploads/document_version/file/eba78724-31e8-4529-b6e2-0f2eef6feeec/big.pdf?uploadId=XG9arnSRfpXVFj4NYCoj66e.iUtET050CFds7GGwb4_J6J26Ysgn_fLCK7pI5KRzJRmBOB_Oa.dle.nn4JLKos_cdRXN6f6Hb0IACkgiN6Wa2XGNv9fZQwgfqmMey1DN&partNumber=1&X-Amz-Expires=28800&X-Amz-Date=20171024T231538Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential={aws_access_token}/20171024/us-west-2/s3/aws4_request&X-Amz-SignedHeaders=content-length%3Bcontent-md5%3Bhost&X-Amz-Signature=f7b3f29e4aee3abfa93fb42a7969557a2a0d305d223dde641c78421b5a6d62e0",
"put_headers": [
{
"name": "Content-Length",
"value": "31457280"
},
{
"name": "Content-MD5",
"value": "F16pda4G0h4lzH7d2/Jbdw=="
}
]
},
{
"part_number": 2,
"put_url": "https://s3.us-west-2.amazonaws.com/iris-production/uploads/document_version/file/eba78724-31e8-4529-b6e2-0f2eef6feeec/big.pdf?uploadId=XG9arnSRfpXVFj4NYCoj66e.iUtET050CFds7GGwb4_J6J26Ysgn_fLCK7pI5KRzJRmBOB_Oa.dle.nn4JLKos_cdRXN6f6Hb0IACkgiN6Wa2XGNv9fZQwgfqmMey1DN&partNumber=2&X-Amz-Expires=28800&X-Amz-Date=20171024T231538Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential={aws_access_token}/20171024/us-west-2/s3/aws4_request&X-Amz-SignedHeaders=content-length%3Bcontent-md5%3Bhost&X-Amz-Signature=47dc30f90202654c13030ccce87e43622bb47e0ad155ae61f6b41e8097803950",
"put_headers": [
{
"name": "Content-Length",
"value": "31457280"
},
{
"name": "Content-MD5",
"value": "cRbxEG//GK9rIze5tdYzcg=="
}
]
},
{
"part_number": 3,
"put_url": "https://s3.us-west-2.amazonaws.com/iris-production/uploads/document_version/file/eba78724-31e8-4529-b6e2-0f2eef6feeec/big.pdf?uploadId=XG9arnSRfpXVFj4NYCoj66e.iUtET050CFds7GGwb4_J6J26Ysgn_fLCK7pI5KRzJRmBOB_Oa.dle.nn4JLKos_cdRXN6f6Hb0IACkgiN6Wa2XGNv9fZQwgfqmMey1DN&partNumber=3&X-Amz-Expires=28800&X-Amz-Date=20171024T231538Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential={aws_access_token}/20171024/us-west-2/s3/aws4_request&X-Amz-SignedHeaders=content-length%3Bcontent-md5%3Bhost&X-Amz-Signature=13ca827a73fb2c50e8062ef7e437cfe9158944d998e2770a2ffcd034be6c2fc7",
"put_headers": [
{
"name": "Content-Length",
"value": "31457280"
},
{
"name": "Content-MD5",
"value": "Tck0KKU4SrmSp8hsSCuSYg=="
}
]
},
{
"part_number": 4,
"put_url": "https://s3.us-west-2.amazonaws.com/iris-production/uploads/document_version/file/eba78724-31e8-4529-b6e2-0f2eef6feeec/big.pdf?uploadId=XG9arnSRfpXVFj4NYCoj66e.iUtET050CFds7GGwb4_J6J26Ysgn_fLCK7pI5KRzJRmBOB_Oa.dle.nn4JLKos_cdRXN6f6Hb0IACkgiN6Wa2XGNv9fZQwgfqmMey1DN&partNumber=4&X-Amz-Expires=28800&X-Amz-Date=20171024T231538Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential={aws_access_token}/20171024/us-west-2/s3/aws4_request&X-Amz-SignedHeaders=content-length%3Bcontent-md5%3Bhost&X-Amz-Signature=25773f971c4c663b3a87f4d35c5b4c5192c3c999c7efdd69a49bc5bc40677078",
"put_headers": [
{
"name": "Content-Length",
"value": "7316647"
},
{
"name": "Content-MD5",
"value": "CrIt7lbZzVhMV7JzVTkUvw=="
}
]
}
]
}
}
}
Upload each multipart to the corresponding put_url
. You can upload the parts independently and in any order. If transmission of any part fails, you can re-transmit that part without affecting other parts. Make sure to include the headers from puts_headers
. Typically the headers include Content-Length
, to match with the signature in the put_url
. Check out the example using curl:
curl -X PUT -T big.pdf.part1
-H "Content-Length: 31457280"
"https://s3.us-west-2.amazonaws.com/iris-production/uploads/document_version/file/eba78724-31e8-4529-b6e2-0f2eef6feeec/big.pdf?uploadId=XG9arnSRfpXVFj4NYCoj66e.iUtET050CFds7GGwb4_J6J26Ysgn_fLCK7pI5KRzJRmBOB_Oa.dle.nn4JLKos_cdRXN6f6Hb0IACkgiN6Wa2XGNv9fZQwgfqmMey1DN&partNumber=1&X-Amz-Expires=28800&X-Amz-Date=20171024T231538Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential={aws_access_token}/20171024/us-west-2/s3/aws4_request&X-Amz-SignedHeaders=content-length%3Bcontent-md5%3Bhost&X-Amz-Signature=f7b3f29e4aee3abfa93fb42a7969557a2a0d305d223dde641c78421b5a6d62e0"
If you use MD5 checksum to validate the integrity of upload, include Content-MD5
in the header:
curl -X PUT -T big.pdf.part1
-H "Content-Length: 31457280"
-H "Content-MD5: F16pda4G0h4lzH7d2/Jbdw=="
"https://s3.us-west-2.amazonaws.com/iris-production/uploads/document_version/file/eba78724-31e8-4529-b6e2-0f2eef6feeec/big.pdf?uploadId=XG9arnSRfpXVFj4NYCoj66e.iUtET050CFds7GGwb4_J6J26Ysgn_fLCK7pI5KRzJRmBOB_Oa.dle.nn4JLKos_cdRXN6f6Hb0IACkgiN6Wa2XGNv9fZQwgfqmMey1DN&partNumber=1&X-Amz-Expires=28800&X-Amz-Date=20171024T231538Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential={aws_access_token}/20171024/us-west-2/s3/aws4_request&X-Amz-SignedHeaders=content-length%3Bcontent-md5%3Bhost&X-Amz-Signature=f7b3f29e4aee3abfa93fb42a7969557a2a0d305d223dde641c78421b5a6d62e0"
If the file is invalid or the MD5 is invalid, you may get the following response:
<Error>
<Code>BadDigest</Code>
<Message>The Content-MD5 you specified did not match what we received.</Message>
<ExpectedDigest>F16pda4G0h4lzH7d2/Jbdw==</ExpectedDigest>
<CalculatedDigest>Tck0KKU4SrmSp8hsSCuSYg==</CalculatedDigest>
<RequestId>85918626116672DD</RequestId>
<HostId>AbAoiqYqn8tKwS6gxwI3pc4u02B6u6ORa6MPEJH7IYljBweZp0M8L7Lg2AFOvHxdHz5TwlQpkVs=</HostId>
</Error>
After the issue is corrected, try to upload to the file part to the put_url
again.
After successfully completing the upload of all the file parts, mark the document fully uploaded with fully_uploaded
as true
, and uuid
given in the first step. Clio will verify if the file is uploaded successfully. If not, it raises UploadNotFoundError
error. It is possible for the verification to time out, which will return an UploadTimeoutError
error. When that happens, you will need to retry the request.
Request
PATCH api/v4/documents/1234?fields=id,latest_document_version{fully_uploaded}
"data": {
"uuid": "eba78724-31e8-4529-b6e2-0f2eef6feeec",
"fully_uploaded": "true"
}
}
Response (success)
{
"data": {
"id": 12345,
"latest_document_version": {
"fully_uploaded": true
}
}
}
Response (error)
{
"error": {
"type": "UploadNotFoundError",
"message": "A matching remote file was not found for the file named file.jpg with UUID a51faa2c-859e-4c08-a996-2d0bb385df90"
}
}
Response (timeout)
{
"error": {
"type": "UploadTimeoutError",
"message": "A timeout occurred verifying the remote file. Please try the request again."
}
}
The file is now visible in Clio documents and is available to the user for download.
It is same as splitting and uploading a new document using multipart upload, except setting the parent
to an existing Document
. Check out the example to upload a new document version for the document with id 1234
:
Request
POST api/v4/documents?fields=id,latest_document_version{uuid,put_headers,multiparts}
"data": {
"name": "big.pdf",
"parent": {
"id": 1234,
"type": "Document"
}
"multiparts": [
{
"part_number": 1,
"content_length": 31457280,
"content_md5": "F16pda4G0h4lzH7d2/Jbdw=="
},
{
"part_number": 2,
"content_length": 31457280,
"content_md5": "cRbxEG//GK9rIze5tdYzcg=="
},
{
"part_number": 3,
"content_length": 31457280,
"content_md5": "Tck0KKU4SrmSp8hsSCuSYg=="
},
{
"part_number": 4,
"content_length": 7316647,
"content_md5": "CrIt7lbZzVhMV7JzVTkUvw=="
}
]
}
The remaining steps are same as uploading a new document to Clio.
Copies the latest document version of a Document into a new Document. The parameters filename
and name
will be copied from the source Document if none are provided.
id required | integer <int64> The unique identifier for the Document. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
Request Body for Documents
required | object | ||||||||||||||
|
{- "data": {
- "communication_id": 0,
- "document_category": {
- "id": 0
}, - "external_properties": [
- {
- "id": 0,
- "name": "string",
- "value": "string",
- "_destroy": true
}
], - "filename": "name",
- "name": "string",
- "parent": {
- "id": 0,
- "type": "Document"
}, - "received_at": "2019-08-24T14:15:22Z"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string",
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true,
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "put_headers": [
- {
- "name": "string",
- "value": "string"
}
], - "multiparts": [
- {
- "part_number": 0,
- "put_url": "string",
- "put_headers": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for all Documents
contact_id | integer <int64> The unique identifier for a single Contact. Use the keyword |
created_since | string <date-time> Filter Document records to those having the |
document_category_id | integer <int64> The unique identifier for a single DocumentCategory. Use the keyword |
external_property_name | string Filter records to only those with the given external property(s) name set. e.g. |
external_property_value | string Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Document records to those having the specified unique identifiers. |
include_deleted | boolean Allow trashed Document record to be included. |
limit | integer <int32> A limit on the number of Document records to be returned. Limit can range between 1 and 200. Default: |
locked | boolean Filter Document records to those that are locked. |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
order | string Enum: "created_at(asc)" "created_at(desc)" "document_number(asc)" "document_number(desc)" "id(asc)" "id(desc)" "name(asc)" "name(desc)" "received_at(asc)" "received_at(desc)" "updated_at(asc)" "updated_at(desc)" Orders the Document records by the given field. Default: |
page_token | string A token specifying which page to return. |
parent_id | integer <int64> The unique identifier for a single Folder. Use the keyword |
query | string Wildcard search for |
scope | string Enum: "descendants" "children" Filters Document record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is |
show_uncompleted | boolean Allow Document record being uploaded to be included. |
updated_since | string <date-time> Filter Document records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string",
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true,
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "put_headers": [
- {
- "name": "string",
- "value": "string"
}
], - "multiparts": [
- {
- "part_number": 0,
- "put_url": "string",
- "put_headers": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Create a Document, or Create Document Version to an existing Document.
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Documents
required | object | ||||||||||||||||||
|
{- "data": {
- "communication_id": 0,
- "content_type": "string",
- "document_category": {
- "id": 0
}, - "external_properties": [
- {
- "name": "string",
- "value": "string"
}
], - "filename": "name",
- "multiparts": [
- {
- "part_number": 0,
- "content_length": "string",
- "content_md5": "string"
}
], - "name": "string",
- "parent": {
- "id": 0,
- "type": "Document"
}, - "received_at": "2019-08-24T14:15:22Z"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string",
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true,
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "put_headers": [
- {
- "name": "string",
- "value": "string"
}
], - "multiparts": [
- {
- "part_number": 0,
- "put_url": "string",
- "put_headers": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Document
id required | integer <int64> The unique identifier for the Document. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string",
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true,
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "put_headers": [
- {
- "name": "string",
- "value": "string"
}
], - "multiparts": [
- {
- "part_number": 0,
- "put_url": "string",
- "put_headers": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Update Document, move Document to another Folder, and/or restore a trashed Document.
id required | integer <int64> The unique identifier for the Document. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Documents
required | object | ||||||||||||||||||||||
|
{- "data": {
- "communication_id": 0,
- "copy_version": true,
- "document_category": {
- "id": 0
}, - "external_properties": [
- {
- "id": 0,
- "name": "string",
- "value": "string",
- "_destroy": true
}
], - "fully_uploaded": true,
- "multiparts": [
- {
- "part_number": 0,
- "content_length": "string",
- "content_md5": "string"
}
], - "name": "string",
- "parent": {
- "id": 0,
- "type": "Document"
}, - "received_at": "2019-08-24T14:15:22Z",
- "restore": true,
- "uuid": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string",
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true,
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "put_headers": [
- {
- "name": "string",
- "value": "string"
}
], - "multiparts": [
- {
- "part_number": 0,
- "put_url": "string",
- "put_headers": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Deleting a Document using this method will move it to the trash instead of permanently deleting it. Trashed Documents are permanently deleted after 30 days. The following errors may be returned:
409 Conflict
: The Document (or one of its ancestor folders) is currently being modified by another request, and cannot be trashed.id required | integer <int64> The unique identifier for the Document. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Versions contain information about the version history of a document. Versioning allows users to track changes made to a document over time.
Outlines the parameters, optional and required, used when requesting the data for all DocumentVersions
id required | integer <int64> ID of the Document |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
fully_uploaded | boolean Filter DocumentVersion records to those with the given |
id required | integer <int64> The unique identifier for the DocumentVersion. |
limit | integer <int32> A limit on the number of DocumentVersion records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true,
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "put_headers": [
- {
- "name": "string",
- "value": "string"
}
], - "multiparts": [
- {
- "part_number": 0,
- "put_url": "string",
- "put_headers": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}
]
}
Files stored in Clio’s Documents section are organized in folders. Folders are automatically generated for new Contacts and Matters. Folders can also be manually created anywhere in the folder structure.
Return the data of the contents of a Folder.
contact_id | integer <int64> The unique identifier for a single Contact. Use the keyword |
created_since | string <date-time> Filter Folder records to those having the |
document_category_id | integer <int64> The unique identifier for a single DocumentCategory. Use the keyword |
external_property_name | string Filter records to only those with the given external property(s) name set. e.g. |
external_property_value | string Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Folder records to those having the specified unique identifiers. |
include_deleted | boolean Allow trashed Folder record to be included. |
limit | integer <int32> A limit on the number of Folder records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
order | string Enum: "id(asc)" "id(desc)" "document_number(asc)" "document_number(desc)" "name(asc)" "name(desc)" "updated_at(asc)" "updated_at(desc)" "created_at(asc)" "created_at(desc)" "received_at(asc)" "received_at(desc)" Orders the Folder records by the given field. Default: |
page_token | string A token specifying which page to return. |
parent_id | integer <int64> The unique identifier for a single Folder. When returning the data of the contents of a Folder, the keyword When returning the data for all Folders, use the keyword |
query | string Wildcard search for |
scope | string Enum: "descendants" "children" Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is |
show_uncompleted | boolean Allow Folder record being uploaded to be included. |
updated_since | string <date-time> Filter Folder records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters, optional and required, used when requesting the data for all Folders
contact_id | integer <int64> The unique identifier for a single Contact. Use the keyword |
created_since | string <date-time> Filter Folder records to those having the |
document_category_id | integer <int64> The unique identifier for a single DocumentCategory. Use the keyword |
external_property_name | string Filter records to only those with the given external property(s) name set. e.g. |
external_property_value | string Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Folder records to those having the specified unique identifiers. |
include_deleted | boolean Allow trashed Folder record to be included. |
limit | integer <int32> A limit on the number of Folder records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" Orders the Folder records by the given field. Default: |
page_token | string A token specifying which page to return. |
parent_id | integer <int64> The unique identifier for a single Folder. When returning the data of the contents of a Folder, the keyword When returning the data for all Folders, use the keyword |
query | string Wildcard search for |
scope | string Enum: "descendants" "children" Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is |
updated_since | string <date-time> Filter Folder records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true,
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Create a Folder to an existing folder.
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Folders
required | object | ||||||||||
|
{- "data": {
- "document_category": {
- "id": 0
}, - "external_properties": [
- {
- "name": "string",
- "value": "string"
}
], - "name": "string",
- "parent": {
- "id": 0,
- "type": "Folder"
}, - "restore": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true,
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Folder
id required | integer <int64> The unique identifier for the Folder. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true,
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Update Folder, move Folder to another Folder, and/or restore a trashed Folder.
id required | integer <int64> The unique identifier for the Folder. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Folders
required | object | ||||||||||
|
{- "data": {
- "document_category": {
- "id": 0
}, - "external_properties": [
- {
- "id": 0,
- "name": "string",
- "value": "string",
- "_destroy": true
}
], - "name": "string",
- "parent": {
- "id": 0,
- "type": "Folder"
}, - "restore": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true,
- "parent": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "id": 0,
- "type": "ManageUser",
- "initials": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "subscription_type": "Attorney",
- "time_zone": "string",
- "roles": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "latest_document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "external_properties": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "value": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Deleting a Folder using this method will move it to the trash instead of permanently deleting it. Trashed Folders are permanently deleted after 30 days. The following errors may be returned:
400 Bad Request
: The Folder cannot be trashed. The type
of the error will be DeleteFailed
and the message
of the error will be one of the following:Delete failed: This folder contains more than 100,000 items and cannot be trashed. Please trash some of the items inside it before trying again.
Delete failed: This item contains locked items and cannot be deleted.
Delete failed: The root folder cannot be trashed
409 Conflict
: The Folder (or one of its descendants) is currently being modified by another request, and cannot be trashed.id required | integer <int64> The unique identifier for the Folder. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters and data fields used when creating a new DocumentArchive
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Document Archives
required | object | ||||||||
|
{- "data": {
- "items": [
- {
- "id": 0,
- "type": 0
}
]
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "size": 0,
- "progress": 0.1,
- "state": "not_started",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for a single DocumentArchive
id required | integer <int64> The unique identifier for the DocumentArchive. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "size": 0,
- "progress": 0.1,
- "state": "not_started",
- "message": "string"
}
}
Document Automation uses Document Templates to create standardized documents. Users select a Document Template (that they have created and uploaded) and a Matter to automatically create a document using information from that Matter (such as addresses, account balances, Matter names, etc.).
Documents made from templates are created using Nintex, an authorized Clio sub-processor. For further information, please refer to Clio’s Privacy Policy and Terms of Service.
Outlines the parameters, optional and required, used when requesting the data for all DocumentAutomations
created_since | string <date-time> Filter DocumentAutomation records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter DocumentAutomation records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of DocumentAutomation records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" Orders the DocumentAutomation records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter DocumentAutomation records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "state": "not_started",
- "export_formats": "pdf",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "document_template": {
- "id": 0,
- "etag": "string",
- "size": 0,
- "content_type": "string",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new DocumentAutomation
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Document Automations
required | object | ||||||||
|
{- "data": {
- "document_template": {
- "id": 0
}, - "filename": "string",
- "formats": [
- "pdf"
], - "matter": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "state": "not_started",
- "export_formats": "pdf",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "document_template": {
- "id": 0,
- "etag": "string",
- "size": 0,
- "content_type": "string",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single DocumentAutomation
id required | integer <int64> The unique identifier for the DocumentAutomation. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "state": "not_started",
- "export_formats": "pdf",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "document_template": {
- "id": 0,
- "etag": "string",
- "size": 0,
- "content_type": "string",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "documents": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Document",
- "locked": true,
- "name": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "content_type": "string"
}
]
}
}
Clio users can add Document Categories to their account to help organize their Documents. When a Document is uploaded or edited, a Document Category can be assigned. Users can filter by Document Category to show all Documents in a certain category across all of the account’s Matters.
Outlines the parameters, optional and required, used when requesting the data for all DocumentCategories
created_since | string <date-time> Filter DocumentCategory records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter DocumentCategory records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of DocumentCategory records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" Orders the DocumentCategory records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Value: "name" Wildcard search for |
updated_since | string <date-time> Filter DocumentCategory records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Outlines the parameters and data fields used when creating a new DocumentCategory
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Document Categories
required | object | ||
|
{- "data": {
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Outlines the parameters, optional and required, used when requesting the data for a single DocumentCategory
id required | integer <int64> The unique identifier for the DocumentCategory. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Outlines the parameters and data fields used when updating a single DocumentCategory
id required | integer <int64> The unique identifier for the DocumentCategory. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Document Categories
required | object | ||
|
{- "data": {
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Outlines the parameters, optional and required, used when deleting the record for a single DocumentCategory
id required | integer <int64> The unique identifier for the DocumentCategory. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Document Templates are files used to create standardized documents using Clio’s Document Automation feature. Document Templates contain merge fields, which are used to pull information from Clio into the document being generated by Document Automation.
The supported formats are doc, docx, ppt, pptx, xls, xlsx, pdf and xml.
Outlines the parameters, optional and required, used when requesting the data for all DocumentTemplates
created_since | string <date-time> Filter DocumentTemplate records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter DocumentTemplate records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of DocumentTemplate records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "filename(asc)" "filename(desc)" "category.name(asc)" "category.name(desc)" "last_modified(asc)" "last_modified(desc)" "last_modified_by.name(asc)" "last_modified_by.name(desc)" Orders the DocumentTemplate records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter DocumentTemplate records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "size": 0,
- "content_type": "string",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "last_modified_by": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new DocumentTemplate
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Document Templates
required | object | ||||||
|
{- "data": {
- "document_category": {
- "id": 0
}, - "file": "string",
- "filename": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "size": 0,
- "content_type": "string",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "last_modified_by": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single DocumentTemplate
id required | integer <int64> The unique identifier for the DocumentTemplate. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "size": 0,
- "content_type": "string",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "last_modified_by": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single DocumentTemplate
id required | integer <int64> The unique identifier for the DocumentTemplate. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Document Templates
required | object | ||||||
|
{- "data": {
- "document_category": {
- "id": 0
}, - "file": "string",
- "filename": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "size": 0,
- "content_type": "string",
- "filename": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "document_category": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "last_modified_by": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single DocumentTemplate
id required | integer <int64> The unique identifier for the DocumentTemplate. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Comments are short text messages which can be associated with either Documents or Folders.
If the Comment is created in association with a Document, it will also be associated with the Document's latest Document Version.
Outlines the parameters, optional and required, used when requesting the data for all Comments
created_since | string <date-time> Filter Comment records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
item_id | integer <int64> The ID of the Document or Folder this Comment belongs to |
limit | integer <int32> A limit on the number of Comment records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter Comment records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "message": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}
}
]
}
Outlines the parameters and data fields used when creating a new Comment
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Comments
required | object | ||||
|
{- "data": {
- "item": {
- "id": 0
}, - "message": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "message": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Comment
id required | integer <int64> The unique identifier for the Comment. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "message": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}
}
}
Outlines the parameters and data fields used when updating a single Comment
id required | integer <int64> The unique identifier for the Comment. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Comments
required | object | ||||
|
{- "data": {
- "item": {
- "id": 0
}, - "message": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "message": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "document_version": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "uuid": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "size": 0,
- "version_number": 0,
- "content_type": "string",
- "received_at": "2019-08-24T14:15:22Z",
- "put_url": "string",
- "fully_uploaded": true
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Comment
id required | integer <int64> The unique identifier for the Comment. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
In-app notifications are used to notify firm users of important events or changes in Clio, initiated by other firm users. These events are displayed in the Your firm tab of the notifications panel.
Outlines the parameters, optional and required, used when requesting the data for all MyEvents
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
limit | integer <int32> A limit on the number of MyEvent records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "event": {
- "id": 0,
- "etag": "string",
- "message": "string",
- "icon": "string",
- "title": "string",
- "title_url": "string",
- "description": "string",
- "description_url": "string",
- "primary_detail": "string",
- "primary_detail_url": "string",
- "secondary_detail": "string",
- "secondary_detail_url": "string",
- "occurred_at": "2019-08-24T14:15:22Z",
- "mobile_icon": "string",
- "subject_type": "string",
- "subject_id": 0
}
}
]
}
Outlines the parameters and data fields used when updating a single MyEvent
id required | integer <int64> The unique identifier for the MyEvent. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for My Events
required | object | ||
|
{- "data": {
- "marked_as_read": true
}
}
{- "data": {
- "event": {
- "id": 0,
- "etag": "string",
- "message": "string",
- "icon": "string",
- "title": "string",
- "title_url": "string",
- "description": "string",
- "description_url": "string",
- "primary_detail": "string",
- "primary_detail_url": "string",
- "secondary_detail": "string",
- "secondary_detail_url": "string",
- "occurred_at": "2019-08-24T14:15:22Z",
- "mobile_icon": "string",
- "subject_type": "string",
- "subject_id": 0
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single MyEvent
id required | integer <int64> The unique identifier for the MyEvent. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Event metrics keep track of firm users' unread web and mobile In-app notifications and unread Clio Internal Messages.
Outlines the parameters, optional and required, used when requesting Event Metrics
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "unread_mobile_events": 0,
- "unread_web_events": 0,
- "unread_secure_messages": 0,
- "unread_client_portal_messages": 0,
- "unread_text_messages": 0
}
}
Matters in Clio represent a firm’s cases. All relevant information—Bills, Documents, Time Entries, etc.—are contained in the Matter. A user’s ability to access a Matter is controlled by the Matter Permission settings. A user without permission will be unable to view or update a Matter.
A Matter can be persisted with its associations in a single request. The followings detail the nested attributes to persist the associations.
A CustomFieldValue contains the value of a CustomField for a Matter. Below are some examples of how to create, read, update, and destroy the CustomFieldValues of a Matter:
Note: The value of id
used here is the value of the id
parameter in the response received when creating a new CustomField or one returned in a query of an existing CustomField.
Request
PATCH /api/v4/matters/1.json
{
data: {
custom_field_values: [
{ custom_field: { id: 2 }, value: "Initial value" }
]
}
}
Note: The id
of the CustomFieldValue is a composite value including the custom field type. Use this id
to update and destroy the CustomFieldValue.
The id
of the associated Custom Field can be found by querying the custom_field
for all CustomFieldValues related to the Matter, e.g.: /api/v4/matters/1?fields=id,display_number,custom_field_values{id,value,custom_field}
Note: The id
may be NULL
when the CustomField is displayed by default but has not yet been given a value.
Request
GET /api/v4/matters/1.json?fields=custom_field_values{id,value,custom_field}
{
data: {
custom_field_values: [
{
id: "text_line-1",
value: "Current value",
custom_field: { id: 2 }
}
]
}
}
Note: The value of the CustomFieldValue id
used here is a composite value and can be found by querying for all CustomFieldValues related to the Matter, e.g.: /api/v4/matters/1?fields=id,display_number,custom_field_values{id,value,custom_field}
Note: If the id
is NULL
, you must provide custom_field{id}
to create the CustomFieldValue and assign a value (see Create).
Request
PATCH /api/v4/matters/1.json
{
data: {
custom_field_values: [
{ id: "text_line-1", value: "Updated value" }
]
}
}
Note: The value of the CustomFieldValue id
used here is a composite value and can be found by querying for all CustomFieldValues related to the Matter, e.g.: /api/v4/matters/1?fields=id,display_number,custom_field_values{id,value}
Request
PATCH /api/v4/matters/1.json
{
data: {
custom_field_values: [
{ id: "picklist-2", _destroy: true }
]
}
}
Each Matter can be set up to be billed on an Hourly basis, Flat Fee basis, or on Contingency.
To set the rate type, assign custom_rate[type]
with one of the values, "HourlyRate"
, "FlatRate"
or "ContingencyFee"
.
By default, a Matter is billed on an hourly basis. If the rate type is modified, the persisted rates will be deleted.
Selecting the "HourlyRate"
type will record time entries based on the custom hourly rates.
A custom hourly rate can be associated to a User or a Group.
Checkout the sample request to update the hourly rates of a Matter:
Request
PATCH /api/v4/matters/1.json
{
data: {
custom_rate: {
type: "HourlyRate",
rates: [
// update a rate for a user
{ id: 1, rate: 100, user: { id: 1 } },
// update a rate for a group
{ id: 2, rate: 100, group: { id: 1 } },
// create a rate for a user
{ rate: 100, user: { id: 2 } },
// create a rate for a group
{ rate: 100, group: { id: 2 } },
// destroy a rate
{ id: 3, _destroy: true }
]
}
}
}
Selecting the "FlatRate"
type will bill the matter with a flat fee. A Matter can only have one flat rate.
For associated objects, you can specify _destroy
attribute to delete the rate.
Checkout the sample request to update the flat rate of a Matter:
Request
PATCH /api/v4/matters/1.json
{
data: {
custom_rate: {
type: "FlatRate",
rates: [
{
id: 1,
user: { id: 1 },
activity_description: { id: 1 },
rate: 100,
}
]
}
}
}
Selecting the "ContingencyFee"
type will specify a contingency fee percentage on a Matter and the award or settlement amount won at the completion of the case.
A Matter can only have one definition of contingency fee.
For associated objects, you can specify _destroy
attribute to delete the rate.
Contingency Fee Matters are not available to all plan types. See here for feature support across different plans.
Checkout the sample request to update the contingency fee of a Matter:
Request
PATCH /api/v4/matters/1.json
{
data: {
custom_rate: {
type: "ContingencyFee",
rates: [
{
id: 1,
user: { id: 1 },
rate: 20,
}
]
}
}
}
Clio supports tracking a matter budget directly within a Matter.
A Matter can only have one matter budget associated with it.
A matter budget can not be added to flat rate matters.
For associated objects, you can specify the _destroy
attribute to delete the Matter Budget.
Matter Budget are not available to all plan types. See here for feature support across different plans.
Check out the sample request to update the matter budget of a Matter:
Request
PATCH /api/v4/matters/1.json
{
data: {
matter_budget: {
budget: 5000000,
include_expenses: true,
notification_threshold: 100,
notify_users: true
users: [
{ id: 1 },
// destroy
{ id: 2, _destroy: true }
]
}
}
}
Clio supports associating a Grant with a Matter, using Grant Matters.
A Matter can have up to three Grants (and Grant Matters) associated with it.
For associated objects, you can specify the _destroy
attribute to delete Grant Matters.
Grant Matters are only for legal aid US customers
Checkout the sample request to update a Grant Matter:
Request
PATCH /api/v4/matters/1.json
{
data: {
"grant_matters": [
{"id":{{existing_grant_matter_id}}}
]
}
}
There are people and/or companies related to a Matter other than the client of the lawyer. Clio helps define how the entities relate to a Matter.
Checkout the sample request to update Relationships of a Matter:
Request
PATCH /api/v4/matters/1.json
{
data: {
relationships: [
// update
{ id: 1, contact: { id: 1 }, description: "Opposing Counsel" },
// create
{ contact: { id: 2 }, description: "Judge" },
// destroy
{ id: 2, _destroy: true }
]
}
}
Clio supports to track a Statute of Limitations date directly within a Matter.
It can be associated with reminders as a Task.
A Matter can only have one definition of Statue of Limitations.
For associated objects, you can specify _destroy
attribute to delete the Statue of Limitations.
Check out the sample request to update the Statue of Limitations and its reminders of a Matter:
Request
PATCH /api/v4/matters/1.json
{
data: {
statue_of_limitations: [
due_at: "20201231",
status: "open",
reminders: [
// update
{ id: 1, duration_unit: "days", duration_value: 1, notification_method: { id: 1 } },
// create
{ duration_unit: "days", duration_value: 1, notification_method: { id: 2 } },
// destroy
{ id: 2, _destroy: true }
]
]
}
}
Clio supports assigning task template lists to a matter from with the same request that creates or updates a matter. Please note that a task template list can only be assigned. Once a task template list is assigned, it cannot be modified or destroyed.
Checkout the sample request to assign a task template list id to a matter:
Request
PATCH /api/v4/matters/1.json
{
data: {
task_template_list_instances: [
{
notify_assignees: true,
task_template_list: {id: 1},
},
{
notify_assignees: false,
task_template_list: {id: 2},
}
],
}
}
Outlines the parameters, optional and required, used when requesting the data for all Matters
billable | boolean Filter Matter records to those which are billable. |
client_id | integer <int64> The unique identifier for a single Contact. The keyword |
close_date[] | string Enum: ">DATE" ">=DATE" "=DATE" "<=DATE" "<DATE" Filter Matter records by the close date. The date should be provided in the format YYYY-MM-DD. e.g. You can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending e.g. Note that, when providing multiple values for this filter, only Matter records that meet all filter conditions will be returned. |
created_since | string <date-time> Filter Matter records to those having the |
currency_id | integer <int64> Filter Matter records to those of a specific currency. |
custom_field_ids[] | integer <int64> Filter Matter's custom_field_values to only include values for the given custom field unique identifiers. |
custom_field_values | string Enum: "=" "<" ">" "<=" ">=" 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. Supported operators:
e.g.
e.g.
e.g. 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. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
grant_id | integer <int64> The unique identifier for a single Grant. Use the keyword |
group_id | integer <int64> The unique identifier for a single Group. The keyword |
ids[] | integer <int64> Filter Matter records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Matter records to be returned. Limit can range between 1 and 200. Default: |
notification_event_subscriber_user_id | integer <int64> The unique identifier for a single NotificationEventSubscriber. Use the keyword |
open_date[] | string Enum: ">DATE" ">=DATE" "=DATE" "<=DATE" "<DATE" Filter Matter records by the open date. The date should be provided in the format YYYY-MM-DD. e.g. You can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending e.g. Note that, when providing multiple values for this filter, only Matter records that meet all filter conditions will be returned. |
order | string Enum: "display_number(asc)" "display_number(desc)" "custom_number(asc)" "custom_number(desc)" "id(asc)" "id(desc)" "client.name(asc)" "client.name(desc)" "open_date(asc)" "open_date(desc)" "practice_area.name(asc)" "practice_area.name(desc)" "matter_stage.name(asc)" "matter_stage.name(desc)" "responsible_attorney.name(asc)" "responsible_attorney.name(desc)" "close_date(asc)" "close_date(desc)" "pending_date(asc)" "pending_date(desc)" "updated_at(asc)" "updated_at(desc)" "created_at(asc)" "created_at(desc)" "statute_of_limitations.due_at(asc)" "statute_of_limitations.due_at(desc)" "originating_attorney.name(asc)" "originating_attorney.name(desc)" "grants(asc)" "grants(desc)" "matter_stage_updated_at(asc)" "matter_stage_updated_at(desc)" Orders the Matter records by the given field. Default: |
originating_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
page_token | string A token specifying which page to return. |
pending_date[] | string Enum: ">DATE" ">=DATE" "=DATE" "<=DATE" "<DATE" Filter Matter records by the pending date. The date should be provided in the format YYYY-MM-DD. e.g. You can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending e.g. Note that, when providing multiple values for this filter, only Matter records that meet all filter conditions will be returned. |
practice_area_id | integer <int64> The unique identifier for a single PracticeArea. The keyword |
query | string Wildcard search for |
responsible_attorney_id | integer <int64> The unique identifier for a single User. Use the keyword |
responsible_staff_id | integer <int64> The unique identifier for a single User. Use the keyword |
status | string Enum: "open" "closed" "pending" Filter Matter records to those with a given status. It accepts comma-separated statuses, e.g. |
subscriber_user_id | integer <int64> The unique identifier for a single NotificationEventSubscriber. Use the keyword |
updated_since | string <date-time> Filter Matter records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z",
- "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "contingency_fee": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "show_contingency_award": true
}, - "custom_rate": {
- "type": "FlatRate",
- "on_invoice": true,
- "rates": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rate": 0.1,
- "award": 0.1,
- "note": "string",
- "date": "2019-08-24",
- "user": {
- "enabled": true,
- "etag": "string",
- "id": 0,
- "name": "string"
}, - "group": {
- "etag": "string",
- "id": 0,
- "name": "string"
}, - "activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string"
}
}
]
}, - "evergreen_retainer": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "minimum_threshold": 0.1
}, - "folder": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter_budget": {
- "id": 0,
- "etag": "string",
- "budget": 0.1,
- "include_expenses": true,
- "notification_threshold": 0,
- "notify_users": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter_stage": {
- "id": 0,
- "etag": "string",
- "practice_area_id": "string",
- "name": "string",
- "order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "originating_attorney": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "practice_area": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}, - "responsible_attorney": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "responsible_staff": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "statute_of_limitations": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "status": "pending",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "due_at": "2019-08-24",
- "permission": "string",
- "completed_at": "2019-08-24T14:15:22Z",
- "notify_completion": true,
- "statute_of_limitations": true,
- "time_estimated": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "legal_aid_uk_matter": {
- "access_point": "string",
- "laa_office_number": "string",
- "ait_hearing_centre": 0,
- "attended_several_hearings_acting_for_multiple_clients": true,
- "bill_ho_ucn": "string",
- "bill_number_of_attendances": 0,
- "bill_outcome_for_the_client_code": 0,
- "bill_stage_reached_code": 0,
- "case_reference": "string",
- "case_start_date": "2019-08-24",
- "category": 0,
- "category_as_string": "string",
- "certificate_effective_date": "2019-08-24",
- "certificate_expiration_date": "2019-08-24",
- "certificate_number": "string",
- "certificate_scope": "string",
- "certification_type": 0,
- "change_of_solicitor": true,
- "client_equal_opportunity_monitoring": "string",
- "client_type": 0,
- "clr_start_date": "2019-08-24",
- "clr_total_profit_costs": "string",
- "cost_limit": "string",
- "counsel": 0,
- "court": 0,
- "court_id": 0,
- "court_id_code": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "delivery_location": "string",
- "dscc_number": "string",
- "duty_solicitor": true,
- "etag": "string",
- "exceptional_case_funding_reference": "string",
- "expense_limit": "string",
- "fee_scheme": 0,
- "first_conducting_solicitor": true,
- "id": 0,
- "irc_surgery": "string",
- "legacy_case": "string",
- "legal_representation_number": "string",
- "lh_total_disbursements": "string",
- "lh_start_date": "string",
- "lh_total_profit_costs": "string",
- "linked_matter_id": 0,
- "local_authority_number": "string",
- "maat_id": "string",
- "matter_type": 0,
- "matter_type_code": "string",
- "matter_type_1": 0,
- "matter_type_1_code": "string",
- "matter_type_1_title": "string",
- "matter_type_2": 0,
- "matter_type_2_code": "string",
- "matter_type_2_title": "string",
- "matter_types_combined": "string",
- "number_of_clients_seen_at_surgery": 0,
- "number_of_clients": 0,
- "party": 0,
- "police_station": "string",
- "post_transfer_clients_represented": 0,
- "postal_application_accepted": "string",
- "prior_authority_reference": "string",
- "prison_id": 0,
- "prison_law_prior_approval_number": "string",
- "procurement_area": "string",
- "region": 0,
- "related_claims_number": "string",
- "representation_order_date": "2019-08-24",
- "schedule_reference_number": "string",
- "scheme_id": "string",
- "session_type": 0,
- "solicitor_type": 0,
- "standard_fee_category": 0,
- "surgery_clients_resulting_in_a_legal_help_matter_opened": 0,
- "surgery_clients": 0,
- "surgery_date": "2019-08-24",
- "transfer_date": "2019-08-24",
- "type_of_advice": 0,
- "type_of_service": "string",
- "ucn": "string",
- "ufn": "string",
- "undesignated_area_court": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "user_type": 0,
- "youth_court": true
}, - "account_balances": [
- {
- "id": 0,
- "balance": 0.1,
- "type": "string",
- "name": "string",
- "currency_id": 0
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true,
- "custom_field": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "picklist_option": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "display_number": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "custom_field_set_associations": [
- {
- "id": 0,
- "etag": "string",
- "display_order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "matter_bill_recipients": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "recipient": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "relationships": [
- {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "task_template_list_instances": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "split_invoice_payers": [
- {
- "id": 0,
- "contact_id": 0,
- "matter_id": 0,
- "send_to_bill_recipients": true,
- "split_portion": 0.1,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new Matter
custom_field_ids[] | integer <int64> Filter Matter's custom_field_values to only include values for the given custom field unique identifiers. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Matters
required | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "billable": true,
- "client": {
- "id": 0
}, - "client_reference": "string",
- "close_date": "2019-08-24",
- "currency": { },
- "custom_field_set_associations": [
- {
- "display_order": 0,
- "custom_field_set": {
- "id": 0
}
}
], - "custom_field_values": [
- {
- "value": "string",
- "custom_field": {
- "id": 0
}
}
], - "custom_rate": {
- "type": "FlatRate",
- "rates": [
- {
- "user": {
- "id": 0
}, - "award": 0.1,
- "note": "string",
- "date": "2019-08-24",
- "rate": 0.1,
- "activity_description": {
- "id": 0
}, - "group": {
- "id": 0
}
}
]
}, - "description": "string",
- "display_number": "string",
- "evergreen_retainer": {
- "minimum_threshold": 0.1,
- "recipients": [
- {
- "id": 0,
- "_destroy": true
}
]
}, - "group": {
- "id": 0
}, - "location": "string",
- "matter_budget": {
- "_destroy": true,
- "budget": 0.1,
- "include_expenses": true,
- "notification_threshold": 0,
- "notify_users": false
}, - "matter_stage": {
- "id": 0
}, - "open_date": "2019-08-24",
- "originating_attorney": {
- "id": 0
}, - "pending_date": "2019-08-24",
- "practice_area": {
- "id": 0
}, - "relationships": [
- {
- "description": "string",
- "contact": {
- "id": 0
}
}
], - "reset_matter_number": false,
- "responsible_attorney": {
- "id": 0
}, - "responsible_staff": {
- "id": 0
}, - "split_invoice_payers": [
- {
- "contact_id": 0,
- "send_to_bill_recipients": true,
- "split_portion": 0.1
}
], - "status": "open",
- "statute_of_limitations": {
- "status": "pending",
- "due_at": "2019-08-24",
- "reminders": [
- {
- "duration_value": 0,
- "duration_unit": "string",
- "notification_method": {
- "id": 0
}
}
]
}, - "task_template_list_instances": [
- {
- "task_template_list": {
- "id": 0
}, - "assignee_id": 0,
- "notify_assignees": true,
- "due_at": "2019-08-24"
}
]
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z",
- "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "contingency_fee": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "show_contingency_award": true
}, - "custom_rate": {
- "type": "FlatRate",
- "on_invoice": true,
- "rates": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rate": 0.1,
- "award": 0.1,
- "note": "string",
- "date": "2019-08-24",
- "user": {
- "enabled": true,
- "etag": "string",
- "id": 0,
- "name": "string"
}, - "group": {
- "etag": "string",
- "id": 0,
- "name": "string"
}, - "activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string"
}
}
]
}, - "evergreen_retainer": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "minimum_threshold": 0.1
}, - "folder": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter_budget": {
- "id": 0,
- "etag": "string",
- "budget": 0.1,
- "include_expenses": true,
- "notification_threshold": 0,
- "notify_users": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter_stage": {
- "id": 0,
- "etag": "string",
- "practice_area_id": "string",
- "name": "string",
- "order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "originating_attorney": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "practice_area": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}, - "responsible_attorney": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "responsible_staff": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "statute_of_limitations": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "status": "pending",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "due_at": "2019-08-24",
- "permission": "string",
- "completed_at": "2019-08-24T14:15:22Z",
- "notify_completion": true,
- "statute_of_limitations": true,
- "time_estimated": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "legal_aid_uk_matter": {
- "access_point": "string",
- "laa_office_number": "string",
- "ait_hearing_centre": 0,
- "attended_several_hearings_acting_for_multiple_clients": true,
- "bill_ho_ucn": "string",
- "bill_number_of_attendances": 0,
- "bill_outcome_for_the_client_code": 0,
- "bill_stage_reached_code": 0,
- "case_reference": "string",
- "case_start_date": "2019-08-24",
- "category": 0,
- "category_as_string": "string",
- "certificate_effective_date": "2019-08-24",
- "certificate_expiration_date": "2019-08-24",
- "certificate_number": "string",
- "certificate_scope": "string",
- "certification_type": 0,
- "change_of_solicitor": true,
- "client_equal_opportunity_monitoring": "string",
- "client_type": 0,
- "clr_start_date": "2019-08-24",
- "clr_total_profit_costs": "string",
- "cost_limit": "string",
- "counsel": 0,
- "court": 0,
- "court_id": 0,
- "court_id_code": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "delivery_location": "string",
- "dscc_number": "string",
- "duty_solicitor": true,
- "etag": "string",
- "exceptional_case_funding_reference": "string",
- "expense_limit": "string",
- "fee_scheme": 0,
- "first_conducting_solicitor": true,
- "id": 0,
- "irc_surgery": "string",
- "legacy_case": "string",
- "legal_representation_number": "string",
- "lh_total_disbursements": "string",
- "lh_start_date": "string",
- "lh_total_profit_costs": "string",
- "linked_matter_id": 0,
- "local_authority_number": "string",
- "maat_id": "string",
- "matter_type": 0,
- "matter_type_code": "string",
- "matter_type_1": 0,
- "matter_type_1_code": "string",
- "matter_type_1_title": "string",
- "matter_type_2": 0,
- "matter_type_2_code": "string",
- "matter_type_2_title": "string",
- "matter_types_combined": "string",
- "number_of_clients_seen_at_surgery": 0,
- "number_of_clients": 0,
- "party": 0,
- "police_station": "string",
- "post_transfer_clients_represented": 0,
- "postal_application_accepted": "string",
- "prior_authority_reference": "string",
- "prison_id": 0,
- "prison_law_prior_approval_number": "string",
- "procurement_area": "string",
- "region": 0,
- "related_claims_number": "string",
- "representation_order_date": "2019-08-24",
- "schedule_reference_number": "string",
- "scheme_id": "string",
- "session_type": 0,
- "solicitor_type": 0,
- "standard_fee_category": 0,
- "surgery_clients_resulting_in_a_legal_help_matter_opened": 0,
- "surgery_clients": 0,
- "surgery_date": "2019-08-24",
- "transfer_date": "2019-08-24",
- "type_of_advice": 0,
- "type_of_service": "string",
- "ucn": "string",
- "ufn": "string",
- "undesignated_area_court": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "user_type": 0,
- "youth_court": true
}, - "account_balances": [
- {
- "id": 0,
- "balance": 0.1,
- "type": "string",
- "name": "string",
- "currency_id": 0
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true,
- "custom_field": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "picklist_option": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "display_number": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "custom_field_set_associations": [
- {
- "id": 0,
- "etag": "string",
- "display_order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "matter_bill_recipients": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "recipient": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "relationships": [
- {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "task_template_list_instances": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "split_invoice_payers": [
- {
- "id": 0,
- "contact_id": 0,
- "matter_id": 0,
- "send_to_bill_recipients": true,
- "split_portion": 0.1,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Matter
id required | integer <int64> The unique identifier for the Matter. |
custom_field_ids[] | integer <int64> Filter Matter's custom_field_values to only include values for the given custom field unique identifiers. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z",
- "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "contingency_fee": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "show_contingency_award": true
}, - "custom_rate": {
- "type": "FlatRate",
- "on_invoice": true,
- "rates": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rate": 0.1,
- "award": 0.1,
- "note": "string",
- "date": "2019-08-24",
- "user": {
- "enabled": true,
- "etag": "string",
- "id": 0,
- "name": "string"
}, - "group": {
- "etag": "string",
- "id": 0,
- "name": "string"
}, - "activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string"
}
}
]
}, - "evergreen_retainer": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "minimum_threshold": 0.1
}, - "folder": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter_budget": {
- "id": 0,
- "etag": "string",
- "budget": 0.1,
- "include_expenses": true,
- "notification_threshold": 0,
- "notify_users": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter_stage": {
- "id": 0,
- "etag": "string",
- "practice_area_id": "string",
- "name": "string",
- "order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "originating_attorney": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "practice_area": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}, - "responsible_attorney": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "responsible_staff": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "statute_of_limitations": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "status": "pending",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "due_at": "2019-08-24",
- "permission": "string",
- "completed_at": "2019-08-24T14:15:22Z",
- "notify_completion": true,
- "statute_of_limitations": true,
- "time_estimated": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "legal_aid_uk_matter": {
- "access_point": "string",
- "laa_office_number": "string",
- "ait_hearing_centre": 0,
- "attended_several_hearings_acting_for_multiple_clients": true,
- "bill_ho_ucn": "string",
- "bill_number_of_attendances": 0,
- "bill_outcome_for_the_client_code": 0,
- "bill_stage_reached_code": 0,
- "case_reference": "string",
- "case_start_date": "2019-08-24",
- "category": 0,
- "category_as_string": "string",
- "certificate_effective_date": "2019-08-24",
- "certificate_expiration_date": "2019-08-24",
- "certificate_number": "string",
- "certificate_scope": "string",
- "certification_type": 0,
- "change_of_solicitor": true,
- "client_equal_opportunity_monitoring": "string",
- "client_type": 0,
- "clr_start_date": "2019-08-24",
- "clr_total_profit_costs": "string",
- "cost_limit": "string",
- "counsel": 0,
- "court": 0,
- "court_id": 0,
- "court_id_code": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "delivery_location": "string",
- "dscc_number": "string",
- "duty_solicitor": true,
- "etag": "string",
- "exceptional_case_funding_reference": "string",
- "expense_limit": "string",
- "fee_scheme": 0,
- "first_conducting_solicitor": true,
- "id": 0,
- "irc_surgery": "string",
- "legacy_case": "string",
- "legal_representation_number": "string",
- "lh_total_disbursements": "string",
- "lh_start_date": "string",
- "lh_total_profit_costs": "string",
- "linked_matter_id": 0,
- "local_authority_number": "string",
- "maat_id": "string",
- "matter_type": 0,
- "matter_type_code": "string",
- "matter_type_1": 0,
- "matter_type_1_code": "string",
- "matter_type_1_title": "string",
- "matter_type_2": 0,
- "matter_type_2_code": "string",
- "matter_type_2_title": "string",
- "matter_types_combined": "string",
- "number_of_clients_seen_at_surgery": 0,
- "number_of_clients": 0,
- "party": 0,
- "police_station": "string",
- "post_transfer_clients_represented": 0,
- "postal_application_accepted": "string",
- "prior_authority_reference": "string",
- "prison_id": 0,
- "prison_law_prior_approval_number": "string",
- "procurement_area": "string",
- "region": 0,
- "related_claims_number": "string",
- "representation_order_date": "2019-08-24",
- "schedule_reference_number": "string",
- "scheme_id": "string",
- "session_type": 0,
- "solicitor_type": 0,
- "standard_fee_category": 0,
- "surgery_clients_resulting_in_a_legal_help_matter_opened": 0,
- "surgery_clients": 0,
- "surgery_date": "2019-08-24",
- "transfer_date": "2019-08-24",
- "type_of_advice": 0,
- "type_of_service": "string",
- "ucn": "string",
- "ufn": "string",
- "undesignated_area_court": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "user_type": 0,
- "youth_court": true
}, - "account_balances": [
- {
- "id": 0,
- "balance": 0.1,
- "type": "string",
- "name": "string",
- "currency_id": 0
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true,
- "custom_field": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "picklist_option": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "display_number": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "custom_field_set_associations": [
- {
- "id": 0,
- "etag": "string",
- "display_order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "matter_bill_recipients": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "recipient": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "relationships": [
- {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "task_template_list_instances": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "split_invoice_payers": [
- {
- "id": 0,
- "contact_id": 0,
- "matter_id": 0,
- "send_to_bill_recipients": true,
- "split_portion": 0.1,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters and data fields used when updating a single Matter
id required | integer <int64> The unique identifier for the Matter. |
custom_field_ids[] | integer <int64> Filter Matter's custom_field_values to only include values for the given custom field unique identifiers. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Matters
required | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "billable": true,
- "client": {
- "id": 0
}, - "client_reference": "string",
- "close_date": "2019-08-24",
- "currency": { },
- "custom_field_set_associations": [
- {
- "id": 0,
- "display_order": 0,
- "custom_field_set": {
- "id": 0
}, - "_destroy": true
}
], - "custom_field_values": [
- {
- "value": "string",
- "custom_field": {
- "id": 0
}, - "id": 0,
- "_destroy": true
}
], - "custom_rate": {
- "type": "FlatRate",
- "rates": [
- {
- "user": {
- "id": 0
}, - "award": 0.1,
- "note": "string",
- "date": "2019-08-24",
- "rate": 0.1,
- "id": 0,
- "_destroy": true,
- "activity_description": {
- "id": 0
}, - "group": {
- "id": 0
}
}
]
}, - "description": "string",
- "display_number": "string",
- "evergreen_retainer": {
- "minimum_threshold": 0.1,
- "_destroy": true,
- "recipients": [
- {
- "id": 0,
- "_destroy": true
}
]
}, - "group": {
- "id": 0
}, - "location": "string",
- "matter_budget": {
- "_destroy": true,
- "budget": 0.1,
- "include_expenses": true,
- "notification_threshold": 0,
- "notify_users": false
}, - "matter_stage": {
- "id": 0
}, - "open_date": "2019-08-24",
- "originating_attorney": {
- "id": 0
}, - "pending_date": "2019-08-24",
- "practice_area": {
- "id": 0
}, - "relationships": [
- {
- "description": "string",
- "contact": {
- "id": 0
}, - "id": 0,
- "_destroy": true
}
], - "reset_matter_number": false,
- "responsible_attorney": {
- "id": 0
}, - "responsible_staff": {
- "id": 0
}, - "split_invoice_payers": [
- {
- "contact_id": 0,
- "id": 0,
- "send_to_bill_recipients": true,
- "split_portion": 0.1,
- "_destroy": true
}
], - "status": "open",
- "statute_of_limitations": {
- "status": "pending",
- "due_at": "2019-08-24",
- "reminders": [
- {
- "duration_value": 0,
- "duration_unit": "string",
- "notification_method": {
- "id": 0
}, - "id": 0,
- "_destroy": true
}
]
}, - "task_template_list_instances": [
- {
- "task_template_list": {
- "id": 0
}, - "assignee_id": 0,
- "notify_assignees": true,
- "due_at": "2019-08-24"
}
]
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z",
- "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "contingency_fee": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "show_contingency_award": true
}, - "custom_rate": {
- "type": "FlatRate",
- "on_invoice": true,
- "rates": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rate": 0.1,
- "award": 0.1,
- "note": "string",
- "date": "2019-08-24",
- "user": {
- "enabled": true,
- "etag": "string",
- "id": 0,
- "name": "string"
}, - "group": {
- "etag": "string",
- "id": 0,
- "name": "string"
}, - "activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string"
}
}
]
}, - "evergreen_retainer": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "minimum_threshold": 0.1
}, - "folder": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "type": "Folder",
- "locked": true,
- "name": "string",
- "root": true
}, - "group": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter_budget": {
- "id": 0,
- "etag": "string",
- "budget": 0.1,
- "include_expenses": true,
- "notification_threshold": 0,
- "notify_users": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter_stage": {
- "id": 0,
- "etag": "string",
- "practice_area_id": "string",
- "name": "string",
- "order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "originating_attorney": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "practice_area": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}, - "responsible_attorney": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "responsible_staff": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "statute_of_limitations": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "status": "pending",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "due_at": "2019-08-24",
- "permission": "string",
- "completed_at": "2019-08-24T14:15:22Z",
- "notify_completion": true,
- "statute_of_limitations": true,
- "time_estimated": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "legal_aid_uk_matter": {
- "access_point": "string",
- "laa_office_number": "string",
- "ait_hearing_centre": 0,
- "attended_several_hearings_acting_for_multiple_clients": true,
- "bill_ho_ucn": "string",
- "bill_number_of_attendances": 0,
- "bill_outcome_for_the_client_code": 0,
- "bill_stage_reached_code": 0,
- "case_reference": "string",
- "case_start_date": "2019-08-24",
- "category": 0,
- "category_as_string": "string",
- "certificate_effective_date": "2019-08-24",
- "certificate_expiration_date": "2019-08-24",
- "certificate_number": "string",
- "certificate_scope": "string",
- "certification_type": 0,
- "change_of_solicitor": true,
- "client_equal_opportunity_monitoring": "string",
- "client_type": 0,
- "clr_start_date": "2019-08-24",
- "clr_total_profit_costs": "string",
- "cost_limit": "string",
- "counsel": 0,
- "court": 0,
- "court_id": 0,
- "court_id_code": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "delivery_location": "string",
- "dscc_number": "string",
- "duty_solicitor": true,
- "etag": "string",
- "exceptional_case_funding_reference": "string",
- "expense_limit": "string",
- "fee_scheme": 0,
- "first_conducting_solicitor": true,
- "id": 0,
- "irc_surgery": "string",
- "legacy_case": "string",
- "legal_representation_number": "string",
- "lh_total_disbursements": "string",
- "lh_start_date": "string",
- "lh_total_profit_costs": "string",
- "linked_matter_id": 0,
- "local_authority_number": "string",
- "maat_id": "string",
- "matter_type": 0,
- "matter_type_code": "string",
- "matter_type_1": 0,
- "matter_type_1_code": "string",
- "matter_type_1_title": "string",
- "matter_type_2": 0,
- "matter_type_2_code": "string",
- "matter_type_2_title": "string",
- "matter_types_combined": "string",
- "number_of_clients_seen_at_surgery": 0,
- "number_of_clients": 0,
- "party": 0,
- "police_station": "string",
- "post_transfer_clients_represented": 0,
- "postal_application_accepted": "string",
- "prior_authority_reference": "string",
- "prison_id": 0,
- "prison_law_prior_approval_number": "string",
- "procurement_area": "string",
- "region": 0,
- "related_claims_number": "string",
- "representation_order_date": "2019-08-24",
- "schedule_reference_number": "string",
- "scheme_id": "string",
- "session_type": 0,
- "solicitor_type": 0,
- "standard_fee_category": 0,
- "surgery_clients_resulting_in_a_legal_help_matter_opened": 0,
- "surgery_clients": 0,
- "surgery_date": "2019-08-24",
- "transfer_date": "2019-08-24",
- "type_of_advice": 0,
- "type_of_service": "string",
- "ucn": "string",
- "ufn": "string",
- "undesignated_area_court": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "user_type": 0,
- "youth_court": true
}, - "account_balances": [
- {
- "id": 0,
- "balance": 0.1,
- "type": "string",
- "name": "string",
- "currency_id": 0
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true,
- "custom_field": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "parent_type": "Contact",
- "field_type": "checkbox",
- "displayed": true,
- "deleted": true,
- "required": true,
- "display_order": 0,
- "picklist_options": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "picklist_option": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "option": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "display_number": "string"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "custom_field_set_associations": [
- {
- "id": 0,
- "etag": "string",
- "display_order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "matter_bill_recipients": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "recipient": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
], - "relationships": [
- {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "task_template_list_instances": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "split_invoice_payers": [
- {
- "id": 0,
- "contact_id": 0,
- "matter_id": 0,
- "send_to_bill_recipients": true,
- "split_portion": 0.1,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Matter
id required | integer <int64> The unique identifier for the Matter. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Relationships are used on a Matter to track Contacts related to the Matter. Relationships are can be found on the Contacts sub tab of a Matter.
Relationships are used on the Matter detail page under the Contacts tab.
Outlines the parameters, optional and required, used when requesting the data for all Relationships
contact_id | integer <int64> The unique identifier for a single Contact. The keyword |
created_since | string <date-time> Filter Relationship records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Relationship records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Relationship records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. The keyword |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter Relationship records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
]
}
Outlines the parameters and data fields used when creating a new Relationship
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Relationships
required | object | ||||||
|
{- "data": {
- "contact": {
- "id": 0
}, - "description": "string",
- "matter": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Relationship
id required | integer <int64> The unique identifier for the Relationship. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
}
Outlines the parameters and data fields used when updating a single Relationship
id required | integer <int64> The unique identifier for the Relationship. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Relationships
required | object | ||||||
|
{- "data": {
- "contact": {
- "id": 0
}, - "description": "string",
- "matter": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Relationship
id required | integer <int64> The unique identifier for the Relationship. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Client
matter_id required | integer <int64> Filters Client data by matter. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "is_matter_client": true,
- "primary_email_address": "string",
- "primary_phone_number": "string",
- "client_connect_user_id": 0,
- "date_of_birth": "2019-08-24",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "company": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "email_addresses": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "string",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "phone_numbers": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "name": "Work",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "web_sites": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for all RelatedContacts
matter_id required | integer <int64> Filters RelatedContacts data by matter. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
limit | integer <int32> A limit on the number of RelatedContacts records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" Orders the RelatedContacts records by the given field. Note that |
page_token | string A token specifying which page to return. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "contact_id": 0,
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "is_matter_client": true,
- "primary_email_address": "string",
- "primary_phone_number": "string",
- "client_connect_user_id": 0,
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "company": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "primary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "primary_web_site": {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "secondary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "secondary_web_site": {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true
}
], - "email_addresses": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "string",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "phone_numbers": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "name": "Work",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "web_sites": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "relationship": {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
All clients, prospective clients, companies, and external co-counsels can be viewed as Contacts under the Contacts tab in Clio Manage.
When creating a contact of type "Person" you must provide at least a first name or a last name. This can be done in one of two ways:
first_name
and last_name
parameters.name
parameter, you can provide the person's full name (e.g. "John Smith") and Clio will attempt to infer the individual components of the name. If it is unable to do so, you will receive a "422 Unprocessable Entity: At least one of first name or last name must be provided" Error.We recommend using the individual name fields when possible to avoid any ambiguities.
A Contact can be persisted with its associations in a single request. The followings detail the nested attributes to persist the associations.
Checkout the sample request to update the Addresses of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
addresses: [
// update
{ id: 1, name: "Work", country: "Canada" },
// create
{ name: "Home", street: "1234 Main Street", city: "Burnaby", province: "BC", country: "Canada", postal_code: "V1A 1A1" },
// destroy
{ id: 2, _destroy: true }
]
}
A CustomFieldValue contains the value of a CustomField for a Contact. Below are some examples of how to create, read, update, and destroy the CustomFieldValues of a Contact:
Note: The value of id
used here is the value of the id
parameter in the response received when creating a new CustomField or one returned in a query of an existing CustomField.
Request
PATCH /api/v4/contacts/1.json
{
data: {
custom_field_values: [
{ custom_field: { id: 2 }, value: "Initial value" }
]
}
}
Note: The id
of the CustomFieldValue is a composite value including the custom field type. Use this id
to update and destroy the CustomFieldValue.
The id
of the associated Custom Field can be found by querying the custom_field
for all CustomFieldValues related to the Contact, e.g.: /api/v4/contacts/1?fields=id,display_number,custom_field_values{id,value,custom_field}
Note: The id
may be NULL
when the CustomField is displayed by default but has not yet been given a value.
Request
GET /api/v4/contacts/1.json?fields=custom_field_values{id,value,custom_field}
{
data: {
custom_field_values: [
{
id: "text_line-1",
value: "Current value",
custom_field: { id: 2 }
}
]
}
}
Note: The value of the CustomFieldValue id
used here is a composite value and can be found by querying for all CustomFieldValues related to the Contact, e.g.: /api/v4/contacts/1?fields=id,name,custom_field_values{id,value,custom_field}
Note: If the id
is NULL
, you must provide custom_field{id}
to create the CustomFieldValue and assign a value (see Create).
Request
PATCH /api/v4/contacts/1.json
{
data: {
custom_field_values: [
{ id: "text_line-1", value: "Updated value" }
]
}
}
Note: The value of the CustomFieldValue id
used here is a composite value and can be found by querying for all CustomFieldValues related to the Contact, e.g.: /api/v4/contacts/1?fields=id,name,custom_field_values{id,value}
Request
PATCH /api/v4/contacts/1.json
{
data: {
custom_field_values: [
{ id: "picklist-2", _destroy: true }
]
}
}
Checkout the sample request to update the Email Addresses of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
email_addresses: [
// update
{ id: 1, name: "Work", address: "demo@clio.com" },
// create
{ name: "Home", address: "home@clio.com" },
// destroy
{ id: 2, _destroy: true }
]
}
Checkout the sample request to update the Instant Messengers of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
instant_messengers: [
// update
{ id: 1, name: "Work", address: "https://twitter.com/goclio" },
// create
{ name: "Other", address: "https://www.facebook.com/GoClio/" },
// destroy
{ id: 2, _destroy: true }
]
}
Checkout the sample request to update the Phone Numbers of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
phone_numbers: [
// update
{ id: 1, name: "Work", number: "123-456-7890" },
// create
{ name: "Other", number: "000-000-0000" },
// destroy
{ id: 2, _destroy: true }
]
}
Checkout the sample request to update the Web Site of a Contact:
Request
PATCH /api/v4/contacts/1.json
{
data: {
web_sites: [
// update
{ id: 1, name: "Work", address: "https://help.clio.com/" },
// create
{ name: "Other", address: "https://www.clio.com/about/careers/" },
// destroy
{ id: 2, _destroy: true }
]
}
Outlines the parameters, optional and required, used when requesting the data for all MatterContacts
matter_id required | integer <int64> Filters contact data by matter. |
custom_field_ids[] | integer <int64> IDs of custom fields to include in results. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
limit | integer <int32> A limit on the number of MatterContacts records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "is_client(asc)" "is_client(desc)" "id(asc)" "id(desc)" Orders the MatterContacts records by the given field. Note that |
page_token | string A token specifying which page to return. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "contact_created_at": "2019-08-24T14:15:22Z",
- "contact_updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "is_client": true,
- "last_name": "string",
- "matter_id": 0,
- "matter_number": "string",
- "middle_name": "string",
- "name": "string",
- "prefix": "string",
- "primary_email_address": "string",
- "primary_phone_number": "string",
- "relationship_name": "string",
- "secondary_email_address": "string",
- "secondary_phone_number": "string",
- "title": "string",
- "type": "Company",
- "updated_at": "2019-08-24T14:15:22Z",
- "client_connect_user_id": 0,
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "company": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "primary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "primary_web_site": {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "secondary_address": {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}, - "secondary_web_site": {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "addresses": [
- {
- "id": 0,
- "etag": "string",
- "street": "string",
- "city": "string",
- "province": "string",
- "postal_code": "string",
- "country": "string",
- "name": "Work",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "primary": true
}
], - "custom_field_values": [
- {
- "id": "string",
- "etag": "string",
- "field_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "field_type": "checkbox",
- "field_required": true,
- "field_displayed": true,
- "field_display_order": 0,
- "value": "string",
- "soft_deleted": true
}
], - "email_addresses": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "string",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "phone_numbers": [
- {
- "id": 0,
- "etag": "string",
- "number": "string",
- "name": "Work",
- "primary": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "web_sites": [
- {
- "id": 0,
- "etag": "string",
- "address": "string",
- "name": "Work",
- "default_web_site": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "relationship": {
- "id": 0,
- "etag": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Notes can be added to Matters or Contacts in Clio to record meeting notes, research, or anything else a user might want. The field can hold hundreds of pages, so users can add plenty of information.
Notes can be found either on the Matters or Contacts page under the Notes sub tab.
Outlines the parameters, optional and required, used when requesting the data for all Notes
contact_id | integer <int64> The unique identifier for a single Contact. The keyword |
created_since | string <date-time> Filter Note records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
has_time_entries | boolean Filter Note records to those with or without associated time entries. |
ids[] | integer <int64> Filter Note records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Note records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. The keyword |
order | string Enum: "id(asc)" "id(desc)" "date(asc)" "date(desc)" "author(asc)" "author(desc)" "updated_at(asc)" "updated_at(desc)" Orders the Note records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search across note subject and detail. |
type required | string Enum: "Matter" "Contact" Filter Note records to those of the specified type. |
updated_since | string <date-time> Filter Note records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "author": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new Note
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Notes
required | object | ||||||||||||||||
|
{- "data": {
- "contact": {
- "id": 0
}, - "date": "2019-08-24",
- "detail": "string",
- "detail_text_type": "plain_text",
- "matter": {
- "id": 0
}, - "notification_event_subscribers": [
- {
- "user_id": "string"
}
], - "subject": "string",
- "type": "Matter"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "author": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Note
id required | integer <int64> The unique identifier for the Note. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "author": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters and data fields used when updating a single Note
id required | integer <int64> The unique identifier for the Note. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Notes
required | object | ||||||||||
|
{- "data": {
- "date": "2019-08-24",
- "detail": "string",
- "detail_text_type": "plain_text",
- "notification_event_subscribers": [
- {
- "user_id": "string",
- "id": 0,
- "_destroy": true
}
], - "subject": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "type": "Matter",
- "subject": "string",
- "detail": "string",
- "detail_text_type": "plain_text",
- "date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "author": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "notification_event_subscribers": [
- {
- "id": 0,
- "etag": "string",
- "user_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Note
id required | integer <int64> The unique identifier for the Note. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
The practice area field can be added to Matters and used for filtering purposes, or just for reference. Users can create their own practice areas in their Firm Preferences settings.
Outlines the parameters, optional and required, used when requesting the data for all PracticeAreas
code | string Filter PracticeArea records to those that match the given code. |
created_since | string <date-time> Filter PracticeArea records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter PracticeArea records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of PracticeArea records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> Filter PracticeArea records to exclude Legal Aid UK Practice Areas when activities exist on the matter. |
name | string Filter PracticeArea records to those that match the given name. |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" "category(asc)" "category(desc)" "code(asc)" "code(desc)" Orders the PracticeArea records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter PracticeArea records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}
]
}
Outlines the parameters and data fields used when creating a new PracticeArea
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Practice Areas
required | object | ||||||
|
{- "data": {
- "category": "administrative",
- "code": "string",
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for a single PracticeArea
id required | integer <int64> The unique identifier for the PracticeArea. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}
}
Outlines the parameters and data fields used when updating a single PracticeArea
id required | integer <int64> The unique identifier for the PracticeArea. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Practice Areas
required | object | ||||||
|
{- "data": {
- "category": "administrative",
- "code": "string",
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}
}
Outlines the parameters, optional and required, used when deleting the record for a single PracticeArea
id required | integer <int64> The unique identifier for the PracticeArea. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Log Entries populate the “Recents” dropdown in the header. The “Recent” section displays the ten Matters and Contacts that the user most recently accessed.
When a user accesses a Contact or a Matter, a Log Entry is created.
Outlines the parameters, optional and required, used when requesting the data for all LogEntries
created_since | string <date-time> Filter LogEntry records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter LogEntry records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of LogEntry records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "accessed_at(asc)" "accessed_at(desc)" Orders the LogEntry records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter LogEntry records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "type": "MatterLogEntry",
- "accessed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}, - "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters, optional and required, used when requesting the data for all MatterStages
created_since | string <date-time> Filter MatterStage records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter MatterStage records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of MatterStage records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
practice_area_id | integer <int64> The unique identifier for a single PracticeArea. The keyword |
updated_since | string <date-time> Filter MatterStage records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "practice_area_id": "string",
- "name": "string",
- "order": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Medical Records Details allow you to track requests for medical records and medical bills, track treatment dates, follow up on requests, upload medical files, and track liens and outstanding balances that need to be paid out of the settlement all in one place.
Medical Records Details can be found in the Matters page under the Medical Records sub tab.
Outlines the parameters, optional and required, used when requesting the data for all Medical Records Details
created_since | string <date-time> Filter MedicalRecordsRequest records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter MedicalRecordsRequest records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Medical Records Detail records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
treatment_end_date | string <date-time> Filters Medical Records data by treatment end date. |
treatment_start_date | string <date-time> Filters Medical Records data by treatment start date. |
updated_since | string <date-time> Filter MedicalRecordsRequest records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "bills_follow_up_date": "2019-08-24T14:15:22Z",
- "bills_request_date": "2019-08-24T14:15:22Z",
- "bills_status": "not_yet_requested",
- "description": "string",
- "in_treatment": true,
- "records_follow_up_date": "2019-08-24T14:15:22Z",
- "records_request_date": "2019-08-24T14:15:22Z",
- "records_status": "not_yet_requested",
- "treatment_end_date": "2019-08-24T14:15:22Z",
- "treatment_start_date": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "medical_provider": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "medical_bills": [
- {
- "id": 0,
- "adjustment": 0.1,
- "amount": 0.1,
- "bill_date": "2019-08-24",
- "bill_received_date": "2019-08-24",
- "damage_type": "string",
- "document_id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "medical_records": [
- {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "end_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
This endpoint allows a creation of a Medical Records Detail, multiple Medical Records and Medical Bills. Medical Liens can also be created as a property under Medical Bills.
Reference the payload to see how the records are being passed in.
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Medical Records Details
required | object | ||||||||||||||||||||||||||||
|
{- "data": {
- "bills_follow_up_date": "2019-08-24T14:15:22Z",
- "bills_request_date": "2019-08-24T14:15:22Z",
- "bills_status": "not_yet_requested",
- "description": "string",
- "in_treatment": true,
- "matter_id": 0,
- "medical_bills": [
- {
- "adjustment": 0.1,
- "amount": 0.1,
- "balance": 0.1,
- "bill_date": "2019-08-24",
- "bill_received_date": "2019-08-24",
- "document_id": 0,
- "name": "string",
- "mark_balance_type_as": "lien",
- "payers": [
- {
- "amount": 0.1,
- "holder_id": 0,
- "mark_as_lien": true
}
]
}
], - "medical_provider_id": 0,
- "medical_records": [
- {
- "document_id": 0,
- "end_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z"
}
], - "records_follow_up_date": "2019-08-24T14:15:22Z",
- "records_request_date": "2019-08-24T14:15:22Z",
- "records_status": "not_yet_requested",
- "treatment_end_date": "2019-08-24T14:15:22Z",
- "treatment_start_date": "2019-08-24T14:15:22Z"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "bills_follow_up_date": "2019-08-24T14:15:22Z",
- "bills_request_date": "2019-08-24T14:15:22Z",
- "bills_status": "not_yet_requested",
- "description": "string",
- "in_treatment": true,
- "records_follow_up_date": "2019-08-24T14:15:22Z",
- "records_request_date": "2019-08-24T14:15:22Z",
- "records_status": "not_yet_requested",
- "treatment_end_date": "2019-08-24T14:15:22Z",
- "treatment_start_date": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "medical_provider": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "medical_bills": [
- {
- "id": 0,
- "adjustment": 0.1,
- "amount": 0.1,
- "bill_date": "2019-08-24",
- "bill_received_date": "2019-08-24",
- "damage_type": "string",
- "document_id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "medical_records": [
- {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "end_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Medical Records Details
id required | integer <int64> The unique identifier for the Medical Records Detail. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "bills_follow_up_date": "2019-08-24T14:15:22Z",
- "bills_request_date": "2019-08-24T14:15:22Z",
- "bills_status": "not_yet_requested",
- "description": "string",
- "in_treatment": true,
- "records_follow_up_date": "2019-08-24T14:15:22Z",
- "records_request_date": "2019-08-24T14:15:22Z",
- "records_status": "not_yet_requested",
- "treatment_end_date": "2019-08-24T14:15:22Z",
- "treatment_start_date": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "medical_provider": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "medical_bills": [
- {
- "id": 0,
- "adjustment": 0.1,
- "amount": 0.1,
- "bill_date": "2019-08-24",
- "bill_received_date": "2019-08-24",
- "damage_type": "string",
- "document_id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "medical_records": [
- {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "end_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
If there are records being passed into the Medical Records or Medical Bills parameter they will be treated as new records and new Medical Records / Medical Bills will be created.
id required | integer <int64> The unique identifier for the Medical Records Detail. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Medical Records Details
required | object | ||||||||||||||||||||||||||
|
{- "data": {
- "bills_follow_up_date": "2019-08-24T14:15:22Z",
- "bills_request_date": "2019-08-24T14:15:22Z",
- "bills_status": "not_yet_requested",
- "description": "string",
- "in_treatment": true,
- "medical_bills": [
- {
- "adjustment": 0.1,
- "amount": 0.1,
- "balance": 0.1,
- "bill_date": "2019-08-24",
- "bill_received_date": "2019-08-24",
- "document_id": 0,
- "name": "string",
- "mark_balance_type_as": "lien",
- "payers": [
- {
- "amount": 0.1,
- "holder_id": 0,
- "mark_as_lien": true
}
]
}
], - "medical_provider_id": 0,
- "medical_records": [
- {
- "document_id": 0,
- "end_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z"
}
], - "records_follow_up_date": "2019-08-24T14:15:22Z",
- "records_request_date": "2019-08-24T14:15:22Z",
- "records_status": "not_yet_requested",
- "treatment_end_date": "2019-08-24T14:15:22Z",
- "treatment_start_date": "2019-08-24T14:15:22Z"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "bills_follow_up_date": "2019-08-24T14:15:22Z",
- "bills_request_date": "2019-08-24T14:15:22Z",
- "bills_status": "not_yet_requested",
- "description": "string",
- "in_treatment": true,
- "records_follow_up_date": "2019-08-24T14:15:22Z",
- "records_request_date": "2019-08-24T14:15:22Z",
- "records_status": "not_yet_requested",
- "treatment_end_date": "2019-08-24T14:15:22Z",
- "treatment_start_date": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "medical_provider": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "medical_bills": [
- {
- "id": 0,
- "adjustment": 0.1,
- "amount": 0.1,
- "bill_date": "2019-08-24",
- "bill_received_date": "2019-08-24",
- "damage_type": "string",
- "document_id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "medical_records": [
- {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "end_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
When a Medical Records Detail is destroyed, the child records, such as Medical Records, Medical Bills and Liens will also be destroyed in the same transaction.
id required | integer <int64> The unique identifier for the Medical Records Detail. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Medical Records are a subset of Medical Records Details and can be used to keep track of documents, start dates, and end dates.
Note that these endpoints only handle Updating and Destroying a record. Creating records should be handled in the Medical Records Details endpoint.
Outlines the parameters and data fields used when updating a single MedicalRecord
id required | integer <int64> The unique identifier for the MedicalRecord. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Medical Records
required | object | ||||
|
{- "data": {
- "end_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z"
}
}
{- "data": {
- "id": 0,
- "document_id": 0,
- "etag": "string",
- "end_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single MedicalRecord
id required | integer <int64> The unique identifier for the MedicalRecord. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Medical Bills are a subset of Medical Records Details and can be used to keep track of documents, bill dates, and liens.
Note that these endpoints only handle Updating and Destroying a record. Creating records should be handled in the Medical Records Details endpoint.
Outlines the parameters and data fields used when updating a single Medical Bill
id required | integer <int64> The unique identifier for the Medical Bill. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Medical Bills
required | object | ||||||||||||||||
|
{- "data": {
- "adjustment": 0.1,
- "amount": 0.1,
- "balance": 0.1,
- "bill_date": "2019-08-24",
- "bill_received_date": "2019-08-24",
- "mark_balance_type_as": "lien",
- "name": "string",
- "payers": [
- {
- "amount": 0.1,
- "holder_id": 0,
- "mark_as_lien": true
}
]
}
}
{- "data": {
- "id": 0,
- "adjustment": 0.1,
- "amount": 0.1,
- "bill_date": "2019-08-24",
- "bill_received_date": "2019-08-24",
- "damage_type": "string",
- "document_id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "liens": [
- {
- "id": 0,
- "amount": 0.1,
- "description": "string",
- "etag": "string",
- "lien_type": "general",
- "mark_as_lien": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Medical Bill
id required | integer <int64> The unique identifier for the Medical Bill. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all Damages
created_since | string <date-time> Filter Damage records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Damage records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Damage records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter Damage records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "amount": 0.1,
- "damage_type": "special",
- "description": "string",
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new Damage
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Damages
required | object | ||||||||
|
{- "data": {
- "amount": 0.1,
- "damage_type": "special",
- "description": "string",
- "matter_id": 0
}
}
{- "data": {
- "id": 0,
- "amount": 0.1,
- "damage_type": "special",
- "description": "string",
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Damage
id required | integer <int64> The unique identifier for the Damage. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "amount": 0.1,
- "damage_type": "special",
- "description": "string",
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single Damage
id required | integer <int64> The unique identifier for the Damage. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Damages
required | object | ||||||
|
{- "data": {
- "amount": 0.1,
- "damage_type": "special",
- "description": "string"
}
}
{- "data": {
- "id": 0,
- "amount": 0.1,
- "damage_type": "special",
- "description": "string",
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Damage
id required | integer <int64> The unique identifier for the Damage. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Once a Payment or Credit Note has been recorded, an Allocation links it to a Bill.
It's possible for interest Allocations ("interest" = "true") to not be linked to a Bill. This can happen if the linked interest Bill is deleted (something the system allows.)
Outlines the parameters, optional and required, used when requesting the data for all Allocations
bill_id | integer <int64> The unique identifier for a single Bill. The keyword |
contact_id | integer <int64> The unique identifier for a single Contact. The keyword |
created_since | string <date-time> Filter Allocation records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Allocation records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Allocation records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. The keyword |
order | string Enum: "id(asc)" "id(desc)" "date(asc)" "date(desc)" Orders the Allocation records by the given field. Default: |
page_token | string A token specifying which page to return. |
parent_id | integer <int64> ID of parent (either a Payment or CreditMemo) this allocation belongs to |
parent_type | integer <int32> Filter Allocation records based on whether the parent is a CreditMemo or a Payment. |
status | string Enum: "valid" "invalid" Filter Allocation records to only those that are voided ( |
updated_since | string <date-time> Filter Allocation records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "interest": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "has_online_payment": true,
- "destroyable": true,
- "payment_type": "string",
- "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "source_bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "destination_bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "parent": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single Allocation
id required | integer <int64> The unique identifier for the Allocation. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "interest": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "has_online_payment": true,
- "destroyable": true,
- "payment_type": "string",
- "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "source_bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "destination_bank_account": {
- "account_number": "string",
- "balance": 0.1,
- "bank_transactions_count": 0,
- "clio_payment_page_link": "string",
- "clio_payment_page_qr_code": "string",
- "clio_payments_enabled": true,
- "controlled_account": true,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "currency_symbol": "string",
- "currency_id": 0.1,
- "default_account": true,
- "domicile_branch": "string",
- "etag": "string",
- "general_ledger_number": "string",
- "holder": "string",
- "id": 0,
- "institution": "string",
- "name": "string",
- "swift": "string",
- "transit_number": "string",
- "type": "Operating",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "parent": {
- "id": 0,
- "type": "Task",
- "identifier": "string",
- "secondary_identifier": "string",
- "tertiary_identifier": "string"
}
}
}
Credit Memos allow users to write off amounts that clients owe on approved Bills. They can be added in two "ways": when viewing a Bill, or when making a payment on a Bill.
Outlines the parameters, optional and required, used when requesting the data for all CreditMemos
contact_id | integer <int64> The unique identifier for a single Contact. The keyword |
created_since | string <date-time> Filter CreditMemo records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter CreditMemo records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of CreditMemo records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "date(asc)" "date(desc)" Orders the CreditMemo records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter CreditMemo records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "description": "string",
- "discount": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "allocations": [
- {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "interest": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "has_online_payment": true,
- "destroyable": true,
- "payment_type": "string"
}
]
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single CreditMemo
id required | integer <int64> The unique identifier for the CreditMemo. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "description": "string",
- "discount": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "allocations": [
- {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "amount": 0.1,
- "interest": true,
- "voided_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "has_online_payment": true,
- "destroyable": true,
- "payment_type": "string"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for all Reports
category | string Filters Report data by category. |
created_before | string <date-time> Filters Report data by date. (Expects an ISO-8601 date). |
created_since | string <date-time> Filter Report records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Report records to those having the specified unique identifiers. |
kind | string Enum: "accounts_receivable" "accounts_receivable_aging" "bank_account_activity" "billing_history" "billing_rate" "client_activity" "client_ledger" "clio_payments_deposit" "clio_payments_ledger" "clio_payments_monthly_statement" "clio_payments_sales_tax" "clio_payments_transaction" "contact_information" "disbursement_payment" "fee_allocation" "general_ledger" "grant_matters" "invoice_payments_v2" "law_society_of_alberta" "law_society_of_alberta_al" "law_society_of_alberta_bar" "law_society_of_alberta_tl" "law_society_of_alberta_tt" "matter" "matter_balance_summary" "matter_productivity_by_user" "matters_by_responsible_attorney" "originating_attorney_revenue" "other_revenue" "productivity_by_client" "productivity_by_user" "revenue" "task_productivity_by_user" "task_progress_by_user" "trust_ledger" "trust_ledger_nsw" "trust_listing" "trust_management" "work_in_progress" Filters Report data by kind. |
limit | integer <int32> A limit on the number of Report records to be returned. Limit can range between 1 and 200. Default: |
output_format | string Filters Report data by format. |
page_token | string A token specifying which page to return. |
query | string Wildcard search for Report name. |
source | string Filters Report data by source. |
state | string Filters Report data by state. |
updated_since | string <date-time> Filter Report records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "state": "not_started",
- "kind": "accounts_receivable",
- "format": "csv",
- "progress": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "category": "billing",
- "source": "reports"
}
]
}
Outlines the parameters and data fields used when creating a new Report
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Reports
required | object | ||||||||||||||||||||||
|
{- "data": {
- "client": {
- "id": 0
}, - "end_date": "2019-08-24",
- "format": "csv",
- "kind": "accounts_receivable",
- "matter": {
- "id": 0
}, - "originating_attorney": {
- "id": 0
}, - "practice_area": {
- "id": 0
}, - "responsible_attorney": {
- "id": 0
}, - "start_date": "2019-08-24",
- "user": {
- "id": 0
}, - "year": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "state": "not_started",
- "kind": "accounts_receivable",
- "format": "csv",
- "progress": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "category": "billing",
- "source": "reports"
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Report
id required | integer <int64> The unique identifier for the Report. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "state": "not_started",
- "kind": "accounts_receivable",
- "format": "csv",
- "progress": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "category": "billing",
- "source": "reports"
}
}
Report Presets can be created to streamline report generation workflow by saving report option parameters as a Preset.
When creating a Report Preset, the options sent in the request body is dependent on the report kind.
Check out the sample request to create a Report Preset for the Billing History web report for the current year and grouped by client.
Request
POST /api/v4/report_presets.json
{
data:
{ name: "Current Yr Billing",
kind: "billing_history",
options: {
date_range: "year",
format: "html",
group_by: "client",
start_date: null,
end_date: null,
kind: "billing_history"
},
format: "html"
}
}
Generate a new report for a given preset
id required | integer <int64> The unique identifier for the ReportPreset. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "state": "not_started",
- "kind": "accounts_receivable",
- "format": "csv",
- "progress": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "category": "billing",
- "source": "reports"
}
}
Outlines the parameters, optional and required, used when requesting the data for all ReportPresets
category | string Enum: "billing" "client" "compliance" "financial" "matter" "online_payments" "productivity" "revenue" "task" Filters ReportPreset data by category. |
created_since | string <date-time> Filter ReportPreset records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
has_schedule | boolean Filters ReportPreset records to those that have or do not have a Report Schedule. |
ids[] | integer <int64> Filter ReportPreset records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of ReportPreset records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "created_at(asc)" "created_at(desc)" "last_generated_at(asc)" "last_generated_at(desc)" "last_modified_at(asc)" "last_modified_at(desc)" "name(asc)" "name(desc)" "next_scheduled_date(asc)" "next_scheduled_date(desc)" Orders the ReportPreset records by the given field. Default: |
output_format | string Filters ReportPreset data by format. |
page_token | string A token specifying which page to return. |
query | string Wildcard search for ReportPreset name. |
schedule_frequency | string Enum: "daily" "weekly" "monthly" Filters ReportPreset records to those that have a Report Schedule of the specified frequency. |
updated_since | string <date-time> Filter ReportPreset records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "kind": "accounts_receivable",
- "format": "csv",
- "last_generated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "category": "billing",
- "options": "string",
- "report_schedule": {
- "id": 0,
- "etag": "string",
- "time_of_day": "2019-08-24T14:15:22Z",
- "frequency": "daily",
- "days_of_week": [
- 0
], - "day_of_month": 0,
- "status": "initial",
- "status_updated_at": "2019-08-24T14:15:22Z",
- "next_scheduled_date": "2019-08-24T14:15:22Z",
- "time_zone": "string",
- "report_preset_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "every_no_of_months": 0,
- "effective_from": "2019-08-24"
}
}
]
}
Outlines the parameters and data fields used when creating a new ReportPreset
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Report Presets
required | object | ||||||||
|
{- "data": {
- "format": "csv",
- "kind": "accounts_receivable",
- "name": "string",
- "options": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "kind": "accounts_receivable",
- "format": "csv",
- "last_generated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "category": "billing",
- "options": "string",
- "report_schedule": {
- "id": 0,
- "etag": "string",
- "time_of_day": "2019-08-24T14:15:22Z",
- "frequency": "daily",
- "days_of_week": [
- 0
], - "day_of_month": 0,
- "status": "initial",
- "status_updated_at": "2019-08-24T14:15:22Z",
- "next_scheduled_date": "2019-08-24T14:15:22Z",
- "time_zone": "string",
- "report_preset_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "every_no_of_months": 0,
- "effective_from": "2019-08-24"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single ReportPreset
id required | integer <int64> The unique identifier for the ReportPreset. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "kind": "accounts_receivable",
- "format": "csv",
- "last_generated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "category": "billing",
- "options": "string",
- "report_schedule": {
- "id": 0,
- "etag": "string",
- "time_of_day": "2019-08-24T14:15:22Z",
- "frequency": "daily",
- "days_of_week": [
- 0
], - "day_of_month": 0,
- "status": "initial",
- "status_updated_at": "2019-08-24T14:15:22Z",
- "next_scheduled_date": "2019-08-24T14:15:22Z",
- "time_zone": "string",
- "report_preset_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "every_no_of_months": 0,
- "effective_from": "2019-08-24"
}
}
}
Outlines the parameters and data fields used when updating a single ReportPreset
id required | integer <int64> The unique identifier for the ReportPreset. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Report Presets
required | object | ||||||||
|
{- "data": {
- "format": "csv",
- "kind": "accounts_receivable",
- "name": "string",
- "options": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "kind": "accounts_receivable",
- "format": "csv",
- "last_generated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "category": "billing",
- "options": "string",
- "report_schedule": {
- "id": 0,
- "etag": "string",
- "time_of_day": "2019-08-24T14:15:22Z",
- "frequency": "daily",
- "days_of_week": [
- 0
], - "day_of_month": 0,
- "status": "initial",
- "status_updated_at": "2019-08-24T14:15:22Z",
- "next_scheduled_date": "2019-08-24T14:15:22Z",
- "time_zone": "string",
- "report_preset_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "every_no_of_months": 0,
- "effective_from": "2019-08-24"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single ReportPreset
id required | integer <int64> The unique identifier for the ReportPreset. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Schedule report generation for an existing Report Preset using Report Schedules. A Report Schedule will generate reports from the specified Preset's report options on a daily, weekly or monthly basis. Once the report has been generated, users will be notified via email.
Outlines the parameters, optional and required, used when requesting the data for all ReportSchedules
created_since | string <date-time> Filter ReportSchedule records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter ReportSchedule records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of ReportSchedule records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter ReportSchedule records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "time_of_day": "2019-08-24T14:15:22Z",
- "frequency": "daily",
- "days_of_week": [
- 0
], - "day_of_month": 0,
- "status": "initial",
- "status_updated_at": "2019-08-24T14:15:22Z",
- "next_scheduled_date": "2019-08-24T14:15:22Z",
- "time_zone": "string",
- "report_preset_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "every_no_of_months": 0,
- "effective_from": "2019-08-24"
}
]
}
Outlines the parameters and data fields used when creating a new ReportSchedule
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Report Schedules
required | object | ||||||||||||||||
|
{- "data": {
- "day_of_month": 0,
- "days_of_week": [
- 0
], - "effective_from": "2019-08-24",
- "every_no_of_months": 0,
- "frequency": "daily",
- "report_preset_id": 0,
- "time_of_day": "2019-08-24T14:15:22Z",
- "time_zone": "Africa/Abidjan"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "time_of_day": "2019-08-24T14:15:22Z",
- "frequency": "daily",
- "days_of_week": [
- 0
], - "day_of_month": 0,
- "status": "initial",
- "status_updated_at": "2019-08-24T14:15:22Z",
- "next_scheduled_date": "2019-08-24T14:15:22Z",
- "time_zone": "string",
- "report_preset_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "every_no_of_months": 0,
- "effective_from": "2019-08-24"
}
}
Outlines the parameters, optional and required, used when requesting the data for a single ReportSchedule
id required | integer <int64> The unique identifier for the ReportSchedule. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "time_of_day": "2019-08-24T14:15:22Z",
- "frequency": "daily",
- "days_of_week": [
- 0
], - "day_of_month": 0,
- "status": "initial",
- "status_updated_at": "2019-08-24T14:15:22Z",
- "next_scheduled_date": "2019-08-24T14:15:22Z",
- "time_zone": "string",
- "report_preset_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "every_no_of_months": 0,
- "effective_from": "2019-08-24"
}
}
Outlines the parameters and data fields used when updating a single ReportSchedule
id required | integer <int64> The unique identifier for the ReportSchedule. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Report Schedules
required | object | ||||||||||||||||
|
{- "data": {
- "day_of_month": 0,
- "days_of_week": [
- 0
], - "effective_from": "2019-08-24",
- "every_no_of_months": 0,
- "frequency": "daily",
- "report_preset_id": 0,
- "time_of_day": "2019-08-24T14:15:22Z",
- "time_zone": "Africa/Abidjan"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "time_of_day": "2019-08-24T14:15:22Z",
- "frequency": "daily",
- "days_of_week": [
- 0
], - "day_of_month": 0,
- "status": "initial",
- "status_updated_at": "2019-08-24T14:15:22Z",
- "next_scheduled_date": "2019-08-24T14:15:22Z",
- "time_zone": "string",
- "report_preset_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "every_no_of_months": 0,
- "effective_from": "2019-08-24"
}
}
Outlines the parameters, optional and required, used when deleting the record for a single ReportSchedule
id required | integer <int64> The unique identifier for the ReportSchedule. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Clio's Text Snippets feature allows users to create a list of predefined abbreviations for commonly used phrases. For example, a user could configure their settings to have “meeting with client” show up whenever they type “mwc.”
This feature can be used in various field in Clio, such as the Matter Description, Note Detail, Calendar Entry Description and Task Description fields.
Text snippets are created and configured in a user's personal settings in Clio Manage.
Outlines the parameters, optional and required, used when requesting the data for all TextSnippets
created_since | string <date-time> Filter TextSnippet records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter TextSnippet records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of TextSnippet records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "snippet(asc)" "snippet(desc)" "phrase(asc)" "phrase(desc)" "whole_word(asc)" "whole_word(desc)" Orders the TextSnippet records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
updated_since | string <date-time> Filter TextSnippet records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "snippet": "string",
- "phrase": "string",
- "whole_word": true
}
]
}
Outlines the parameters and data fields used when creating a new TextSnippet
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Text Snippets
required | object | ||||||
|
{- "data": {
- "phrase": "string",
- "snippet": "string",
- "whole_word": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "snippet": "string",
- "phrase": "string",
- "whole_word": true
}
}
Outlines the parameters, optional and required, used when requesting the data for a single TextSnippet
id required | integer <int64> The unique identifier for the TextSnippet. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "snippet": "string",
- "phrase": "string",
- "whole_word": true
}
}
Outlines the parameters and data fields used when updating a single TextSnippet
id required | integer <int64> The unique identifier for the TextSnippet. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Text Snippets
required | object | ||||||
|
{- "data": {
- "phrase": "string",
- "snippet": "string",
- "whole_word": true
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "snippet": "string",
- "phrase": "string",
- "whole_word": true
}
}
Outlines the parameters, optional and required, used when deleting the record for a single TextSnippet
id required | integer <int64> The unique identifier for the TextSnippet. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for a single BillingSetting
duration | string Duration string for time rounding, conforming to the Chronic date parser. For example: '3h' or '2:15'. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "rounded_duration": 0.1,
- "rounding": 0,
- "use_decimal_rounding": true,
- "currency": "string",
- "currency_sign": "string",
- "tax_rate": 0.1,
- "tax_name": "string",
- "apply_tax_by_default": true,
- "time_on_flat_rate_contingency_matters_is_non_billable": true,
- "use_secondary_tax": true,
- "secondary_tax_rate": 0.1,
- "secondary_tax_rule": "Pre",
- "secondary_tax_name": "string",
- "notify_after_bill_created": true,
- "use_utbms_codes": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "multi_currency_billing": true,
- "billing_currencies": [
- { }
]
}
}
Outlines the parameters, optional and required, used when requesting the data for all Currencies
created_since | string <date-time> Filter Currency records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Currency records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Currency records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter Currency records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Tasks are used to assign and track work. Users can set priorities, due dates, and add reminders.
Tasks can be assigned to firm users as well as Contacts (such as clients or co-counsel).
Outlines the parameters, optional and required, used when requesting the data for all Tasks
assignee_id | integer <int64> The unique identifier for a single User or Contact. Use the keyword |
assignee_type | string Enum: "user" "contact" Filter Task records to those with a specific assignee. Must be passed if filtering by assignee. |
assigner_id | integer <int64> The unique identifier for a single User. Use the keyword |
cascading_source_id | integer <int32> Filter Task records to those with a parent task that has the specified ID. |
client_id | integer <int64> The unique identifier for a single Contact. Use the keyword |
complete | boolean Filter Task records to those which are complete or not. |
created_since | string <date-time> Filter Task records to those having the |
due_at_from | string <date> Start of date range when querying by due_at in a range. (Expects an ISO-8601 date). |
due_at_present | boolean Filter Task records to those that have a due date specified, or not. |
due_at_to | string <date> End of date range when querying by due_at in a range. (Expects an ISO-8601 date). |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Task records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Task records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
order | string Enum: "name(asc)" "name(desc)" "task_type.name(asc)" "task_type.name(desc)" "id(asc)" "id(desc)" "priority(asc)" "priority(desc)" "matter.display_number(asc)" "matter.display_number(desc)" "due_at(asc)" "due_at(desc)" "due_at_strict(asc)" "due_at_strict(desc)" "completed_at(asc)" "completed_at(desc)" Orders the Task records by the given field. Default: |
page_token | string A token specifying which page to return. |
permission | string Enum: "private" "public" Filter Task records to those with the given permission. Returns all tasks by default. |
priority | string Enum: "high" "normal" "low" Filter Task records to those with the given priority. |
query | string Wildcard search for |
responsible_attorney_id | integer <int64> Filter Task records to those that have an associated matter with a responsible attorney ID. |
status | string Enum: "pending" "in_progress" "in_review" "complete" "draft" Filter Task records to those with the given status. Users without advanced tasks enabled may only specify 'complete' or 'pending'. |
statuses[] | string Enum: "pending" "in_progress" "in_review" "complete" "draft" Filter Task records to those with the given statuses. Users without advanced tasks enabled may only specify 'complete' or 'pending'. |
statute_of_limitations | boolean Filter Task records to those which are a statute of limitations or not. |
task_type_id | integer <int64> The unique identifier for a single TaskType. Use the keyword |
time_entries_present | boolean Filter Task records to those that have associated time entries, or not. |
updated_since | string <date-time> Filter Task records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "status": "pending",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "due_at": "2019-08-24",
- "permission": "string",
- "completed_at": "2019-08-24T14:15:22Z",
- "notify_completion": true,
- "statute_of_limitations": true,
- "time_estimated": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "task_type": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "assigner": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "assignee": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}, - "reminders": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new Task
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Tasks
required | object | ||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "assignee": {
- "id": 0,
- "type": "User"
}, - "cascading": true,
- "cascading_offset": 0,
- "cascading_offset_polarity": "CalendarDays",
- "cascading_offset_type": "Before",
- "cascading_source": 0,
- "description": "string",
- "description_text_type": "plain_text",
- "due_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0
}, - "name": "string",
- "notify_assignee": true,
- "notify_completion": true,
- "permission": "private",
- "priority": "High",
- "status": "pending",
- "statute_of_limitations": true,
- "task_type": {
- "id": 0
}, - "time_estimated": 0
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "status": "pending",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "due_at": "2019-08-24",
- "permission": "string",
- "completed_at": "2019-08-24T14:15:22Z",
- "notify_completion": true,
- "statute_of_limitations": true,
- "time_estimated": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "task_type": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "assigner": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "assignee": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}, - "reminders": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Task
id required | integer <int64> The unique identifier for the Task. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "status": "pending",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "due_at": "2019-08-24",
- "permission": "string",
- "completed_at": "2019-08-24T14:15:22Z",
- "notify_completion": true,
- "statute_of_limitations": true,
- "time_estimated": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "task_type": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "assigner": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "assignee": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}, - "reminders": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters and data fields used when updating a single Task
id required | integer <int64> The unique identifier for the Task. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Tasks
required | object | ||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "assignee": {
- "id": 0,
- "type": "User"
}, - "cascading": true,
- "cascading_offset": 0,
- "cascading_offset_polarity": "CalendarDays",
- "cascading_offset_type": "Before",
- "cascading_source": 0,
- "description": "string",
- "description_text_type": "plain_text",
- "due_at": "2019-08-24T14:15:22Z",
- "matter": {
- "id": 0
}, - "name": "string",
- "notify_assignee": true,
- "notify_completion": true,
- "permission": "private",
- "priority": "High",
- "status": "pending",
- "task_type": {
- "id": 0
}, - "time_estimated": 0
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "status": "pending",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "due_at": "2019-08-24",
- "permission": "string",
- "completed_at": "2019-08-24T14:15:22Z",
- "notify_completion": true,
- "statute_of_limitations": true,
- "time_estimated": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "time_entries_count": 0,
- "time_entries": [
- {
- "id": 0,
- "etag": "string",
- "type": "TimeEntry",
- "date": "2019-08-24",
- "quantity_in_hours": 0.1,
- "rounded_quantity_in_hours": 0.1,
- "quantity": 0.1,
- "rounded_quantity": 0.1,
- "quantity_redacted": true,
- "price": 0.1,
- "note": "string",
- "flat_rate": true,
- "billed": true,
- "on_bill": true,
- "total": 0.1,
- "contingency_fee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "non_billable": true,
- "non_billable_total": 0.1,
- "no_charge": true,
- "tax_setting": "no_tax",
- "currency": { }
}
], - "task_type": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "assigner": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "assignee": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "type": "Person",
- "identifier": "string",
- "secondary_identifier": "string",
- "enabled": true,
- "name": "string",
- "initials": "string",
- "job_title_name": "string",
- "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}
}, - "reminders": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "next_delivery_at": "2019-08-24T14:15:22Z",
- "state": "initializing",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Task
id required | integer <int64> The unique identifier for the Task. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Task Templates are the individual Tasks which comprise a Task Template List.
Outlines the parameters, optional and required, used when requesting the data for all TaskTemplates
created_since | string <date-time> Filter TaskTemplate records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter TaskTemplate records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of TaskTemplate records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "assignee.name(asc)" "assignee.name(desc)" "days_from_assignment(asc)" "days_from_assignment(desc)" "id(asc)" "id(desc)" "name(asc)" "name(desc)" "permission(asc)" "permission(desc)" "priority(asc)" "priority(desc)" Orders the TaskTemplate records by the given field. Default: |
page_token | string A token specifying which page to return. |
priority | string Enum: "high" "normal" "low" Filter TaskTemplate records to those with the given priority. |
query | string Wildcard search for |
task_template_list_id | integer <int64> The unique identifier for a single TaskTemplateList. The keyword |
updated_since | string <date-time> Filter TaskTemplate records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "private": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "cascading_source": {
- "id": 0,
- "name": "string"
}, - "assignee": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "task_template_list": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": 0,
- "etag": "string",
- "name": "string",
- "templates_count": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "task_type": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "template_creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "reminder_templates": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "notification_type": "Email",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new TaskTemplate
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Task Templates
required | object | ||||||||||||||||||||||||
|
{- "data": {
- "cascading": true,
- "cascading_offset": 0,
- "cascading_offset_polarity": "Before",
- "cascading_offset_type": "CalendarDays",
- "cascading_source": {
- "id": 0
}, - "description": "string",
- "description_text_type": "plain_text",
- "name": "string",
- "priority": "High",
- "private": true,
- "reminder_templates": [
- {
- "duration_value": 0,
- "duration_unit": "string",
- "notification_type": "Email"
}
], - "task_template_list": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "private": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "cascading_source": {
- "id": 0,
- "name": "string"
}, - "assignee": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "task_template_list": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": 0,
- "etag": "string",
- "name": "string",
- "templates_count": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "task_type": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "template_creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "reminder_templates": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "notification_type": "Email",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single TaskTemplate
id required | integer <int64> The unique identifier for the TaskTemplate. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "private": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "cascading_source": {
- "id": 0,
- "name": "string"
}, - "assignee": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "task_template_list": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": 0,
- "etag": "string",
- "name": "string",
- "templates_count": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "task_type": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "template_creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "reminder_templates": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "notification_type": "Email",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters and data fields used when updating a single TaskTemplate
id required | integer <int64> The unique identifier for the TaskTemplate. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Task Templates
required | object | ||||||||||||||||||||||
|
{- "data": {
- "cascading": true,
- "cascading_offset": 0,
- "cascading_offset_polarity": "Before",
- "cascading_offset_type": "CalendarDays",
- "cascading_source": {
- "id": 0
}, - "description": "string",
- "description_text_type": "plain_text",
- "name": "string",
- "priority": "High",
- "private": true,
- "reminder_templates": [
- {
- "duration_value": 0,
- "duration_unit": "string",
- "notification_type": "Email",
- "id": 0,
- "_destroy": true
}
]
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "description": "string",
- "description_text_type": "plain_text",
- "priority": "High",
- "private": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "cascading_source": {
- "id": 0,
- "name": "string"
}, - "assignee": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "task_template_list": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": 0,
- "etag": "string",
- "name": "string",
- "templates_count": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "task_type": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "template_creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "reminder_templates": [
- {
- "id": 0,
- "etag": "string",
- "duration": 0,
- "notification_type": "Email",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single TaskTemplate
id required | integer <int64> The unique identifier for the TaskTemplate. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
With Task Template Lists, users can create groups of Task Templates for the types of projects they work on most often. Each Task in a list can be given a separate due date in relation to the due dates for other Tasks in the list.
Users can then assign individual tasks on a list to different users, or they can batch assign an entire list.
Creates a copy of the TaskTemplateList identified by the id
path parameter.
id required | integer <int64> The unique identifier for the TaskTemplateList. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
Request Body for Task Template Lists
required | object | ||||||
|
{- "data": {
- "description": "string",
- "name": "string",
- "practice_area": {
- "id": 0
}
}
}
{- "data": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": 0,
- "etag": "string",
- "name": "string",
- "templates_count": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "practice_area": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for all TaskTemplateLists
created_since | string <date-time> Filter TaskTemplateList records to those having the |
empty | boolean Filter TaskTemplateList records to those that either contain at least one task template or contain none. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter TaskTemplateList records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of TaskTemplateList records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" "practice_area.name(asc)" "practice_area.name(desc)" Orders the TaskTemplateList records by the given field. Default: |
page_token | string A token specifying which page to return. |
practice_area_id | integer <int64> The unique identifier for a single PracticeArea. Use the keyword |
query | string Wildcard search for |
updated_since | string <date-time> Filter TaskTemplateList records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": 0,
- "etag": "string",
- "name": "string",
- "templates_count": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "practice_area": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new TaskTemplateList
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Task Template Lists
required | object | ||||||
|
{- "data": {
- "description": "string",
- "name": "string",
- "practice_area": {
- "id": 0
}
}
}
{- "data": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": 0,
- "etag": "string",
- "name": "string",
- "templates_count": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "practice_area": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single TaskTemplateList
id required | integer <int64> The unique identifier for the TaskTemplateList. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": 0,
- "etag": "string",
- "name": "string",
- "templates_count": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "practice_area": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single TaskTemplateList
id required | integer <int64> The unique identifier for the TaskTemplateList. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Task Template Lists
required | object | ||||||
|
{- "data": {
- "description": "string",
- "name": "string",
- "practice_area": {
- "id": 0
}
}
}
{- "data": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": 0,
- "etag": "string",
- "name": "string",
- "templates_count": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "practice_area": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": "administrative",
- "code": "string"
}, - "creator": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single TaskTemplateList
id required | integer <int64> The unique identifier for the TaskTemplateList. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Task Types are used to better categorize and filter tasks. This is a simple text field which is limited to 50 characters.
Task Types are part of the Advanced Tasks feature which is not available to all plan types. See here for feature support across different plans.
[Support Link] (https://help.clio.com/hc/en-us/articles/9205859328923-Task-Types)
Used within Clio at Task types
Outlines the parameters, optional and required, used when requesting the data for all TaskTypes
created_since | string <date-time> Filter TaskType records to those having the |
enabled | boolean Filter TaskType records to those that are enabled or disabled. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter TaskType records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of TaskType records to be returned. Limit can range between 1 and 200. Default: |
name | string Filter TaskType records to those with the given name. |
order | string Enum: "name(asc)" "name(desc)" "id(asc)" "id(desc)" Orders the TaskType records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
updated_since | string <date-time> Filter TaskType records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Outlines the parameters and data fields used when creating a new TaskType
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Task Types
required | object | ||||
|
{- "data": {
- "deleted_at": "2019-08-24",
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Outlines the parameters, optional and required, used when requesting the data for a single TaskType
id required | integer <int64> The unique identifier for the TaskType. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Outlines the parameters and data fields used when updating a single TaskType
id required | integer <int64> The unique identifier for the TaskType. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Task Types
required | object | ||||
|
{- "data": {
- "deleted_at": "2019-08-24",
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Outlines the parameters, optional and required, used when requesting the data for all TrustLineItems
bill_id | integer <int64> The unique identifier for a single Bill. The keyword |
created_since | string <date-time> Filter TrustLineItem records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter TrustLineItem records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of TrustLineItem records to be returned. Limit can range between 1 and 200. Default: |
matter_id | integer <int64> The unique identifier for a single Matter. Use the keyword |
order | string Enum: "id(asc)" "id(desc)" Orders the TrustLineItem records by the given field. Default: |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter TrustLineItem records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "total": 0.1,
- "note": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
]
}
Outlines the parameters and data fields used when updating a single TrustLineItem
id required | integer <int64> The unique identifier for the TrustLineItem. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Trust Line Items
required | object | ||||||
|
{- "data": {
- "date": "2019-08-24",
- "note": "string",
- "total": 0.1
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "date": "2019-08-24",
- "total": 0.1,
- "note": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "bill": {
- "id": 0,
- "etag": "string",
- "number": "string",
- "issued_at": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24",
- "tax_rate": 0.1,
- "secondary_tax_rate": 0.1,
- "updated_at": "2019-08-24T14:15:22Z",
- "subject": "string",
- "purchase_order": "string",
- "type": "MatterBill",
- "memo": "string",
- "start_at": "2019-08-24",
- "end_at": "2019-08-24",
- "balance": 0.1,
- "state": "draft",
- "kind": "revenue_kind",
- "total": 0.1,
- "paid": 0.1,
- "paid_at": "2019-08-24T14:15:22Z",
- "pending": 0.1,
- "due": 0.1,
- "discount_services_only": "string",
- "can_update": true,
- "credits_issued": 0.1,
- "shared": true,
- "last_sent_at": "2019-08-24T14:15:22Z",
- "services_secondary_tax": 0.1,
- "services_sub_total": 0.1,
- "services_tax": 0.1,
- "services_taxable_sub_total": 0,
- "services_secondary_taxable_sub_total": 0,
- "taxable_sub_total": 0,
- "secondary_taxable_sub_total": 0,
- "sub_total": 0.1,
- "tax_sum": 0.1,
- "secondary_tax_sum": 0.1,
- "total_tax": 0.1,
- "available_state_transitions": [
- "awaiting_approval"
]
}, - "matter": {
- "id": 0,
- "etag": "string",
- "number": 0,
- "display_number": "string",
- "custom_number": "string",
- "currency": { },
- "description": "string",
- "status": "Pending",
- "location": "string",
- "client_reference": "string",
- "client_id": 0,
- "billable": true,
- "maildrop_address": "string",
- "billing_method": "flat",
- "open_date": "2019-08-24",
- "close_date": "2019-08-24",
- "pending_date": "2019-08-24",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "shared": true,
- "has_tasks": true,
- "last_activity_date": "2019-08-24",
- "matter_stage_updated_at": "2019-08-24T14:15:22Z"
}, - "client": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}
}
}
Outlines the parameters and data fields used when creating a new TrustRequest
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Trust Requests
required | object | ||||||||||||||||||
|
{- "data": {
- "approved": true,
- "client_id": 0,
- "currency_id": 0,
- "due_date": "2019-08-24",
- "issue_date": "2019-08-24",
- "matter": [
- {
- "id": 0,
- "trust_amount": 0,
- "note": "string"
}
], - "note": "string",
- "trust_amount": 0.1,
- "trust_type": "client"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
A User is anyone with the ability to log in to Clio. This does not include Clio for Co-Counsel/Clio Connect users.
You can obtain the name of the firm linked to a user by accessing the nested account
object:
Request
GET /api/v4/users/who_am_i?fields=account{name}
Outlines the parameters, optional and required, used when requesting the data for a single User
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "default_activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": { }
}, - "notification_methods": [
- {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "account": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "state": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "job_title": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "initials": "string"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for all Users
created_since | string <date-time> Filter User records to those having the |
enabled | boolean Filter User records to those that are enabled or disabled. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter User records to those having the specified unique identifiers. |
include_co_counsel | boolean Filter User to include co-counsel users |
limit | integer <int32> A limit on the number of User records to be returned. Limit can range between 1 and 2000. Default: |
name | string Filter User records to those with the given name. |
order | string Enum: "email(asc)" "email(desc)" "enabled(asc)" "enabled(desc)" "id(asc)" "id(desc)" "name(asc)" "name(desc)" "first_name(asc)" "first_name(desc)" "last_name(asc)" "last_name(desc)" "initials(asc)" "initials(desc)" "subscription_type(asc)" "subscription_type(desc)" Orders the User records by the given field. Default: |
page_token | string A token specifying which page to return. |
pending_setup | boolean Filter User records based on whether or not they are still being setup. |
role | string Enum: "admin" "accounts" "billing" "reports" Filter User records to those with a specific role. |
subscription_type | string Enum: "attorney" "nonattorney" Filter User records to those with a specific subscription type. |
updated_since | string <date-time> Filter User records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "default_activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": { }
}, - "notification_methods": [
- {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "account": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "state": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "job_title": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "initials": "string"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters, optional and required, used when requesting the data for a single User
id required | integer <int64> The unique identifier for the User. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "default_activity_description": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "visible_to_co_counsel": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "default": true,
- "type": "string",
- "utbms_activity_id": 0,
- "utbms_task_name": "string",
- "utbms_task_id": 0,
- "xero_service_code": "string",
- "accessible_to_user": true,
- "category_type": "string",
- "currency": { }
}, - "notification_methods": [
- {
- "id": 0,
- "etag": "string",
- "type": "Email",
- "email_address": "string",
- "is_default_email_address": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "account": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "state": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "avatar": {
- "id": 0,
- "etag": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "_destroy": true
}, - "contact": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24",
- "type": "Company",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "prefix": "string",
- "title": "string",
- "initials": "string",
- "clio_connect_email": "string",
- "locked_clio_connect_email": true,
- "client_connect_user_id": 0,
- "primary_email_address": "string",
- "secondary_email_address": "string",
- "primary_phone_number": "string",
- "secondary_phone_number": "string",
- "ledes_client_id": "string",
- "has_clio_for_clients_permission": true,
- "is_client": true,
- "is_clio_for_client_user": true,
- "is_co_counsel": true,
- "is_bill_recipient": true,
- "sales_tax_number": "string",
- "currency": { }
}, - "job_title": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "initials": "string"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
In Clio, permission levels and Matter permissions are controlled using Groups. All accounts contain an “all users” group, as well as individual groups for each user. Admins always have access to all of the account's groups. Users can also create groups manually in order to precisely manage their permissions.
Outlines the parameters, optional and required, used when requesting the data for all Groups
archived | boolean Filter archived Group records. |
created_since | string <date-time> Filter Group records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Group records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Group records to be returned. Limit can range between 1 and 200. Default: |
name | string Filter Group records to those that match the given name. |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" Orders the Group records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Wildcard search for |
type | string Enum: "AccountGroup" "AdhocGroup" "UserGroup" Filter Group records to those that match the given type. |
updated_since | string <date-time> Filter Group records to those having the |
user_id | integer <int64> The unique identifier for a single User. The keyword |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z",
- "users": [
- {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new Group
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Groups
required | object | ||
|
{- "data": {
- "name": "string"
}
}
{- "data": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z",
- "users": [
- {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Group
id required | integer <int64> The unique identifier for the Group. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z",
- "users": [
- {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters and data fields used when updating a single Group
id required | integer <int64> The unique identifier for the Group. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Groups
required | object | ||
|
{- "data": {
- "name": "string"
}
}
{- "data": {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z",
- "users": [
- {
- "account_owner": true,
- "clio_connect": true,
- "court_rules_default_attendee": true,
- "created_at": "2019-08-24T14:15:22Z",
- "default_calendar_id": 0,
- "email": "string",
- "enabled": true,
- "etag": "string",
- "first_name": "string",
- "id": 0,
- "initials": "string",
- "last_name": "string",
- "name": "string",
- "phone_number": "string",
- "rate": 0.1,
- "roles": [
- "string"
], - "subscription_type": "Attorney",
- "time_zone": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Group
id required | integer <int64> The unique identifier for the Group. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all Grants
created_since | string <date-time> Filter Grant records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter Grant records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of Grant records to be returned. Limit can range between 1 and 200. Default: |
name | string Filter Grant records to those that match the given name. |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter Grant records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "funding_code": "string",
- "funding_code_and_name": "string",
- "funding_source_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "balance": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "grant_funding_source": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new Grant
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Grants
required | object | ||
|
{- "data": {
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "funding_code": "string",
- "funding_code_and_name": "string",
- "funding_source_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "balance": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "grant_funding_source": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single Grant
id required | integer <int64> The unique identifier for the Grant. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "funding_code": "string",
- "funding_code_and_name": "string",
- "funding_source_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "balance": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "grant_funding_source": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single Grant
id required | integer <int64> The unique identifier for the Grant. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Grants
required | object | ||
|
{- "data": {
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "funding_code": "string",
- "funding_code_and_name": "string",
- "funding_source_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "balance": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "grant_funding_source": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single Grant
id required | integer <int64> The unique identifier for the Grant. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all GrantFundingSources
created_since | string <date-time> Filter GrantFundingSource records to those having the |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
ids[] | integer <int64> Filter GrantFundingSource records to those having the specified unique identifiers. |
limit | integer <int32> A limit on the number of GrantFundingSource records to be returned. Limit can range between 1 and 200. Default: |
name | string Filter GrantFundingSource records to those that match the given name. |
page_token | string A token specifying which page to return. |
updated_since | string <date-time> Filter GrantFundingSource records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "grants": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "funding_code": "string",
- "funding_code_and_name": "string",
- "funding_source_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "balance": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
]
}
]
}
Outlines the parameters and data fields used when creating a new GrantFundingSource
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Grant Funding Sources
required | object | ||
|
{- "data": {
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "grants": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "funding_code": "string",
- "funding_code_and_name": "string",
- "funding_source_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "balance": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
]
}
}
Outlines the parameters and data fields used when updating a single GrantFundingSource
id required | integer <int64> The unique identifier for the GrantFundingSource. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Grant Funding Sources
required | object | ||
|
{- "data": {
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "grants": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "funding_code": "string",
- "funding_code_and_name": "string",
- "funding_source_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "balance": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
]
}
}
Outlines the parameters and data fields used when updating a single GrantFundingSource
id required | integer <int64> The unique identifier for the GrantFundingSource. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Grant Funding Sources
required | object | ||
|
{- "data": {
- "name": "string"
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "grants": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "funding_code": "string",
- "funding_code_and_name": "string",
- "funding_source_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "balance": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
]
}
}
This endpoint provides the Legal Aid civil controlled rates, which are the prescribed reimbursement rates for legal services provided under the Legal Aid Scheme.
Outlines the parameters, optional and required, used when requesting the data for all LaukCivilControlledRates
activity | string Filter by activity. |
category_of_law | string Filter by category of law. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
key | string Filter by key. |
limit | integer <int32> A limit on the number of LaukCivilControlledRate records to be returned. Limit can range between 1 and 200. Default: |
matter_type_1 | integer <int32> Filter by matter type 1. |
matter_type_2 | integer <int32> Filter by matter type 2. |
page_token | string A token specifying which page to return. |
rate_type | string Filter by rate type. |
region | string Filter by region. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "activity": "string",
- "activity_type": "string",
- "category_of_law": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "exceptional": 0,
- "fee": 0,
- "fee_scheme": "string",
- "key": "string",
- "rate_type": "string",
- "region": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
This endpoint provides the Legal Aid civil certificated rates, which are the prescribed reimbursement rates for legal services provided under the Legal Aid Scheme.
Outlines the parameters, optional and required, used when requesting the data for all LaukCivilCertificatedRates
activity | string Filter by activity. |
activity_sub_category | string Filter by activity sub-category. |
attended_several_hearings_for_multiple_clients | boolean Filter by whether multiple hearings were attended for multiple clients. |
category_of_law | string Filter by category of law. |
change_of_solicitor | boolean Filter by change of solicitor status. |
court | string Filter by court. |
eligible_for_sqm | boolean Filter by SQM eligibility. |
fee_scheme | string Fee scheme |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
first_conducting_solicitor | boolean Filter by first conducting solicitor status. |
key | string Filter by key. |
limit | integer <int32> A limit on the number of LaukCivilCertificatedRate records to be returned. Limit can range between 1 and 200. Default: |
number_of_clients | string Filter by number of clients. |
page_token | string A token specifying which page to return. |
party | string Filter by party. |
post_transfer_clients_represented | string Filter by post-transfer clients represented. |
rate_type | string Filter by rate type. |
region | string Filter by region. |
session_type | string Filter by session type. |
user_type | string Filter by user type. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "activity": "string",
- "activity_sub_category": "string",
- "activity_type": "string",
- "attended_several_hearings_for_multiple_clients": true,
- "category_of_law": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "change_of_solicitor": true,
- "court": "string",
- "eligible_for_sqm": true,
- "exceptional": 0,
- "exceptional_warning": "string",
- "etag": "string",
- "fee": 0,
- "fee_scheme": "string",
- "first_conducting_solicitor": true,
- "key": "string",
- "number_of_clients": "string",
- "party": "string",
- "post_transfer_clients_represented": "string",
- "rate_type": "string",
- "region": "string",
- "session_type": "string",
- "user_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
This endpoint provides the Legal Aid criminal controlled rates, which are the prescribed reimbursement rates for legal services provided under the Legal Aid Scheme.
Outlines the parameters, optional and required, used when requesting the data for all LaukCriminalControlledRates
activity | string Filter by activity. |
category_of_law | string Filter by category of law. |
counsel | string Filter by counsel. |
court | string Filter by court. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
key | string Filter by key. |
limit | integer <int32> A limit on the number of LaukCriminalControlledRate records to be returned. Limit can range between 1 and 200. Default: |
page_token | string A token specifying which page to return. |
rate_type | string Filter by rate type. |
region | string Filter by region. |
solicitor_type | string Filter by solicitor type. |
standard_fee_category | string Filter by standard fee category. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "activity": "string",
- "activity_type": "string",
- "category_of_law": "string",
- "counsel": "string",
- "court": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "etag": "string",
- "exceptional": 0,
- "fee": 0,
- "fee_scheme": "string",
- "post_nov_24_exceptional": 0,
- "post_nov_24_fee": 0,
- "post_sept_22_exceptional": 0,
- "post_sept_22_fee": 0,
- "key": "string",
- "rate_type": "string",
- "region": "string",
- "solicitor_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
This endpoint provides the Legal Aid expense category rates, which are the prescribed reimbursement rates for legal services provided under the Legal Aid Scheme.
Outlines the parameters, optional and required, used when requesting the data for all ExpenseCategories
created_since | string <date-time> Filter ExpenseCategory records to those having the |
entry_type | string Enum: "hard_cost" "soft_cost" "unassociated" Filter ExpenseCategory records to those that match the given type. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
limit | integer <int32> A limit on the number of ExpenseCategory records to be returned. Limit can range between 1 and 200. Default: |
order | string Enum: "id(asc)" "id(desc)" "name(asc)" "name(desc)" "rate(asc)" "rate(desc)" "entry_type(asc)" "entry_type(desc)" Orders the ExpenseCategory records by the given field. Default: |
page_token | string A token specifying which page to return. |
query | string Allows matching search on expense category name. |
updated_since | string <date-time> Filter ExpenseCategory records to those having the |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "utbms_code": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Outlines the parameters and data fields used when creating a new ExpenseCategory
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Expense Categories
required | object | ||||||||||||
|
{- "data": {
- "currency": { },
- "entry_type": "hard_cost",
- "groups": [
- {
- "id": 0,
- "_deleted": true
}
], - "name": "string",
- "rate": 0.1,
- "utbms_code": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "utbms_code": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when requesting the data for a single ExpenseCategory
id required | integer <int64> The unique identifier for the ExpenseCategory. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MODIFIED-SINCE | string <date> 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). |
IF-NONE-MATCH | string The server will send the requested resource with a 200 status, but only if the existing resource's ETag doesn't match any of the values listed. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "utbms_code": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters and data fields used when updating a single ExpenseCategory
id required | integer <int64> The unique identifier for the ExpenseCategory. |
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
IF-MATCH | string 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. |
X-API-VERSION | string The API minor version. Default: latest version. |
Request Body for Expense Categories
required | object | ||||||||||||
|
{- "data": {
- "currency": { },
- "entry_type": "hard_cost",
- "groups": [
- {
- "id": 0,
- "_deleted": true
}
], - "name": "string",
- "rate": 0.1,
- "utbms_code": {
- "id": 0
}
}
}
{- "data": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "rate": 0,
- "entry_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "xero_expense_code": "string",
- "accessible_to_user": true,
- "tax_setting": "string",
- "currency": {
- "id": 0,
- "etag": "string",
- "code": "string",
- "sign": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "groups": [
- {
- "client_connect_user": true,
- "etag": "string",
- "id": 0,
- "name": "string",
- "type": "UserGroup",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "utbms_code": {
- "id": 0,
- "etag": "string",
- "name": "string",
- "code": "string",
- "description": "string",
- "type": "UtbmsTask",
- "utbms_set_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Outlines the parameters, optional and required, used when deleting the record for a single ExpenseCategory
id required | integer <int64> The unique identifier for the ExpenseCategory. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "error": {
- "type": "string",
- "message": "string"
}
}
Outlines the parameters, optional and required, used when requesting the data for all LaukExpenseCategories
fields | string The fields to be returned. See response samples for what fields are available. For more information see the fields section. |
key | string Filter by key. |
limit | integer <int32> A limit on the number of LaukExpenseCategory records to be returned. Limit can range between 1 and 200. Default: |
name | string Filter by expense name. |
page_token | string A token specifying which page to return. |
practice_area | string Filter by expense practice area. |
region required | string Sets the expense rate returned based on the region. If the region is set to London, it will return the London rate; otherwise, it will return the non-London rate. |
X-API-VERSION | string The API minor version. Default: latest version. |
{- "data": [
- {
- "certificated": true,
- "civil": true,
- "created_at": "2019-08-24T14:15:22Z",
- "criminal": true,
- "etag": "string",
- "id": 0,
- "key": "string",
- "name": "string",
- "rate": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}