{ "openapi": "3.0.0", "info": { "title": "Clio API Documentation", "contact": { "name": "Clio API Support", "email": "api@clio.com" }, "description": "# Developer Support and Feedback\n* Clio takes the availability and stability of our API seriously; please report any **degradations** or **breakages** to Clio's API Support team at [api@clio.com](mailto:api@clio.com).\n* For business and partnership inquiries, contact our API Partnerships team at [api.partnerships@clio.com](mailto:api.partnerships@clio.com).\n* For best practices and tips from the Clio development community, join the conversation in the [Clio Developer Slack Channel](https://join.slack.com/t/clio-public/shared_invite/zt-36i0eqgo1-7POORPtMJpp2N0~_auL2IQ).\n\nA community-driven [Clio Developers Stack Overflow Group](https://stackoverflow.com/questions/tagged/clio-api) also exists where you can connect and ask questions from other Clio API users.\n# Getting Started\n> **Note:** The API is available in four distinct data regions: Australia (au.app.clio.com), Canada (ca.app.clio.com), EU (eu.app.clio.com) and US (app.clio.com).\n>\n> Likewise, the developer portal is available at region-specific links for the [Australia](https://au.developers.clio.com), [Canada](https://ca.developers.clio.com), [EU](https://eu.developers.clio.com), and [US](https://developers.clio.com) regions.\n>\n> This document assumes the US region is being used (app.clio.com). If you're building in one of the other regions, you should adapt the links and examples as necessary.\n\nTo start building on the Clio API, you’ll need a Clio account – you can review our [Developer Handbook](https://docs.developers.clio.com/) and follow the steps to sign up for an account.\n\nOnce you have an account, you can [create a developer application](https://docs.developers.clio.com/api-docs/applications) from the [Developer Portal](https://developers.clio.com) and start building!\n# Authorization with OAuth 2.0\nSee our [Authorization documentation →](https://docs.developers.clio.com/api-docs/authorization)\n# Permissions\nSee our [Permissions documentation →](https://docs.developers.clio.com/api-docs/permissions)\n# Fields\nSee our [Fields documentation →](https://docs.developers.clio.com/api-docs/fields)\n# Rate Limiting\nSee our [Rate Limits documentation →](https://docs.developers.clio.com/api-docs/rate-limits)\n# Paging\nSee our [Pagination documentation →](https://docs.developers.clio.com/api-docs/paging)\n# ETags\nSee our [ETags documentation →](https://docs.developers.clio.com/api-docs/etags)\n# Minor Versions\nAPI v4 supports multiple minor versions. Versions are of the form '4.X.Y'. To request a specific version, you can use an `X-API-VERSION` header in your request, with the header value set to the API version you're requesting. If this header is omitted, it will be treated as a request for the default API version. If the header is present but invalid, it will return a `410 Gone` response. If the header is present and valid, but it is no longer supported, it will return a `410 Gone` response.\n\nAn `X-API-VERSION` will be included in all successful responses, with the value being set to the API version used.\n\nYou can find our [API Versioning Policy and Guidelines](https://docs.developers.clio.com/api-docs/api-versioning-policy) in our documentation hub.\n\nThe [API Changelog](https://docs.developers.clio.com/api-docs/api-changelog) explains each version's changes in further detail.\n### [4.0.4](https://docs.developers.clio.com/api-docs/api-changelog#404)\n\n * Update `quantity` field to return values in seconds rather than hours for Activities\n\n### [4.0.5](https://docs.developers.clio.com/api-docs/api-changelog#405)\n\n * Remove `matter_balances` field from Bills\n* Standardize status/state enum values\n* Add a Document association to completed DocumentAutomations\n* Add rate visibility handling for Activity's price and total\n\n### [4.0.6](https://docs.developers.clio.com/api-docs/api-changelog#406)\n\n * Remove `document_versions` collection field from Documents\n\n### [4.0.7](https://docs.developers.clio.com/api-docs/api-changelog#407)\n\n * Change secure link format\n\n### [4.0.8](https://docs.developers.clio.com/api-docs/api-changelog#408)\n\n * `Activity` hours are redacted in the response based on the activity hours visibility setting for the user\n * Add `quantity_redacted` field to activities\n\n### [4.0.9](https://docs.developers.clio.com/api-docs/api-changelog#409)\n\n * Contacts are filtered and redacted in the response based on the new 'Contacts Visibility' user permission setting.\n\n### [4.0.10](https://docs.developers.clio.com/api-docs/api-changelog#4010)\n\n * Fixed validation of `type` query parameter when querying Notes\n\n### [4.0.12](https://docs.developers.clio.com/api-docs/api-changelog#4012)\n\n * Restrict fields for CalendarEntry that should only be visible to event owners, editors, and viewers\n\n### [4.0.13](https://docs.developers.clio.com/api-docs/api-changelog#4013)\n\n **This is the default version**\n\n * Add association limits to Contacts\n* Returns 422 Unprocessable Entity when association limits are exceeded\n\n\n", "version": "v4", "x-logo": { "url": "https://www.clio.com/wp-content/uploads/2015/05/Container-5-Logo.png" } }, "servers": [ { "url": "https://app.clio.com/api/v4", "description": "US region Production Server" }, { "url": "https://eu.app.clio.com/api/v4", "description": "Europe region Production Server" }, { "url": "https://ca.app.clio.com/api/v4", "description": "Canada region Production Server" }, { "url": "https://au.app.clio.com/api/v4", "description": "Australia region Production Server" } ], "paths": { "/activities.json": { "get": { "tags": [ "Activities" ], "summary": "Return the data for all Activities", "operationId": "Activity#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Activities", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "activity_description_id", "in": "query", "description": "The unique identifier for a single ActivityDescription. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "calendar_entry_id", "in": "query", "description": "The unique identifier for a single CalendarEntry. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "client_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "communication_id", "in": "query", "description": "The unique identifier for a single Communication. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "contact_note_id", "in": "query", "description": "The unique identifier for a single Note. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter Activity records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "end_date", "in": "query", "description": "Filter Activity records to those whose `date` is on or before the date provided (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "expense_category_id", "in": "query", "description": "The unique identifier for a single ExpenseCategory. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "flat_rate", "in": "query", "description": "Filter Activity TimeEntry records to those that have a flat rate, or not.", "required": false, "schema": { "type": "boolean" } }, { "name": "grant_id", "in": "query", "description": "The unique identifier for a single Grant. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "ids[]", "in": "query", "description": "Filter Activity records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Activity records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "matter_note_id", "in": "query", "description": "The unique identifier for a single Note. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "only_unaccounted_for", "in": "query", "description": "Only unaccounted for activities.", "required": false, "schema": { "type": "boolean" } }, { "name": "order", "in": "query", "description": "Orders the Activity records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "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)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `note` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Filter Activity records to those whose `date` is on or after the date provided (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "status", "in": "query", "description": "Filter Activity records to those that are draft, billed, unbilled or non-billable.", "required": false, "schema": { "type": "string", "enum": [ "billed", "draft", "unbilled", "non_billable", "billable", "written_off" ] } }, { "name": "task_id", "in": "query", "description": "The unique identifier for a single Task. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "type", "in": "query", "description": "Filter Activity records to those of a specific type.", "required": false, "schema": { "type": "string", "enum": [ "TimeEntry", "ExpenseEntry", "HardCostEntry", "SoftCostEntry" ] } }, { "name": "updated_since", "in": "query", "description": "Filter Activity records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "user_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Activity_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Activities" ], "summary": "Create a new Activity", "operationId": "Activity#create", "description": "Outlines the parameters and data fields used when creating a new Activity", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Activity_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Activities", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "activity_description": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ActivityDescription associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_task_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsTask associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_activity_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsActivity associated with the Activity. The keyword `null` is not valid for this field." } } }, "calendar_entry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntry associated with the Activity. The keyword `null` is not valid for this field." } } }, "client_portal": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ClientPortal associated with the Activity. The keyword `null` is not valid for this field." } } }, "communication": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Communication associated with the Activity. The keyword `null` is not valid for this field." } } }, "contact_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "date": { "type": "string", "format": "date", "description": "The date the Activity was performed. (Expects an ISO-8601 date)." }, "expense_category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExpenseCategory associated with an Activity.\nUse the keyword `null` to specify no association.\n" } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Activity. The keyword `null` is not valid for this field." } } }, "matter_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "no_charge": { "type": "boolean", "description": "Whether the non-billable *Activity* will be shown on the bill." }, "non_billable": { "type": "boolean", "description": "Whether or not this Activity is prevented from appearing as a line item in a bill.\nOnly valid for non-billed TimeEntries, and with the exception of the Activity having no_charge set to true.\n" }, "note": { "type": "string", "description": "A custom note to describe what the Activity is for." }, "price": { "type": "number", "format": "double", "description": "For an ExpenseEntry, HardCostEntry, and SoftCostEntry, it is the expense amount.\n\n[Support Link for ExpenseEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses)\n\n[Support Link for HardCostEntry and SoftCostEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses#enable-hard-and-soft-cost-expenses-0-0)\n\nFor a TimeEntry, it is the hourly or flat amount. When updating a TimeEntry,\nif the price is not given or the user does not have the permission to view the rate,\nand its activity description, matter and/or user is changed,\nthe price is reset according to the rate defined for the activity description, matter, client or user.\n\n[Support Link for Rates Hierarchy](https://help.clio.com/hc/en-us/articles/9289801180187-Rates-and-Rate-Hierarchies-)\n\n[Support Link for Billing Rate Visibility](https://help.clio.com/hc/en-us/articles/9285360193819-Permissions-and-Billing-Rates#billing-rate-visibility-0-3)\n" }, "quantity": { "type": "number", "format": "double", "description": "The field is applicable to TimeEntry, ExpenseEntry, and SoftCostEntry.\n\n**Version <= 4.0.3:**\nThe number of hours the TimeEntry took.\n\n**Latest version:**\nThe number of seconds the TimeEntry took.\n" }, "reference": { "type": "string", "description": "A check reference for a HardCostEntry." }, "start_timer": { "type": "boolean", "description": "Whether or not a timer should be started for this Activity. Only valid for non-FlatRate, non-billed TimeEntries." }, "task": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Task associated with the Activity. The keyword `null` is not valid for this field." } } }, "tax_setting": { "type": "string", "enum": [ "no_tax", "tax_1_only", "tax_2_only", "tax_1_and_tax_2" ], "description": "The option denoting whether primary tax, secondary tax, or both is applied to an expense entry." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration." }, "order": { "type": "integer", "format": "int32", "description": "The order in which the tax setting should be applied." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule determining when the tax setting should be applied" } }, "required": [ "tax_rate_configuration_id", "order" ] }, "description": "Array of objects, with each object representing a tax setting that is applied to an expense entry with 'tax_rate_configuration_id', 'order', and 'rule' as the object properties." }, "text_message_conversation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single TextMessageConversation associated with the Activity. The keyword `null` is not valid for this field." } } }, "type": { "type": "string", "enum": [ "TimeEntry", "ExpenseEntry", "HardCostEntry", "SoftCostEntry" ], "description": "The type of the Activity." }, "user": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single User associated with the Activity.\nUse the keyword `null` to specify no association.\nOn creation, if no user is specified, it will default to the current user.\n\nIf a TimeEntry is created by a Clio Connect user, the field is not editable.\n" } } }, "utbms_expense": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsExpense associated with the Activity. The keyword `null` is not valid for this field." } } }, "vendor": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with a HardCostEntry.\nUse the keyword `null` to specify no association.\n" } } } }, "required": [ "type", "date" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "activity_description": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ActivityDescription associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_task_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsTask associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_activity_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsActivity associated with the Activity. The keyword `null` is not valid for this field." } } }, "calendar_entry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntry associated with the Activity. The keyword `null` is not valid for this field." } } }, "client_portal": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ClientPortal associated with the Activity. The keyword `null` is not valid for this field." } } }, "communication": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Communication associated with the Activity. The keyword `null` is not valid for this field." } } }, "contact_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "date": { "type": "string", "format": "date", "description": "The date the Activity was performed. (Expects an ISO-8601 date)." }, "expense_category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExpenseCategory associated with an Activity.\nUse the keyword `null` to specify no association.\n" } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Activity. The keyword `null` is not valid for this field." } } }, "matter_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "no_charge": { "type": "boolean", "description": "Whether the non-billable *Activity* will be shown on the bill." }, "non_billable": { "type": "boolean", "description": "Whether or not this Activity is prevented from appearing as a line item in a bill.\nOnly valid for non-billed TimeEntries, and with the exception of the Activity having no_charge set to true.\n" }, "note": { "type": "string", "description": "A custom note to describe what the Activity is for." }, "price": { "type": "number", "format": "double", "description": "For an ExpenseEntry, HardCostEntry, and SoftCostEntry, it is the expense amount.\n\n[Support Link for ExpenseEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses)\n\n[Support Link for HardCostEntry and SoftCostEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses#enable-hard-and-soft-cost-expenses-0-0)\n\nFor a TimeEntry, it is the hourly or flat amount. When updating a TimeEntry,\nif the price is not given or the user does not have the permission to view the rate,\nand its activity description, matter and/or user is changed,\nthe price is reset according to the rate defined for the activity description, matter, client or user.\n\n[Support Link for Rates Hierarchy](https://help.clio.com/hc/en-us/articles/9289801180187-Rates-and-Rate-Hierarchies-)\n\n[Support Link for Billing Rate Visibility](https://help.clio.com/hc/en-us/articles/9285360193819-Permissions-and-Billing-Rates#billing-rate-visibility-0-3)\n" }, "quantity": { "type": "number", "format": "double", "description": "The field is applicable to TimeEntry, ExpenseEntry, and SoftCostEntry.\n\n**Version <= 4.0.3:**\nThe number of hours the TimeEntry took.\n\n**Latest version:**\nThe number of seconds the TimeEntry took.\n" }, "reference": { "type": "string", "description": "A check reference for a HardCostEntry." }, "start_timer": { "type": "boolean", "description": "Whether or not a timer should be started for this Activity. Only valid for non-FlatRate, non-billed TimeEntries." }, "task": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Task associated with the Activity. The keyword `null` is not valid for this field." } } }, "tax_setting": { "type": "string", "enum": [ "no_tax", "tax_1_only", "tax_2_only", "tax_1_and_tax_2" ], "description": "The option denoting whether primary tax, secondary tax, or both is applied to an expense entry." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration." }, "order": { "type": "integer", "format": "int32", "description": "The order in which the tax setting should be applied." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule determining when the tax setting should be applied" } }, "required": [ "tax_rate_configuration_id", "order" ] }, "description": "Array of objects, with each object representing a tax setting that is applied to an expense entry with 'tax_rate_configuration_id', 'order', and 'rule' as the object properties." }, "text_message_conversation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single TextMessageConversation associated with the Activity. The keyword `null` is not valid for this field." } } }, "type": { "type": "string", "enum": [ "TimeEntry", "ExpenseEntry", "HardCostEntry", "SoftCostEntry" ], "description": "The type of the Activity." }, "user": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single User associated with the Activity.\nUse the keyword `null` to specify no association.\nOn creation, if no user is specified, it will default to the current user.\n\nIf a TimeEntry is created by a Clio Connect user, the field is not editable.\n" } } }, "utbms_expense": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsExpense associated with the Activity. The keyword `null` is not valid for this field." } } }, "vendor": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with a HardCostEntry.\nUse the keyword `null` to specify no association.\n" } } } }, "required": [ "type", "date" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "activity_description": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ActivityDescription associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_task_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsTask associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_activity_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsActivity associated with the Activity. The keyword `null` is not valid for this field." } } }, "calendar_entry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntry associated with the Activity. The keyword `null` is not valid for this field." } } }, "client_portal": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ClientPortal associated with the Activity. The keyword `null` is not valid for this field." } } }, "communication": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Communication associated with the Activity. The keyword `null` is not valid for this field." } } }, "contact_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "date": { "type": "string", "format": "date", "description": "The date the Activity was performed. (Expects an ISO-8601 date)." }, "expense_category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExpenseCategory associated with an Activity.\nUse the keyword `null` to specify no association.\n" } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Activity. The keyword `null` is not valid for this field." } } }, "matter_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "no_charge": { "type": "boolean", "description": "Whether the non-billable *Activity* will be shown on the bill." }, "non_billable": { "type": "boolean", "description": "Whether or not this Activity is prevented from appearing as a line item in a bill.\nOnly valid for non-billed TimeEntries, and with the exception of the Activity having no_charge set to true.\n" }, "note": { "type": "string", "description": "A custom note to describe what the Activity is for." }, "price": { "type": "number", "format": "double", "description": "For an ExpenseEntry, HardCostEntry, and SoftCostEntry, it is the expense amount.\n\n[Support Link for ExpenseEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses)\n\n[Support Link for HardCostEntry and SoftCostEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses#enable-hard-and-soft-cost-expenses-0-0)\n\nFor a TimeEntry, it is the hourly or flat amount. When updating a TimeEntry,\nif the price is not given or the user does not have the permission to view the rate,\nand its activity description, matter and/or user is changed,\nthe price is reset according to the rate defined for the activity description, matter, client or user.\n\n[Support Link for Rates Hierarchy](https://help.clio.com/hc/en-us/articles/9289801180187-Rates-and-Rate-Hierarchies-)\n\n[Support Link for Billing Rate Visibility](https://help.clio.com/hc/en-us/articles/9285360193819-Permissions-and-Billing-Rates#billing-rate-visibility-0-3)\n" }, "quantity": { "type": "number", "format": "double", "description": "The field is applicable to TimeEntry, ExpenseEntry, and SoftCostEntry.\n\n**Version <= 4.0.3:**\nThe number of hours the TimeEntry took.\n\n**Latest version:**\nThe number of seconds the TimeEntry took.\n" }, "reference": { "type": "string", "description": "A check reference for a HardCostEntry." }, "start_timer": { "type": "boolean", "description": "Whether or not a timer should be started for this Activity. Only valid for non-FlatRate, non-billed TimeEntries." }, "task": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Task associated with the Activity. The keyword `null` is not valid for this field." } } }, "tax_setting": { "type": "string", "enum": [ "no_tax", "tax_1_only", "tax_2_only", "tax_1_and_tax_2" ], "description": "The option denoting whether primary tax, secondary tax, or both is applied to an expense entry." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration." }, "order": { "type": "integer", "format": "int32", "description": "The order in which the tax setting should be applied." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule determining when the tax setting should be applied" } }, "required": [ "tax_rate_configuration_id", "order" ] }, "description": "Array of objects, with each object representing a tax setting that is applied to an expense entry with 'tax_rate_configuration_id', 'order', and 'rule' as the object properties." }, "text_message_conversation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single TextMessageConversation associated with the Activity. The keyword `null` is not valid for this field." } } }, "type": { "type": "string", "enum": [ "TimeEntry", "ExpenseEntry", "HardCostEntry", "SoftCostEntry" ], "description": "The type of the Activity." }, "user": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single User associated with the Activity.\nUse the keyword `null` to specify no association.\nOn creation, if no user is specified, it will default to the current user.\n\nIf a TimeEntry is created by a Clio Connect user, the field is not editable.\n" } } }, "utbms_expense": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsExpense associated with the Activity. The keyword `null` is not valid for this field." } } }, "vendor": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with a HardCostEntry.\nUse the keyword `null` to specify no association.\n" } } } }, "required": [ "type", "date" ] } } } } }, "required": false } } }, "/activities/{id}.json": { "get": { "tags": [ "Activities" ], "summary": "Return the data for a single Activity", "operationId": "Activity#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Activity", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Activity.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Activity_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Activities" ], "summary": "Update a single Activity", "operationId": "Activity#update", "description": "Outlines the parameters and data fields used when updating a single Activity", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Activity.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Activity_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Activities", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "activity_description": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ActivityDescription associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_task_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsTask associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_activity_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsActivity associated with the Activity. The keyword `null` is not valid for this field." } } }, "calendar_entry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntry associated with the Activity. The keyword `null` is not valid for this field." } } }, "client_portal": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ClientPortal associated with the Activity. The keyword `null` is not valid for this field." } } }, "communication": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Communication associated with the Activity. The keyword `null` is not valid for this field." } } }, "contact_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "date": { "type": "string", "format": "date", "description": "The date the Activity was performed. (Expects an ISO-8601 date)." }, "expense_category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExpenseCategory associated with an Activity.\nUse the keyword `null` to specify no association.\n" } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Activity. The keyword `null` is not valid for this field." } } }, "matter_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "no_charge": { "type": "boolean", "description": "Whether the non-billable *Activity* will be shown on the bill." }, "non_billable": { "type": "boolean", "description": "Whether or not this Activity is prevented from appearing as a line item in a bill.\nOnly valid for non-billed TimeEntries, and with the exception of the Activity having no_charge set to true.\n" }, "note": { "type": "string", "description": "A custom note to describe what the Activity is for." }, "price": { "type": "number", "format": "double", "description": "For an ExpenseEntry, HardCostEntry, and SoftCostEntry, it is the expense amount.\n\n[Support Link for ExpenseEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses)\n\n[Support Link for HardCostEntry and SoftCostEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses#enable-hard-and-soft-cost-expenses-0-0)\n\nFor a TimeEntry, it is the hourly or flat amount. When updating a TimeEntry,\nif the price is not given or the user does not have the permission to view the rate,\nand its activity description, matter and/or user is changed,\nthe price is reset according to the rate defined for the activity description, matter, client or user.\n\n[Support Link for Rates Hierarchy](https://help.clio.com/hc/en-us/articles/9289801180187-Rates-and-Rate-Hierarchies-)\n\n[Support Link for Billing Rate Visibility](https://help.clio.com/hc/en-us/articles/9285360193819-Permissions-and-Billing-Rates#billing-rate-visibility-0-3)\n" }, "quantity": { "type": "number", "format": "double", "description": "The field is applicable to TimeEntry, ExpenseEntry, and SoftCostEntry.\n\n**Version <= 4.0.3:**\nThe number of hours the TimeEntry took.\n\n**Latest version:**\nThe number of seconds the TimeEntry took.\n" }, "reference": { "type": "string", "description": "A check reference for a HardCostEntry." }, "start_timer": { "type": "boolean", "description": "Whether or not a timer should be started for this Activity. Only valid for non-FlatRate, non-billed TimeEntries." }, "task": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Task associated with the Activity. The keyword `null` is not valid for this field." } } }, "tax_setting": { "type": "string", "enum": [ "no_tax", "tax_1_only", "tax_2_only", "tax_1_and_tax_2" ], "description": "The option denoting whether primary tax, secondary tax, or both is applied to an expense entry." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration." }, "order": { "type": "integer", "format": "int32", "description": "The order in which the tax setting should be applied." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule determining when the tax setting should be applied" } } }, "description": "Array of objects, with each object representing a tax setting that is applied to an expense entry with 'tax_rate_configuration_id', 'order', and 'rule' as the object properties." }, "text_message_conversation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single TextMessageConversation associated with the Activity. The keyword `null` is not valid for this field." } } }, "type": { "type": "string", "enum": [ "TimeEntry", "ExpenseEntry", "HardCostEntry", "SoftCostEntry" ], "description": "The type of the Activity." }, "user": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single User associated with the Activity.\nUse the keyword `null` to specify no association.\nOn creation, if no user is specified, it will default to the current user.\n\nIf a TimeEntry is created by a Clio Connect user, the field is not editable.\n" } } }, "utbms_expense": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsExpense associated with the Activity. The keyword `null` is not valid for this field." } } }, "vendor": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with a HardCostEntry.\nUse the keyword `null` to specify no association.\n" } } } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "activity_description": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ActivityDescription associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_task_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsTask associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_activity_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsActivity associated with the Activity. The keyword `null` is not valid for this field." } } }, "calendar_entry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntry associated with the Activity. The keyword `null` is not valid for this field." } } }, "client_portal": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ClientPortal associated with the Activity. The keyword `null` is not valid for this field." } } }, "communication": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Communication associated with the Activity. The keyword `null` is not valid for this field." } } }, "contact_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "date": { "type": "string", "format": "date", "description": "The date the Activity was performed. (Expects an ISO-8601 date)." }, "expense_category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExpenseCategory associated with an Activity.\nUse the keyword `null` to specify no association.\n" } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Activity. The keyword `null` is not valid for this field." } } }, "matter_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "no_charge": { "type": "boolean", "description": "Whether the non-billable *Activity* will be shown on the bill." }, "non_billable": { "type": "boolean", "description": "Whether or not this Activity is prevented from appearing as a line item in a bill.\nOnly valid for non-billed TimeEntries, and with the exception of the Activity having no_charge set to true.\n" }, "note": { "type": "string", "description": "A custom note to describe what the Activity is for." }, "price": { "type": "number", "format": "double", "description": "For an ExpenseEntry, HardCostEntry, and SoftCostEntry, it is the expense amount.\n\n[Support Link for ExpenseEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses)\n\n[Support Link for HardCostEntry and SoftCostEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses#enable-hard-and-soft-cost-expenses-0-0)\n\nFor a TimeEntry, it is the hourly or flat amount. When updating a TimeEntry,\nif the price is not given or the user does not have the permission to view the rate,\nand its activity description, matter and/or user is changed,\nthe price is reset according to the rate defined for the activity description, matter, client or user.\n\n[Support Link for Rates Hierarchy](https://help.clio.com/hc/en-us/articles/9289801180187-Rates-and-Rate-Hierarchies-)\n\n[Support Link for Billing Rate Visibility](https://help.clio.com/hc/en-us/articles/9285360193819-Permissions-and-Billing-Rates#billing-rate-visibility-0-3)\n" }, "quantity": { "type": "number", "format": "double", "description": "The field is applicable to TimeEntry, ExpenseEntry, and SoftCostEntry.\n\n**Version <= 4.0.3:**\nThe number of hours the TimeEntry took.\n\n**Latest version:**\nThe number of seconds the TimeEntry took.\n" }, "reference": { "type": "string", "description": "A check reference for a HardCostEntry." }, "start_timer": { "type": "boolean", "description": "Whether or not a timer should be started for this Activity. Only valid for non-FlatRate, non-billed TimeEntries." }, "task": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Task associated with the Activity. The keyword `null` is not valid for this field." } } }, "tax_setting": { "type": "string", "enum": [ "no_tax", "tax_1_only", "tax_2_only", "tax_1_and_tax_2" ], "description": "The option denoting whether primary tax, secondary tax, or both is applied to an expense entry." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration." }, "order": { "type": "integer", "format": "int32", "description": "The order in which the tax setting should be applied." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule determining when the tax setting should be applied" } } }, "description": "Array of objects, with each object representing a tax setting that is applied to an expense entry with 'tax_rate_configuration_id', 'order', and 'rule' as the object properties." }, "text_message_conversation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single TextMessageConversation associated with the Activity. The keyword `null` is not valid for this field." } } }, "type": { "type": "string", "enum": [ "TimeEntry", "ExpenseEntry", "HardCostEntry", "SoftCostEntry" ], "description": "The type of the Activity." }, "user": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single User associated with the Activity.\nUse the keyword `null` to specify no association.\nOn creation, if no user is specified, it will default to the current user.\n\nIf a TimeEntry is created by a Clio Connect user, the field is not editable.\n" } } }, "utbms_expense": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsExpense associated with the Activity. The keyword `null` is not valid for this field." } } }, "vendor": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with a HardCostEntry.\nUse the keyword `null` to specify no association.\n" } } } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "activity_description": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ActivityDescription associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_task_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsTask associated with the Activity. The keyword `null` is not valid for this field." }, "utbms_activity_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsActivity associated with the Activity. The keyword `null` is not valid for this field." } } }, "calendar_entry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntry associated with the Activity. The keyword `null` is not valid for this field." } } }, "client_portal": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ClientPortal associated with the Activity. The keyword `null` is not valid for this field." } } }, "communication": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Communication associated with the Activity. The keyword `null` is not valid for this field." } } }, "contact_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "date": { "type": "string", "format": "date", "description": "The date the Activity was performed. (Expects an ISO-8601 date)." }, "expense_category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExpenseCategory associated with an Activity.\nUse the keyword `null` to specify no association.\n" } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Activity. The keyword `null` is not valid for this field." } } }, "matter_note": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field." } } }, "no_charge": { "type": "boolean", "description": "Whether the non-billable *Activity* will be shown on the bill." }, "non_billable": { "type": "boolean", "description": "Whether or not this Activity is prevented from appearing as a line item in a bill.\nOnly valid for non-billed TimeEntries, and with the exception of the Activity having no_charge set to true.\n" }, "note": { "type": "string", "description": "A custom note to describe what the Activity is for." }, "price": { "type": "number", "format": "double", "description": "For an ExpenseEntry, HardCostEntry, and SoftCostEntry, it is the expense amount.\n\n[Support Link for ExpenseEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses)\n\n[Support Link for HardCostEntry and SoftCostEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses#enable-hard-and-soft-cost-expenses-0-0)\n\nFor a TimeEntry, it is the hourly or flat amount. When updating a TimeEntry,\nif the price is not given or the user does not have the permission to view the rate,\nand its activity description, matter and/or user is changed,\nthe price is reset according to the rate defined for the activity description, matter, client or user.\n\n[Support Link for Rates Hierarchy](https://help.clio.com/hc/en-us/articles/9289801180187-Rates-and-Rate-Hierarchies-)\n\n[Support Link for Billing Rate Visibility](https://help.clio.com/hc/en-us/articles/9285360193819-Permissions-and-Billing-Rates#billing-rate-visibility-0-3)\n" }, "quantity": { "type": "number", "format": "double", "description": "The field is applicable to TimeEntry, ExpenseEntry, and SoftCostEntry.\n\n**Version <= 4.0.3:**\nThe number of hours the TimeEntry took.\n\n**Latest version:**\nThe number of seconds the TimeEntry took.\n" }, "reference": { "type": "string", "description": "A check reference for a HardCostEntry." }, "start_timer": { "type": "boolean", "description": "Whether or not a timer should be started for this Activity. Only valid for non-FlatRate, non-billed TimeEntries." }, "task": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Task associated with the Activity. The keyword `null` is not valid for this field." } } }, "tax_setting": { "type": "string", "enum": [ "no_tax", "tax_1_only", "tax_2_only", "tax_1_and_tax_2" ], "description": "The option denoting whether primary tax, secondary tax, or both is applied to an expense entry." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration." }, "order": { "type": "integer", "format": "int32", "description": "The order in which the tax setting should be applied." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule determining when the tax setting should be applied" } } }, "description": "Array of objects, with each object representing a tax setting that is applied to an expense entry with 'tax_rate_configuration_id', 'order', and 'rule' as the object properties." }, "text_message_conversation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single TextMessageConversation associated with the Activity. The keyword `null` is not valid for this field." } } }, "type": { "type": "string", "enum": [ "TimeEntry", "ExpenseEntry", "HardCostEntry", "SoftCostEntry" ], "description": "The type of the Activity." }, "user": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single User associated with the Activity.\nUse the keyword `null` to specify no association.\nOn creation, if no user is specified, it will default to the current user.\n\nIf a TimeEntry is created by a Clio Connect user, the field is not editable.\n" } } }, "utbms_expense": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsExpense associated with the Activity. The keyword `null` is not valid for this field." } } }, "vendor": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with a HardCostEntry.\nUse the keyword `null` to specify no association.\n" } } } } } } } } }, "required": false } }, "delete": { "tags": [ "Activities" ], "summary": "Delete a single Activity", "operationId": "Activity#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single Activity", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Activity.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/activity_rates.json": { "get": { "tags": [ "Activity Rates" ], "summary": "Return the data for all ActivityRates", "operationId": "ActivityRate#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all ActivityRates", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "co_counsel_contact_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the ActivityRate records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "contact_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the ActivityRate records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter ActivityRate records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter ActivityRate records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of ActivityRate records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter ActivityRate records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ActivityRate_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Activity Rates" ], "summary": "Create a new ActivityRate", "operationId": "ActivityRate#create", "description": "Outlines the parameters and data fields used when creating a new ActivityRate", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ActivityRate_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Activity Rates", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "co_counsel_contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "flat_rate": { "type": "boolean", "description": "Whether this is a flat rate" }, "rate": { "type": "number", "format": "double", "description": "Monetary value of this rate. Either hourly value or flat rate value" } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "co_counsel_contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "flat_rate": { "type": "boolean", "description": "Whether this is a flat rate" }, "rate": { "type": "number", "format": "double", "description": "Monetary value of this rate. Either hourly value or flat rate value" } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "co_counsel_contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "flat_rate": { "type": "boolean", "description": "Whether this is a flat rate" }, "rate": { "type": "number", "format": "double", "description": "Monetary value of this rate. Either hourly value or flat rate value" } } } } } } }, "required": false } } }, "/activity_rates/{id}.json": { "get": { "tags": [ "Activity Rates" ], "summary": "Return the data for a single ActivityRate", "operationId": "ActivityRate#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single ActivityRate", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ActivityRate.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ActivityRate_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Activity Rates" ], "summary": "Update a single ActivityRate", "operationId": "ActivityRate#update", "description": "Outlines the parameters and data fields used when updating a single ActivityRate", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ActivityRate.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ActivityRate_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Activity Rates", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "co_counsel_contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "flat_rate": { "type": "boolean", "description": "Whether this is a flat rate" }, "rate": { "type": "number", "format": "double", "description": "Monetary value of this rate. Either hourly value or flat rate value" } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "co_counsel_contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "flat_rate": { "type": "boolean", "description": "Whether this is a flat rate" }, "rate": { "type": "number", "format": "double", "description": "Monetary value of this rate. Either hourly value or flat rate value" } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "co_counsel_contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "contact_id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the ActivityRate. The keyword `null` is not valid for this field." }, "flat_rate": { "type": "boolean", "description": "Whether this is a flat rate" }, "rate": { "type": "number", "format": "double", "description": "Monetary value of this rate. Either hourly value or flat rate value" } } } } } } }, "required": false } }, "delete": { "tags": [ "Activity Rates" ], "summary": "Delete a single ActivityRate", "operationId": "ActivityRate#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single ActivityRate", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ActivityRate.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/activity_descriptions.json": { "get": { "tags": [ "Activity Descriptions" ], "summary": "Return the data for all ActivityDescriptions", "operationId": "ActivityDescription#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all ActivityDescriptions", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter ActivityDescription records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "flat_rate", "in": "query", "description": "Filter ActivityDescription records to those that have a flat rate, or not.", "required": false, "schema": { "type": "boolean" } }, { "name": "ids[]", "in": "query", "description": "Filter ActivityDescription records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of ActivityDescription records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "rate_for[matter_id]", "in": "query", "description": "Matter id for rate calculation.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "rate_for[user_id]", "in": "query", "description": "User id for rate calculation. If not provided, the user associated to the API request is assumed.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "type", "in": "query", "description": "Filter ActivityDescription records to those of a specific type.", "required": false, "schema": { "type": "string", "enum": [ "utbms", "clio" ] } }, { "name": "updated_since", "in": "query", "description": "Filter ActivityDescription records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "user_id", "in": "query", "description": "The unique identifier for a single User. The keyword `null` is not valid for this field. The list will be filtered to include only the ActivityDescription records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ActivityDescription_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Activity Descriptions" ], "summary": "Create a new ActivityDescription", "operationId": "ActivityDescription#create", "description": "Outlines the parameters and data fields used when creating a new ActivityDescription", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ActivityDescription_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Activity Descriptions", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the ActivityDescription." }, "default": { "type": "boolean", "description": "Whether or not this should be the API User's default ActivityDescription." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field." } } } }, "name": { "type": "string", "description": "A detailed description of the ActivityDescription." }, "rate": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "default": 0, "description": "The rate of the ActivityDescription. This is ignored for 'User' rates." }, "non_billable_amount": { "type": "number", "format": "double", "default": 0, "description": "The non billable rate of the ActivityDescription. This is ignored for 'User' rates." }, "type": { "type": "string", "enum": [ "User", "FlatRate", "Custom" ], "description": "What kind of rate it will be." } } }, "visible_to_co_counsel": { "type": "boolean", "description": "Whether or not co counsels on the account can see this ActivityDescription." } }, "required": [ "name" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the ActivityDescription." }, "default": { "type": "boolean", "description": "Whether or not this should be the API User's default ActivityDescription." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field." } } } }, "name": { "type": "string", "description": "A detailed description of the ActivityDescription." }, "rate": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "default": 0, "description": "The rate of the ActivityDescription. This is ignored for 'User' rates." }, "non_billable_amount": { "type": "number", "format": "double", "default": 0, "description": "The non billable rate of the ActivityDescription. This is ignored for 'User' rates." }, "type": { "type": "string", "enum": [ "User", "FlatRate", "Custom" ], "description": "What kind of rate it will be." } } }, "visible_to_co_counsel": { "type": "boolean", "description": "Whether or not co counsels on the account can see this ActivityDescription." } }, "required": [ "name" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the ActivityDescription." }, "default": { "type": "boolean", "description": "Whether or not this should be the API User's default ActivityDescription." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field." } } } }, "name": { "type": "string", "description": "A detailed description of the ActivityDescription." }, "rate": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "default": 0, "description": "The rate of the ActivityDescription. This is ignored for 'User' rates." }, "non_billable_amount": { "type": "number", "format": "double", "default": 0, "description": "The non billable rate of the ActivityDescription. This is ignored for 'User' rates." }, "type": { "type": "string", "enum": [ "User", "FlatRate", "Custom" ], "description": "What kind of rate it will be." } } }, "visible_to_co_counsel": { "type": "boolean", "description": "Whether or not co counsels on the account can see this ActivityDescription." } }, "required": [ "name" ] } } } } }, "required": false } } }, "/activity_descriptions/{id}.json": { "get": { "tags": [ "Activity Descriptions" ], "summary": "Return the data for a single ActivityDescription", "operationId": "ActivityDescription#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single ActivityDescription", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ActivityDescription.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ActivityDescription_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Activity Descriptions" ], "summary": "Update a single ActivityDescription", "operationId": "ActivityDescription#update", "description": "Outlines the parameters and data fields used when updating a single ActivityDescription", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ActivityDescription.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ActivityDescription_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Activity Descriptions", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the ActivityDescription." }, "default": { "type": "boolean", "description": "Whether or not this should be the API User's default ActivityDescription." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field." }, "_deleted": { "type": "boolean", "description": "A flag to determine if this Group should lose access to this ActivityDescription." } } } }, "name": { "type": "string", "description": "A detailed description of the ActivityDescription." }, "rate": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "default": 0, "description": "The rate of the ActivityDescription. This is ignored for 'User' rates." }, "non_billable_amount": { "type": "number", "format": "double", "default": 0, "description": "The non billable rate of the ActivityDescription. This is ignored for 'User' rates." }, "type": { "type": "string", "enum": [ "User", "FlatRate", "Custom" ], "description": "What kind of rate it will be." } } }, "visible_to_co_counsel": { "type": "boolean", "description": "Whether or not co counsels on the account can see this ActivityDescription." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the ActivityDescription." }, "default": { "type": "boolean", "description": "Whether or not this should be the API User's default ActivityDescription." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field." }, "_deleted": { "type": "boolean", "description": "A flag to determine if this Group should lose access to this ActivityDescription." } } } }, "name": { "type": "string", "description": "A detailed description of the ActivityDescription." }, "rate": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "default": 0, "description": "The rate of the ActivityDescription. This is ignored for 'User' rates." }, "non_billable_amount": { "type": "number", "format": "double", "default": 0, "description": "The non billable rate of the ActivityDescription. This is ignored for 'User' rates." }, "type": { "type": "string", "enum": [ "User", "FlatRate", "Custom" ], "description": "What kind of rate it will be." } } }, "visible_to_co_counsel": { "type": "boolean", "description": "Whether or not co counsels on the account can see this ActivityDescription." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the ActivityDescription." }, "default": { "type": "boolean", "description": "Whether or not this should be the API User's default ActivityDescription." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field." }, "_deleted": { "type": "boolean", "description": "A flag to determine if this Group should lose access to this ActivityDescription." } } } }, "name": { "type": "string", "description": "A detailed description of the ActivityDescription." }, "rate": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "default": 0, "description": "The rate of the ActivityDescription. This is ignored for 'User' rates." }, "non_billable_amount": { "type": "number", "format": "double", "default": 0, "description": "The non billable rate of the ActivityDescription. This is ignored for 'User' rates." }, "type": { "type": "string", "enum": [ "User", "FlatRate", "Custom" ], "description": "What kind of rate it will be." } } }, "visible_to_co_counsel": { "type": "boolean", "description": "Whether or not co counsels on the account can see this ActivityDescription." } } } } } } }, "required": false } }, "delete": { "tags": [ "Activity Descriptions" ], "summary": "Delete a single ActivityDescription", "operationId": "ActivityDescription#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single ActivityDescription", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ActivityDescription.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/allocations.json": { "get": { "tags": [ "Allocations" ], "summary": "Return the data for all Allocations", "operationId": "Allocation#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Allocations", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "bill_id", "in": "query", "description": "The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the Allocation records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "contact_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Allocation records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter Allocation records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter Allocation records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Allocation records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the Allocation records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "order", "in": "query", "description": "Orders the Allocation records by the given field. Default: `date(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "date(asc)", "date(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "parent_id", "in": "query", "description": "ID of parent (either a Payment or CreditMemo) this allocation belongs to", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "parent_type", "in": "query", "description": "Filter Allocation records based on whether the parent is a CreditMemo or a Payment.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "Filter Allocation records to only those that are voided (`\"invalid\"`) or not voided (`\"valid\"`).", "required": false, "schema": { "type": "string", "enum": [ "valid", "invalid" ] } }, { "name": "updated_since", "in": "query", "description": "Filter Allocation records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Allocation_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/allocations/{id}.json": { "get": { "tags": [ "Allocations" ], "summary": "Return the data for a single Allocation", "operationId": "Allocation#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Allocation", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Allocation.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Allocation_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } } }, "/bank_accounts.json": { "get": { "tags": [ "Bank Accounts" ], "summary": "Return the data for all BankAccounts", "operationId": "BankAccount#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all BankAccounts", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter BankAccount records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter BankAccount records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of BankAccount records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the BankAccount records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "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)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "show_empty_accounts", "in": "query", "description": "Filter BankAccount records to those having a zero or non zero balance.", "required": false, "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "Filter BankAccount records to those having a specific status.", "required": false, "schema": { "type": "string", "enum": [ "opened", "closed" ] } }, { "name": "type", "in": "query", "description": "Filter BankAccount records to those having a specific type.", "required": false, "schema": { "type": "string", "enum": [ "OperatingAccount", "TrustAccount" ] } }, { "name": "updated_since", "in": "query", "description": "Filter BankAccount records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "user_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BankAccount. The list will be filtered to include only the BankAccount records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BankAccount_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Bank Accounts" ], "summary": "Create a new BankAccount", "operationId": "BankAccount#create", "description": "Outlines the parameters and data fields used when creating a new BankAccount", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BankAccount_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Bank Accounts", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Account number for the BankAccount.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.\n" }, "balance": { "type": "number", "format": "double", "description": "BankAccount balance." }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the client associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.\n" } } }, "controlled_account": { "type": "boolean", "description": "Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).\n\nWhen Compliant Trust Accounting is enabled, controlled bank accounts must be of type \"Trust\" and require bank name, client, and matter details. Client and matter cannot be updated after the account is created.\n" }, "currency": { "type": "string", "description": "Currency the BankAccount is in." }, "default_account": { "type": "boolean", "description": "Whether or not the BankAccount should be the default account." }, "domicile_branch": { "type": "string", "description": "Branch where the BankAccount was opened." }, "general_ledger_number": { "type": "string", "description": "General ledger number used for the Law Society of Alberta." }, "holder": { "type": "string", "description": "BankAccount holder." }, "institution": { "type": "string", "description": "Financial institution (bank name).\n\nWhen Compliant Trust Accounting is enabled and the BankAccount is controlled, this field is required.\n" }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the matter associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and the matter must belong to the same client specified in `client[id]`. This association cannot be updated after the account is created.\n" } } }, "name": { "type": "string", "description": "BankAccount name." }, "swift": { "type": "string", "description": "Identification code for the financial institution." }, "transit_number": { "type": "string", "description": "Transit number for the BankAccount branch.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts.\n" }, "type": { "type": "string", "enum": [ "Operating", "Trust" ], "description": "Type of BankAccount." } }, "required": [ "currency", "type" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Account number for the BankAccount.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.\n" }, "balance": { "type": "number", "format": "double", "description": "BankAccount balance." }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the client associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.\n" } } }, "controlled_account": { "type": "boolean", "description": "Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).\n\nWhen Compliant Trust Accounting is enabled, controlled bank accounts must be of type \"Trust\" and require bank name, client, and matter details. Client and matter cannot be updated after the account is created.\n" }, "currency": { "type": "string", "description": "Currency the BankAccount is in." }, "default_account": { "type": "boolean", "description": "Whether or not the BankAccount should be the default account." }, "domicile_branch": { "type": "string", "description": "Branch where the BankAccount was opened." }, "general_ledger_number": { "type": "string", "description": "General ledger number used for the Law Society of Alberta." }, "holder": { "type": "string", "description": "BankAccount holder." }, "institution": { "type": "string", "description": "Financial institution (bank name).\n\nWhen Compliant Trust Accounting is enabled and the BankAccount is controlled, this field is required.\n" }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the matter associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and the matter must belong to the same client specified in `client[id]`. This association cannot be updated after the account is created.\n" } } }, "name": { "type": "string", "description": "BankAccount name." }, "swift": { "type": "string", "description": "Identification code for the financial institution." }, "transit_number": { "type": "string", "description": "Transit number for the BankAccount branch.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts.\n" }, "type": { "type": "string", "enum": [ "Operating", "Trust" ], "description": "Type of BankAccount." } }, "required": [ "currency", "type" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Account number for the BankAccount.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.\n" }, "balance": { "type": "number", "format": "double", "description": "BankAccount balance." }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the client associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.\n" } } }, "controlled_account": { "type": "boolean", "description": "Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).\n\nWhen Compliant Trust Accounting is enabled, controlled bank accounts must be of type \"Trust\" and require bank name, client, and matter details. Client and matter cannot be updated after the account is created.\n" }, "currency": { "type": "string", "description": "Currency the BankAccount is in." }, "default_account": { "type": "boolean", "description": "Whether or not the BankAccount should be the default account." }, "domicile_branch": { "type": "string", "description": "Branch where the BankAccount was opened." }, "general_ledger_number": { "type": "string", "description": "General ledger number used for the Law Society of Alberta." }, "holder": { "type": "string", "description": "BankAccount holder." }, "institution": { "type": "string", "description": "Financial institution (bank name).\n\nWhen Compliant Trust Accounting is enabled and the BankAccount is controlled, this field is required.\n" }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the matter associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and the matter must belong to the same client specified in `client[id]`. This association cannot be updated after the account is created.\n" } } }, "name": { "type": "string", "description": "BankAccount name." }, "swift": { "type": "string", "description": "Identification code for the financial institution." }, "transit_number": { "type": "string", "description": "Transit number for the BankAccount branch.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts.\n" }, "type": { "type": "string", "enum": [ "Operating", "Trust" ], "description": "Type of BankAccount." } }, "required": [ "currency", "type" ] } } } } }, "required": false } } }, "/bank_accounts/{id}.json": { "get": { "tags": [ "Bank Accounts" ], "summary": "Return the data for a single BankAccount", "operationId": "BankAccount#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single BankAccount", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the BankAccount.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BankAccount_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Bank Accounts" ], "summary": "Update a single BankAccount", "operationId": "BankAccount#update", "description": "Outlines the parameters and data fields used when updating a single BankAccount", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the BankAccount.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BankAccount_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Bank Accounts", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Account number for the BankAccount.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.\n" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the client associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.\n" } } }, "controlled_account": { "type": "boolean", "description": "Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).\n\nWhen Compliant Trust Accounting is enabled, controlled bank accounts must be of type \"Trust\" and require bank name, client, and matter details. Client and matter cannot be updated after the account is created.\n" }, "currency": { "type": "string", "description": "Currency the BankAccount is in." }, "default_account": { "type": "boolean", "description": "Whether or not the BankAccount should be the default account." }, "domicile_branch": { "type": "string", "description": "Branch where the BankAccount was opened." }, "general_ledger_number": { "type": "string", "description": "General ledger number used for the Law Society of Alberta." }, "holder": { "type": "string", "description": "BankAccount holder." }, "institution": { "type": "string", "description": "Financial institution (bank name).\n\nWhen Compliant Trust Accounting is enabled and the BankAccount is controlled, this field is required.\n" }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the matter associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and the matter must belong to the same client specified in `client[id]`. This association cannot be updated after the account is created.\n" } } }, "name": { "type": "string", "description": "BankAccount name." }, "swift": { "type": "string", "description": "Identification code for the financial institution." }, "transit_number": { "type": "string", "description": "Transit number for the BankAccount branch.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts.\n" } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Account number for the BankAccount.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.\n" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the client associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.\n" } } }, "controlled_account": { "type": "boolean", "description": "Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).\n\nWhen Compliant Trust Accounting is enabled, controlled bank accounts must be of type \"Trust\" and require bank name, client, and matter details. Client and matter cannot be updated after the account is created.\n" }, "currency": { "type": "string", "description": "Currency the BankAccount is in." }, "default_account": { "type": "boolean", "description": "Whether or not the BankAccount should be the default account." }, "domicile_branch": { "type": "string", "description": "Branch where the BankAccount was opened." }, "general_ledger_number": { "type": "string", "description": "General ledger number used for the Law Society of Alberta." }, "holder": { "type": "string", "description": "BankAccount holder." }, "institution": { "type": "string", "description": "Financial institution (bank name).\n\nWhen Compliant Trust Accounting is enabled and the BankAccount is controlled, this field is required.\n" }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the matter associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and the matter must belong to the same client specified in `client[id]`. This association cannot be updated after the account is created.\n" } } }, "name": { "type": "string", "description": "BankAccount name." }, "swift": { "type": "string", "description": "Identification code for the financial institution." }, "transit_number": { "type": "string", "description": "Transit number for the BankAccount branch.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts.\n" } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Account number for the BankAccount.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.\n" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the client associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.\n" } } }, "controlled_account": { "type": "boolean", "description": "Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).\n\nWhen Compliant Trust Accounting is enabled, controlled bank accounts must be of type \"Trust\" and require bank name, client, and matter details. Client and matter cannot be updated after the account is created.\n" }, "currency": { "type": "string", "description": "Currency the BankAccount is in." }, "default_account": { "type": "boolean", "description": "Whether or not the BankAccount should be the default account." }, "domicile_branch": { "type": "string", "description": "Branch where the BankAccount was opened." }, "general_ledger_number": { "type": "string", "description": "General ledger number used for the Law Society of Alberta." }, "holder": { "type": "string", "description": "BankAccount holder." }, "institution": { "type": "string", "description": "Financial institution (bank name).\n\nWhen Compliant Trust Accounting is enabled and the BankAccount is controlled, this field is required.\n" }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for the matter associated with a controlled BankAccount.\n\nWhen Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and the matter must belong to the same client specified in `client[id]`. This association cannot be updated after the account is created.\n" } } }, "name": { "type": "string", "description": "BankAccount name." }, "swift": { "type": "string", "description": "Identification code for the financial institution." }, "transit_number": { "type": "string", "description": "Transit number for the BankAccount branch.\n\nWhen Compliant Trust Accounting is enabled, this field is required for operating accounts.\n" } } } } } } }, "required": false } }, "delete": { "tags": [ "Bank Accounts" ], "summary": "Delete a single BankAccount", "operationId": "BankAccount#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single BankAccount", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the BankAccount.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/bank_transactions.json": { "get": { "tags": [ "Bank Transactions" ], "summary": "Return the data for all BankTransactions", "operationId": "BankTransaction#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all BankTransactions", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "bank_account_id", "in": "query", "description": "The unique identifier for a single BankAccount. The keyword `null` is not valid for this field. The list will be filtered to include only the BankTransaction records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "client_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BankTransaction records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter BankTransaction records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter BankTransaction records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of BankTransaction records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BankTransaction records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "order", "in": "query", "description": "Orders the BankTransaction records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Filter BankTransaction records to those having a specific type.", "required": false, "schema": { "type": "string", "enum": [ "asset", "liability" ] } }, { "name": "unreconciled_only", "in": "query", "description": "Filter BankTransaction records to only those that are unreconciled", "required": false, "schema": { "type": "boolean" } }, { "name": "updated_since", "in": "query", "description": "Filter BankTransaction records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BankTransaction_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Bank Transactions" ], "summary": "Create a new BankTransaction", "operationId": "BankTransaction#create", "description": "Outlines the parameters and data fields used when creating a new BankTransaction", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BankTransaction_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Bank Transactions", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "The amount of the transaction." }, "bank_account": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single BankAccount associated with the BankTransaction. The keyword `null` is not valid for this field." } }, "required": [ "id" ] }, "bank_account_transaction_type": { "type": "string", "description": "The type of bank account transaction (e.g., trust_interest, bank_charge)." }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "confirmation": { "type": "string", "description": "The reference code for the transaction." }, "currency": { "type": "string", "description": "The currency of the transaction." }, "date": { "type": "string", "format": "date", "description": "The date of the BankTransaction (Expects an ISO-8601 date)." }, "description": { "type": "string", "description": "The description of the transaction." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate of the transaction." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "source": { "type": "string", "description": "Where the transaction came from." }, "transaction_type": { "type": "string", "description": "What kind of transaction." } }, "required": [ "amount", "bank_account", "date" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "The amount of the transaction." }, "bank_account": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single BankAccount associated with the BankTransaction. The keyword `null` is not valid for this field." } }, "required": [ "id" ] }, "bank_account_transaction_type": { "type": "string", "description": "The type of bank account transaction (e.g., trust_interest, bank_charge)." }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "confirmation": { "type": "string", "description": "The reference code for the transaction." }, "currency": { "type": "string", "description": "The currency of the transaction." }, "date": { "type": "string", "format": "date", "description": "The date of the BankTransaction (Expects an ISO-8601 date)." }, "description": { "type": "string", "description": "The description of the transaction." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate of the transaction." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "source": { "type": "string", "description": "Where the transaction came from." }, "transaction_type": { "type": "string", "description": "What kind of transaction." } }, "required": [ "amount", "bank_account", "date" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "The amount of the transaction." }, "bank_account": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single BankAccount associated with the BankTransaction. The keyword `null` is not valid for this field." } }, "required": [ "id" ] }, "bank_account_transaction_type": { "type": "string", "description": "The type of bank account transaction (e.g., trust_interest, bank_charge)." }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "confirmation": { "type": "string", "description": "The reference code for the transaction." }, "currency": { "type": "string", "description": "The currency of the transaction." }, "date": { "type": "string", "format": "date", "description": "The date of the BankTransaction (Expects an ISO-8601 date)." }, "description": { "type": "string", "description": "The description of the transaction." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate of the transaction." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "source": { "type": "string", "description": "Where the transaction came from." }, "transaction_type": { "type": "string", "description": "What kind of transaction." } }, "required": [ "amount", "bank_account", "date" ] } } } } }, "required": false } } }, "/bank_transactions/{id}.json": { "get": { "tags": [ "Bank Transactions" ], "summary": "Return the data for a single BankTransaction", "operationId": "BankTransaction#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single BankTransaction", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the BankTransaction.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BankTransaction_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Bank Transactions" ], "summary": "Update a single BankTransaction", "operationId": "BankTransaction#update", "description": "Outlines the parameters and data fields used when updating a single BankTransaction", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the BankTransaction.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BankTransaction_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Bank Transactions", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "The amount of the transaction." }, "bank_account": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single BankAccount associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "bank_account_transaction_type": { "type": "string", "description": "The type of bank account transaction (e.g., trust_interest, bank_charge)." }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "confirmation": { "type": "string", "description": "The reference code for the transaction." }, "currency": { "type": "string", "description": "The currency of the transaction." }, "date": { "type": "string", "format": "date", "description": "The date of the BankTransaction (Expects an ISO-8601 date)." }, "description": { "type": "string", "description": "The description of the transaction." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate of the transaction." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "source": { "type": "string", "description": "Where the transaction came from." }, "transaction_type": { "type": "string", "description": "What kind of transaction." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "The amount of the transaction." }, "bank_account": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single BankAccount associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "bank_account_transaction_type": { "type": "string", "description": "The type of bank account transaction (e.g., trust_interest, bank_charge)." }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "confirmation": { "type": "string", "description": "The reference code for the transaction." }, "currency": { "type": "string", "description": "The currency of the transaction." }, "date": { "type": "string", "format": "date", "description": "The date of the BankTransaction (Expects an ISO-8601 date)." }, "description": { "type": "string", "description": "The description of the transaction." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate of the transaction." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "source": { "type": "string", "description": "Where the transaction came from." }, "transaction_type": { "type": "string", "description": "What kind of transaction." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "The amount of the transaction." }, "bank_account": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single BankAccount associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "bank_account_transaction_type": { "type": "string", "description": "The type of bank account transaction (e.g., trust_interest, bank_charge)." }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Contact associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "confirmation": { "type": "string", "description": "The reference code for the transaction." }, "currency": { "type": "string", "description": "The currency of the transaction." }, "date": { "type": "string", "format": "date", "description": "The date of the BankTransaction (Expects an ISO-8601 date)." }, "description": { "type": "string", "description": "The description of the transaction." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate of the transaction." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the BankTransaction. The keyword `null` is not valid for this field." } } }, "source": { "type": "string", "description": "Where the transaction came from." }, "transaction_type": { "type": "string", "description": "What kind of transaction." } } } } } } }, "required": false } }, "delete": { "tags": [ "Bank Transactions" ], "summary": "Delete a single BankTransaction", "operationId": "BankTransaction#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single BankTransaction", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the BankTransaction.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/bank_transfers/{id}.json": { "get": { "tags": [ "Bank Transfers" ], "summary": "Return the data for a single BankTransfer", "operationId": "BankTransfer#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single BankTransfer", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the BankTransfer.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BankTransfer_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } } }, "/bill_themes.json": { "get": { "tags": [ "Bill Themes" ], "summary": "Return the data for all BillThemes", "operationId": "BillTheme#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all BillThemes", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter BillTheme records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter BillTheme records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of BillTheme records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter BillTheme records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillTheme_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/bill_themes/{id}.json": { "patch": { "tags": [ "Bill Themes" ], "summary": "Update a single BillTheme", "operationId": "BillTheme#update", "description": "Outlines the parameters and data fields used when updating a single BillTheme", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the BillTheme.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillTheme_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Bill Themes", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "config": { "type": "string", "description": "A string containing settings for the BillTheme.\nValues set in this string will apply to any bill using this BillTheme, unless overridden by the bill.\n\nAvailable settings within this string:\n- \"show\": Values set under this key determine how/if sections will appear on a bill.\n- \"text\": Values set under this key determine what will display if the section is shown.\n- \"css\": Values set under this key determine CSS rules for sections on a bill.\n\nAvailable settings under \"show\":\n- \"client_account\": Can be set to \"hidden\", \"details\", or \"summary\" to control the display and content of this section.\n- \"client_account_details_balance_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_include_matter_transfers\": Can be set to true/false to toggle displaying this section.\n- \"client_account_matter_date_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_matter_details_description_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_matter_title_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_matter_type_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_only_bill_matters\": Can be set to true/false to toggle displaying this section.\n- \"client_account_other_matters\": Can be set to true/false to toggle displaying this section.\n- \"client_account_payments_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_receipts_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_summary_balance_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"client_operating_account_omit_balance\": Can be set to true/false to toggle displaying this section.\n- \"clio_payments_amount_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_amount_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_date_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_date_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_note_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_note_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_reference_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_reference_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_status_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_status_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"draft_watermark\": Can be set to true/false to toggle displaying a draft watermark. Will only affect bills in draft.\n- \"envelope_friendly\": Can be set to true/false to toggle size styling for the bill.\n- \"firm_address\": Can be set to true/false to toggle displaying this section.\n- \"firm_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"firm_title\": Can be set to true/false to toggle displaying this section.\n- \"footer_invoice_memo\": Can be set to true/false to toggle displaying this section.\n- \"footer_invoice_payable\": Can be set to true/false to toggle displaying this section.\n- \"footer_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"footer_page_numbers\": Can be set to true/false to toggle displaying this section.\n- \"header_invoice_issued_date\": Can be set to true/false to toggle displaying this section.\n- \"header_invoice_number\": Can be set to true/false to toggle displaying this section.\n- \"header_on_first_page\": Can be set to true/false to toggle displaying this section.\n- \"interest_date\": Can be set to true/false to toggle displaying this section.\n- \"interest_date_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_date_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_description\": Can be set to true/false to toggle displaying this section.\n- \"interest_details_description\": Can be set to true/false to toggle displaying this section.\n- \"interest_details_description_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_details_description_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_details_description_new_line\": Can be set to true/false to toggle displaying a interest descriptions on a new line.\n- \"interest_headings_order\": Should be set to an array that contains the values: [\"interest_type\",\" interest_date\", \"interest_details_description\", \"interest_total\"] in the order you would like the sections to display on your bills.\n- \"interest_total\": Can be set to true/false to toggle displaying this section.\n- \"interest_total_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_total_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_totals_subtotal\": Can be set to true/false to toggle displaying this section.\n- \"interest_type\": Can be set to true/false to toggle displaying this section.\n- \"interest_type_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_type_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"invoice_information_due_date\": Can be set to true/false to toggle displaying this section.\n- \"invoice_information_invoice_number\": Can be set to true/false to toggle displaying this section.\n- \"invoice_information_issue_date\": Can be set to true/false to toggle displaying this section.\n- \"invoice_title\": Can be set to true/false to toggle displaying this section.\n- \"logo\": Can be set to true/false to toggle displaying this section.\n- \"logo_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"matter_attorney_display\": Can be set to \"name\" or \"initials\" to control the content shown in this section.\n- \"matter_attorney_initials\": Can be set to true/false to toggle displaying this section.\n- \"matter_attorney_initials_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_attorney_initials_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_attorney_initials_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_attorney_initials_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_attorney_summary_position_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_attorney_summary_time_keeper_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_client_ref\": Can be set to true/false to toggle displaying this section.\n- \"matter_date\": Can be set to true/false to toggle displaying this section.\n- \"matter_date_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_date_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_date_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_date_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_date_trust\": Can be set to true/false to toggle displaying this section.\n- \"matter_description\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_details_description_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_details_description_new_line\": Can be set to true/false to toggle displaying a matter descriptions on a new line.\n- \"matter_details_description_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description_trust\": Can be set to true/false to toggle displaying this section.\n- \"matter_heading_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"matter_headings_order\": Should be set to an array that contains the values: [\"matter_type\", \"matter_attorney_initials\", \"matter_date\", \"matter_details_description\", \"matter_quantity\", \"matter_rate\", \"matter_line_item_discount\", \"matter_total\", \"matter_total_with_tax\", \"matter_tax\"]\nin the order you would like the sections to display on your bills.\n- \"matter_headings_order_expenses\": Should be set to an array that contains the values: [\"matter_type\", \"matter_attorney_initials\", \"matter_date\", \"matter_details_description\", \"matter_quantity\", \"matter_rate\", \"matter_line_item_discount\", \"matter_total\", \"matter_total_with_tax\", \"matter_tax\"]\nin the order you would like the sections to display on your bills.\n- \"matter_headings_order_products\": Should be set to an array that contains the values: [\"matter_type\", \"matter_attorney_initials\", \"matter_date\", \"matter_details_description\", \"matter_quantity\", \"matter_rate\", \"matter_line_item_discount\", \"matter_total\", \"matter_total_with_tax\", \"matter_tax\"]\nin the order you would like the sections to display on your bills.\n- \"matter_headings_order_trust\": Should be set to an array that contains the values: [\"matter_date\", \"matter_details_description\", \"matter_total\"] in the order you would like the sections to display on your bills.\n- \"matter_individual_payments\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_line_item_discount_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_line_item_discount_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_line_items_activity_descriptions\": Can be set to true/false to toggle displaying this section.\n- \"matter_number\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_quantity_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_quantity_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_rate\": Can be set to true/false to toggle displaying this section.\n- \"matter_rate_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_rate_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_rate_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_rate_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_rate_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_separate_line_items\": Can be set to true/false to toggle displaying this section.\n- \"matter_show_amount_with_percentage\": Can be set to true/false to toggle displaying this section.\n- \"matter_tax_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_tax_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_trust\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_with_tax_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_with_tax_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_totals_subtotal\": Can be set to true/false to toggle displaying this section.\n- \"matter_totals_subtotal_line_item_discount\": Can be set to true/false to toggle displaying this section.\n- \"matter_type\": Can be set to true/false to toggle displaying this section.\n- \"matter_type_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_type_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_type_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_type_products\": Can be set to true/false to toggle displaying this section.\n- \"payment_profile_discount\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill does not have an early payment discount.\n- \"payment_profile_grace_period\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill does not have a grace period.\n- \"payment_profile_interest\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill does not have a recurring interest charge.\n- \"payment_profile_no_grace_period\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill has a grace period.\n- \"show_clio_payments\": Can be set to true/false to toggle displaying this section.\n- \"soa_title\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts_amount_due_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_amount_due_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_balance_due_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_balance_due_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_details\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts_due_on_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_due_on_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_include_trust\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts_invoice_number_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_invoice_number_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_note\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if \"statement_of_accounts_summary\" is \"hidden\".\n- \"statement_of_accounts_payments_received_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_payments_received_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_summary\": Can be set to \"hidden\", \"above\", or \"below\" to control the location of this section. This will determine if the statements of account section on the bill is displayed, and if it displays above or below the line items.\n- \"statement_of_accounts_summary_detail\": Can be set to \"simple\", \"with_payment\", or \"with_account_balance\" to control the values shown in this section.\n- \"statement_of_accounts_summary_only_bill_matters\": Can be set to true/false to control the values shown in this section.\n- \"void_watermark\": Can be set to true/false to toggle displaying a void watermark. Will only affect bills that have been void.\n\n\nAvailable settings under \"text\", each of these can be set to the text you would like to display when they are shown, some of these fields allow substituting values with codes wrapped in curly braces:\n- \"address_email\"\n- \"address_fax\"\n- \"address_phone\"\n- \"vat_number_au\"\n- \"vat_number_eu\"\n- \"attorney_summary_position\"\n- \"attorney_summary_time_keeper\"\n- \"client_account_account\"\n- \"client_account_balance\"\n- \"client_account_payments\"\n- \"client_account_receipts\"\n- \"client_account_total_balance\"\n- \"clio_payments_amount\"\n- \"clio_payments_date\"\n- \"clio_payments_note\"\n- \"clio_payments_reference\"\n- \"clio_payments_status\"\n- \"clio_payments_title\"\n- \"clio_payments_total\"\n- \"discount_early_payment_balance_owing_text\"\n- \"discount_early_payment_end_date_text\"\n- \"discount_early_payment_text\"\n- \"discount_early_payment_total_text\"\n- \"footer_invoice_memo\"\n - {{billing_setting_memo}}\" can be used to reference your billing settings memo.\n - {{bill_memo}} can be used to reference your bills memo.\n- \"footer_invoice_payable\"\n - {{firm_name}} can be used to reference your firms name.\n- \"footer_page\"\n- \"footer_page_of\"\n- \"grand_total_text\"\n - {{same_as_total_heading}} can be used to reference the value in \"text\" => \"matter_total_text\"\n- \"interest_date_text\"\n- \"interest_details_description_text\"\n- \"interest_subtotal_text\"\n- \"interest_text\"\n- \"interest_title_text\"\n- \"interest_total_text\"\n- \"interest_type_text\"\n- \"invoice_client_sales_tax_text\"\n- \"invoice_due_date_text\"\n- \"invoice_information_due_date_receipt_text\"\n- \"invoice_issued_date_text\"\n- \"invoice_lc\"\n- \"invoice_number_text\"\n- \"invoice_purchase_order_text\"\n- \"invoice_title\"\n- \"matter_attorney_initials_text\"\n- \"matter_balance_owing_text\"\n- \"matter_client_ref\"\n - {{client_ref_num}}\" can be used to reference the matters client reference.\n- \"matter_credit_note_text\"\n- \"matter_date_text\"\n- \"matter_details_description_text\"\n- \"matter_discount_text\"\n- \"matter_expense_disbursement_title_text\"\n- \"matter_expense_subtotal_text\"\n- \"matter_expense_text\"\n- \"matter_expense_title_text\"\n- \"matter_grand_total_text\"\n - {{same_as_total_heading}} can be used to reference the value in \"text\" => \"matter_total_text\"\n- \"matter_line_item_discount_expenses_text\"\n- \"matter_line_item_discount_products_text\"client_address_custom\"\n- \"matter_line_item_discount_subtotal_text\"\n- \"matter_line_item_discount_text\"\n- \"matter_non_billable_expenses_title_text\"\n- \"matter_non_billable_grouped_title_text\"\n- \"matter_non_billable_products_title_text\"\n- \"matter_non_billable_services_title_text\"\n- \"matter_payment_text\"\n- \"matter_product_subtotal_text\"\n- \"matter_product_text\"\n- \"matter_product_title_text\"\n- \"matter_quantity_expenses_text\"\n- \"matter_quantity_products_text\"\n- \"matter_quantity_subtotal_text\"\n- \"matter_quantity_text\"\n- \"matter_quantity_total_text\"\n- \"matter_rate_expenses_text\"\n- \"matter_rate_products_text\"\n- \"matter_rate_text\"\n- \"matter_refund_text\"\n- \"matter_service_subtotal_text\"\n- \"matter_service_text\"\n- \"matter_service_title_text\"\n- \"matter_subtotal_text\"\n- \"matter_tax_text\"\n- \"matter_title\"\n- \"matter_total_text\"\n- \"matter_total_with_tax_text\"\n- \"matter_trust_line_items_title_text\"\n- \"matter_trust_text\"\n- \"matter_type_text\"\n- \"payment_profile\"\n- \"payment_profile_discount\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"payment_profile_grace_period\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"payment_profile_interest\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"payment_profile_no_grace_period\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"remittance_checks\"\n- \"remittance_checks_label\"\n- \"remittance_checks_title\"\n- \"remittance_note\"\n - {{bill_number}} can be used to reference the bills number.\n- \"remittance_note_soa\"\n- \"remittance_title\"\n- \"remittance_wire_bank_account\"\n- \"remittance_wire_bank_account_label\"\n- \"remittance_wire_bank_name\"\n- \"remittance_wire_bank_name_label\"\n- \"remittance_wire_bank_routing\"\n- \"remittance_wire_bank_routing_label\"\n- \"remittance_wire_bank_swift\"\n- \"remittance_wire_bank_swift_label\"\n- \"remittance_wire_title\"\n- \"soa_title\"\n- \"statement_of_accounts_amount\"\n- \"statement_of_accounts_amount_in_trust\"\n- \"statement_of_accounts_amount_on_account\"\n- \"statement_of_accounts_balance\"\n- \"statement_of_accounts_current_invoice\"\n- \"statement_of_accounts_details_title\"\n- \"statement_of_accounts_due_on\"\n- \"statement_of_accounts_invoice_number\"\n- \"statement_of_accounts_new_charges\"\n- \"statement_of_accounts_note\"\n - {{firm_name}} can be used to reference your firms name.\n- \"statement_of_accounts_original_invoice_number\"\n- \"statement_of_accounts_other_interest_invoices\"\n- \"statement_of_accounts_other_invoices\"\n- \"statement_of_accounts_outstanding_balance\"\n- \"statement_of_accounts_detailed_outstanding_balance\"\n- \"statement_of_accounts_payments\"\n- \"statement_of_accounts_summary_title\"\n- \"statement_of_accounts_total_balance\"\n- \"statement_of_accounts_total_credit\"\n- \"statement_of_accounts_total_outstanding_balance\"\n- \"statement_of_accounts_detailed_total_outstanding_balance\"\n- \"trust_request_adjustments_title_text\"\n- \"trust_request_lc\"\n- \"trust_request_number_text\"\n- \"trust_request_title\"\n- \"trust_request_total_text\"\n\n\nAvailable settings under \"css\", each of these has nested values that can be set to apply CSS rules to bills:\n- \"client\"\n - \"color\": Color used in the client section. Value is in 'Hex'.\n - \"font-family\": Font used in client section.\n - \"font-size\": Font size in client section. Value is in 'em'.\n- \"client_address\"\n - \"margin-bottom\": Bottom margin size for the client address. Value is in 'em'.\n- \"firm_title\"\n - \"margin-bottom\": Bottom margin height for the bills firm title. Value is in 'em'.\n - \"color\": Color for the bills firm title section. Value is in 'Hex'.\n - \"font-family\": Font used for text in the firm title.\n - \"font-size\": Font size for the bills firm title. Value is in 'em'.\n - \"border-color\": Border color property for the firm title on a bill. Value is in 'Hex'.\n - \"border-style\": Border style property for the firm title on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-width\": Border width property for table rows on a bill. Accepts standard CSS options for 'border-width' property.\n - \"background-color\": Background color for the firm title on a bill. Value is in 'Hex'.\n- \"header\"\n - \"margin-bottom\": Bottom margin size for the bill header. Value is in 'em'.\n- \"inside_margins\"\n - \"font-family\": Primary font used on the bill.\n - \"font-size\": Primary font size used for bill.\n - \"color\": Primary font used on the bill, default is \"Arial\".\n- \"invoice_title\"\n - \"color\": Color used in the invoice title section. Value is in 'Hex'.\n - \"font-family\": Font used in invoice title section.\n - \"font-size\": Font size in invoice title section. Value is in 'em'.\n- \"logo_img\"\n - \"height\": Height for the bills logo image. Value is in 'em'.\n - \"margin-top\": Top margin height for the bills logo image. Value is in 'em'.\n - \"margin-bottom\": Bottom margin height for the bills logo image. Value is in 'em'.\n- \"matter_description\"\n - \"margin-top\": Top margin size for matter description section. Value is in 'em'.\n - \"color\": Color used in the matter description section. Value is in 'Hex'.\n - \"font-family\": Font used in matter description section.\n - \"font-size\": Font size in matter description section. Value is in 'em'.\n- \"matter_number\"\n - \"color\": Color used in the matter number section. Value is in 'Hex'.\n - \"font-family\": Font used in matter number section.\n - \"font-size\": Font size in matter number section. Value is in 'em'.\n- \"page_margins\"\n - \"margin-left\": Left margin size for the bill. Value is in 'em'.\n - \"margin-right\": Right margin size for the bill. Value is in 'em'.\n - \"margin-top\": Top margin size for the bill. Value is in 'em'.\n - \"margin-bottom\": Bottom margin size for the bill. Value is in 'em'.\n - \"size\": Size property for the bill, default is \"US-Letter\".\n- \"remittance_title\"\n - \"color\": Color used in the remittance title section. Value is in 'Hex'.\n - \"font-family\": Font used in remittance title section.\n - \"font-size\": Font size in remittance title section. Value is in 'em'.\n - \"background-color\": Background color for the remittance title section on a bill. Value is in 'Hex'.\n - \"border-color\": Border color property for the remittance title section on a bill. Value is in 'Hex'.\n - \"border-style\": Border style property for the remittance title section on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-width\": Border width property for the remittance title section on a bill. Accepts standard CSS options for 'border-width' property.\n- \"statement_of_accounts_title\"\n - \"color\": Color used in the statement of accounts section. Value is in 'Hex'.\n - \"font-family\": Font used in statement of accounts section.\n - \"font-size\": Font size in statement of accounts section. Value is in 'em'.\n - \"background-color\": Background color for the statement of accounts section on a bill. Value is in 'Hex'.\n - \"border-color\": Border color property for the statement of accounts section on a bill. Value is in 'Hex'.\n - \"border-style\": Border style property for the statement of accounts section on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-width\": Border width property for the statement of accounts section on a bill. Accepts standard CSS options for 'border-width' property.\n- \"table_even_line\"\n - \"background-color\": Background color for even table rows. Value is in 'Hex'.\n- \"table_h4\"\n - \"background-color\": Background color for table headers. Value is in 'Hex'.\n- \"table_line\"\n - \"border-bottom-width\": Bottom border width for table rows. Value is in 'px'.\n - \"border-bottom-style\": Bottom border style property for table rows on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-bottom-color\": Bottom border color property for table rows on a bill. Value is in 'Hex'.\n- \"table_odd_line\"\n - \"background-color\": Background color for odd table rows. Value is in 'Hex'.\n\n\nA config with samples of each type of option is shown below:\n```\n config = {\n \"show\": {\n \"statement_of_accounts_summary\": \"left\"\n \"statement_of_accounts_note\": true,\n \"footer_invoice_payable\": true,\n \"footer_invoice_memo\": true,\n \"payment_profile_no_grace_period\": true,\n \"payment_profile_grace_period\": true,\n \"payment_profile_discount\": true,\n \"payment_profile_interest\": true,\n \"interest_headings_order\": [\"interest_type\",\" interest_date\", \"interest_details_description\", \"interest_total\"]\n },\n \"text\": {\n \"statement_of_accounts_note\": \"Please make all amounts payable to: {{firm_name}}\",\n \"footer_invoice_payable\": \"Please make all amounts payable to: {{firm_name}}\",\n \"footer_invoice_memo\": \"{{bill_memo}}\",\n \"payment_profile_no_grace_period\": \"Payment is due upon receipt.\",\n \"payment_profile_grace_period\": \"Please pay within {{grace_period}}.\",\n \"payment_profile_discount\": \"{{discount_rate}}% discount will be applied if payment is received within {{discount_period}}.\",\n \"payment_profile_interest\": \"{{interest_rate}}% {{interest_type}} annual interest will be charged every {{interest_period}}.\",\n },\n \"css\": {\n \"statement_of_accounts_title\": {\n \"color\": \"#00cc00\",\n \"font-family\": \"Times New Roman\",\n \"font-size\": \"0.875em\",\n \"background-color\": \"#ccff99\",\n \"border-color\": \"#0033ff\",\n \"border-style\": \"dotted\",\n \"border-width\": \"thick\"\n },\n \"remittance_title\": {\n \"color\": \"#00ff00\",\n \"background-color\": \"None\",\n \"border-color\": \"#0033cc\",\n \"border-width\": \"medium\",\n \"border-style\": \"dotted\",\n \"font-family\": \"Arial\",\n \"font-size\": \"1.5em\"\n }\n }\n }\n```\n" }, "name": { "type": "string", "description": "Name of the BillTheme." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "config": { "type": "string", "description": "A string containing settings for the BillTheme.\nValues set in this string will apply to any bill using this BillTheme, unless overridden by the bill.\n\nAvailable settings within this string:\n- \"show\": Values set under this key determine how/if sections will appear on a bill.\n- \"text\": Values set under this key determine what will display if the section is shown.\n- \"css\": Values set under this key determine CSS rules for sections on a bill.\n\nAvailable settings under \"show\":\n- \"client_account\": Can be set to \"hidden\", \"details\", or \"summary\" to control the display and content of this section.\n- \"client_account_details_balance_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_include_matter_transfers\": Can be set to true/false to toggle displaying this section.\n- \"client_account_matter_date_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_matter_details_description_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_matter_title_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_matter_type_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_only_bill_matters\": Can be set to true/false to toggle displaying this section.\n- \"client_account_other_matters\": Can be set to true/false to toggle displaying this section.\n- \"client_account_payments_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_receipts_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_summary_balance_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"client_operating_account_omit_balance\": Can be set to true/false to toggle displaying this section.\n- \"clio_payments_amount_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_amount_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_date_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_date_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_note_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_note_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_reference_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_reference_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_status_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_status_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"draft_watermark\": Can be set to true/false to toggle displaying a draft watermark. Will only affect bills in draft.\n- \"envelope_friendly\": Can be set to true/false to toggle size styling for the bill.\n- \"firm_address\": Can be set to true/false to toggle displaying this section.\n- \"firm_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"firm_title\": Can be set to true/false to toggle displaying this section.\n- \"footer_invoice_memo\": Can be set to true/false to toggle displaying this section.\n- \"footer_invoice_payable\": Can be set to true/false to toggle displaying this section.\n- \"footer_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"footer_page_numbers\": Can be set to true/false to toggle displaying this section.\n- \"header_invoice_issued_date\": Can be set to true/false to toggle displaying this section.\n- \"header_invoice_number\": Can be set to true/false to toggle displaying this section.\n- \"header_on_first_page\": Can be set to true/false to toggle displaying this section.\n- \"interest_date\": Can be set to true/false to toggle displaying this section.\n- \"interest_date_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_date_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_description\": Can be set to true/false to toggle displaying this section.\n- \"interest_details_description\": Can be set to true/false to toggle displaying this section.\n- \"interest_details_description_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_details_description_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_details_description_new_line\": Can be set to true/false to toggle displaying a interest descriptions on a new line.\n- \"interest_headings_order\": Should be set to an array that contains the values: [\"interest_type\",\" interest_date\", \"interest_details_description\", \"interest_total\"] in the order you would like the sections to display on your bills.\n- \"interest_total\": Can be set to true/false to toggle displaying this section.\n- \"interest_total_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_total_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_totals_subtotal\": Can be set to true/false to toggle displaying this section.\n- \"interest_type\": Can be set to true/false to toggle displaying this section.\n- \"interest_type_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_type_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"invoice_information_due_date\": Can be set to true/false to toggle displaying this section.\n- \"invoice_information_invoice_number\": Can be set to true/false to toggle displaying this section.\n- \"invoice_information_issue_date\": Can be set to true/false to toggle displaying this section.\n- \"invoice_title\": Can be set to true/false to toggle displaying this section.\n- \"logo\": Can be set to true/false to toggle displaying this section.\n- \"logo_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"matter_attorney_display\": Can be set to \"name\" or \"initials\" to control the content shown in this section.\n- \"matter_attorney_initials\": Can be set to true/false to toggle displaying this section.\n- \"matter_attorney_initials_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_attorney_initials_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_attorney_initials_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_attorney_initials_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_attorney_summary_position_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_attorney_summary_time_keeper_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_client_ref\": Can be set to true/false to toggle displaying this section.\n- \"matter_date\": Can be set to true/false to toggle displaying this section.\n- \"matter_date_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_date_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_date_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_date_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_date_trust\": Can be set to true/false to toggle displaying this section.\n- \"matter_description\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_details_description_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_details_description_new_line\": Can be set to true/false to toggle displaying a matter descriptions on a new line.\n- \"matter_details_description_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description_trust\": Can be set to true/false to toggle displaying this section.\n- \"matter_heading_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"matter_headings_order\": Should be set to an array that contains the values: [\"matter_type\", \"matter_attorney_initials\", \"matter_date\", \"matter_details_description\", \"matter_quantity\", \"matter_rate\", \"matter_line_item_discount\", \"matter_total\", \"matter_total_with_tax\", \"matter_tax\"]\nin the order you would like the sections to display on your bills.\n- \"matter_headings_order_expenses\": Should be set to an array that contains the values: [\"matter_type\", \"matter_attorney_initials\", \"matter_date\", \"matter_details_description\", \"matter_quantity\", \"matter_rate\", \"matter_line_item_discount\", \"matter_total\", \"matter_total_with_tax\", \"matter_tax\"]\nin the order you would like the sections to display on your bills.\n- \"matter_headings_order_products\": Should be set to an array that contains the values: [\"matter_type\", \"matter_attorney_initials\", \"matter_date\", \"matter_details_description\", \"matter_quantity\", \"matter_rate\", \"matter_line_item_discount\", \"matter_total\", \"matter_total_with_tax\", \"matter_tax\"]\nin the order you would like the sections to display on your bills.\n- \"matter_headings_order_trust\": Should be set to an array that contains the values: [\"matter_date\", \"matter_details_description\", \"matter_total\"] in the order you would like the sections to display on your bills.\n- \"matter_individual_payments\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_line_item_discount_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_line_item_discount_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_line_items_activity_descriptions\": Can be set to true/false to toggle displaying this section.\n- \"matter_number\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_quantity_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_quantity_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_rate\": Can be set to true/false to toggle displaying this section.\n- \"matter_rate_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_rate_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_rate_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_rate_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_rate_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_separate_line_items\": Can be set to true/false to toggle displaying this section.\n- \"matter_show_amount_with_percentage\": Can be set to true/false to toggle displaying this section.\n- \"matter_tax_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_tax_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_trust\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_with_tax_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_with_tax_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_totals_subtotal\": Can be set to true/false to toggle displaying this section.\n- \"matter_totals_subtotal_line_item_discount\": Can be set to true/false to toggle displaying this section.\n- \"matter_type\": Can be set to true/false to toggle displaying this section.\n- \"matter_type_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_type_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_type_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_type_products\": Can be set to true/false to toggle displaying this section.\n- \"payment_profile_discount\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill does not have an early payment discount.\n- \"payment_profile_grace_period\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill does not have a grace period.\n- \"payment_profile_interest\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill does not have a recurring interest charge.\n- \"payment_profile_no_grace_period\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill has a grace period.\n- \"show_clio_payments\": Can be set to true/false to toggle displaying this section.\n- \"soa_title\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts_amount_due_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_amount_due_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_balance_due_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_balance_due_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_details\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts_due_on_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_due_on_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_include_trust\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts_invoice_number_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_invoice_number_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_note\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if \"statement_of_accounts_summary\" is \"hidden\".\n- \"statement_of_accounts_payments_received_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_payments_received_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_summary\": Can be set to \"hidden\", \"above\", or \"below\" to control the location of this section. This will determine if the statements of account section on the bill is displayed, and if it displays above or below the line items.\n- \"statement_of_accounts_summary_detail\": Can be set to \"simple\", \"with_payment\", or \"with_account_balance\" to control the values shown in this section.\n- \"statement_of_accounts_summary_only_bill_matters\": Can be set to true/false to control the values shown in this section.\n- \"void_watermark\": Can be set to true/false to toggle displaying a void watermark. Will only affect bills that have been void.\n\n\nAvailable settings under \"text\", each of these can be set to the text you would like to display when they are shown, some of these fields allow substituting values with codes wrapped in curly braces:\n- \"address_email\"\n- \"address_fax\"\n- \"address_phone\"\n- \"vat_number_au\"\n- \"vat_number_eu\"\n- \"attorney_summary_position\"\n- \"attorney_summary_time_keeper\"\n- \"client_account_account\"\n- \"client_account_balance\"\n- \"client_account_payments\"\n- \"client_account_receipts\"\n- \"client_account_total_balance\"\n- \"clio_payments_amount\"\n- \"clio_payments_date\"\n- \"clio_payments_note\"\n- \"clio_payments_reference\"\n- \"clio_payments_status\"\n- \"clio_payments_title\"\n- \"clio_payments_total\"\n- \"discount_early_payment_balance_owing_text\"\n- \"discount_early_payment_end_date_text\"\n- \"discount_early_payment_text\"\n- \"discount_early_payment_total_text\"\n- \"footer_invoice_memo\"\n - {{billing_setting_memo}}\" can be used to reference your billing settings memo.\n - {{bill_memo}} can be used to reference your bills memo.\n- \"footer_invoice_payable\"\n - {{firm_name}} can be used to reference your firms name.\n- \"footer_page\"\n- \"footer_page_of\"\n- \"grand_total_text\"\n - {{same_as_total_heading}} can be used to reference the value in \"text\" => \"matter_total_text\"\n- \"interest_date_text\"\n- \"interest_details_description_text\"\n- \"interest_subtotal_text\"\n- \"interest_text\"\n- \"interest_title_text\"\n- \"interest_total_text\"\n- \"interest_type_text\"\n- \"invoice_client_sales_tax_text\"\n- \"invoice_due_date_text\"\n- \"invoice_information_due_date_receipt_text\"\n- \"invoice_issued_date_text\"\n- \"invoice_lc\"\n- \"invoice_number_text\"\n- \"invoice_purchase_order_text\"\n- \"invoice_title\"\n- \"matter_attorney_initials_text\"\n- \"matter_balance_owing_text\"\n- \"matter_client_ref\"\n - {{client_ref_num}}\" can be used to reference the matters client reference.\n- \"matter_credit_note_text\"\n- \"matter_date_text\"\n- \"matter_details_description_text\"\n- \"matter_discount_text\"\n- \"matter_expense_disbursement_title_text\"\n- \"matter_expense_subtotal_text\"\n- \"matter_expense_text\"\n- \"matter_expense_title_text\"\n- \"matter_grand_total_text\"\n - {{same_as_total_heading}} can be used to reference the value in \"text\" => \"matter_total_text\"\n- \"matter_line_item_discount_expenses_text\"\n- \"matter_line_item_discount_products_text\"client_address_custom\"\n- \"matter_line_item_discount_subtotal_text\"\n- \"matter_line_item_discount_text\"\n- \"matter_non_billable_expenses_title_text\"\n- \"matter_non_billable_grouped_title_text\"\n- \"matter_non_billable_products_title_text\"\n- \"matter_non_billable_services_title_text\"\n- \"matter_payment_text\"\n- \"matter_product_subtotal_text\"\n- \"matter_product_text\"\n- \"matter_product_title_text\"\n- \"matter_quantity_expenses_text\"\n- \"matter_quantity_products_text\"\n- \"matter_quantity_subtotal_text\"\n- \"matter_quantity_text\"\n- \"matter_quantity_total_text\"\n- \"matter_rate_expenses_text\"\n- \"matter_rate_products_text\"\n- \"matter_rate_text\"\n- \"matter_refund_text\"\n- \"matter_service_subtotal_text\"\n- \"matter_service_text\"\n- \"matter_service_title_text\"\n- \"matter_subtotal_text\"\n- \"matter_tax_text\"\n- \"matter_title\"\n- \"matter_total_text\"\n- \"matter_total_with_tax_text\"\n- \"matter_trust_line_items_title_text\"\n- \"matter_trust_text\"\n- \"matter_type_text\"\n- \"payment_profile\"\n- \"payment_profile_discount\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"payment_profile_grace_period\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"payment_profile_interest\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"payment_profile_no_grace_period\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"remittance_checks\"\n- \"remittance_checks_label\"\n- \"remittance_checks_title\"\n- \"remittance_note\"\n - {{bill_number}} can be used to reference the bills number.\n- \"remittance_note_soa\"\n- \"remittance_title\"\n- \"remittance_wire_bank_account\"\n- \"remittance_wire_bank_account_label\"\n- \"remittance_wire_bank_name\"\n- \"remittance_wire_bank_name_label\"\n- \"remittance_wire_bank_routing\"\n- \"remittance_wire_bank_routing_label\"\n- \"remittance_wire_bank_swift\"\n- \"remittance_wire_bank_swift_label\"\n- \"remittance_wire_title\"\n- \"soa_title\"\n- \"statement_of_accounts_amount\"\n- \"statement_of_accounts_amount_in_trust\"\n- \"statement_of_accounts_amount_on_account\"\n- \"statement_of_accounts_balance\"\n- \"statement_of_accounts_current_invoice\"\n- \"statement_of_accounts_details_title\"\n- \"statement_of_accounts_due_on\"\n- \"statement_of_accounts_invoice_number\"\n- \"statement_of_accounts_new_charges\"\n- \"statement_of_accounts_note\"\n - {{firm_name}} can be used to reference your firms name.\n- \"statement_of_accounts_original_invoice_number\"\n- \"statement_of_accounts_other_interest_invoices\"\n- \"statement_of_accounts_other_invoices\"\n- \"statement_of_accounts_outstanding_balance\"\n- \"statement_of_accounts_detailed_outstanding_balance\"\n- \"statement_of_accounts_payments\"\n- \"statement_of_accounts_summary_title\"\n- \"statement_of_accounts_total_balance\"\n- \"statement_of_accounts_total_credit\"\n- \"statement_of_accounts_total_outstanding_balance\"\n- \"statement_of_accounts_detailed_total_outstanding_balance\"\n- \"trust_request_adjustments_title_text\"\n- \"trust_request_lc\"\n- \"trust_request_number_text\"\n- \"trust_request_title\"\n- \"trust_request_total_text\"\n\n\nAvailable settings under \"css\", each of these has nested values that can be set to apply CSS rules to bills:\n- \"client\"\n - \"color\": Color used in the client section. Value is in 'Hex'.\n - \"font-family\": Font used in client section.\n - \"font-size\": Font size in client section. Value is in 'em'.\n- \"client_address\"\n - \"margin-bottom\": Bottom margin size for the client address. Value is in 'em'.\n- \"firm_title\"\n - \"margin-bottom\": Bottom margin height for the bills firm title. Value is in 'em'.\n - \"color\": Color for the bills firm title section. Value is in 'Hex'.\n - \"font-family\": Font used for text in the firm title.\n - \"font-size\": Font size for the bills firm title. Value is in 'em'.\n - \"border-color\": Border color property for the firm title on a bill. Value is in 'Hex'.\n - \"border-style\": Border style property for the firm title on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-width\": Border width property for table rows on a bill. Accepts standard CSS options for 'border-width' property.\n - \"background-color\": Background color for the firm title on a bill. Value is in 'Hex'.\n- \"header\"\n - \"margin-bottom\": Bottom margin size for the bill header. Value is in 'em'.\n- \"inside_margins\"\n - \"font-family\": Primary font used on the bill.\n - \"font-size\": Primary font size used for bill.\n - \"color\": Primary font used on the bill, default is \"Arial\".\n- \"invoice_title\"\n - \"color\": Color used in the invoice title section. Value is in 'Hex'.\n - \"font-family\": Font used in invoice title section.\n - \"font-size\": Font size in invoice title section. Value is in 'em'.\n- \"logo_img\"\n - \"height\": Height for the bills logo image. Value is in 'em'.\n - \"margin-top\": Top margin height for the bills logo image. Value is in 'em'.\n - \"margin-bottom\": Bottom margin height for the bills logo image. Value is in 'em'.\n- \"matter_description\"\n - \"margin-top\": Top margin size for matter description section. Value is in 'em'.\n - \"color\": Color used in the matter description section. Value is in 'Hex'.\n - \"font-family\": Font used in matter description section.\n - \"font-size\": Font size in matter description section. Value is in 'em'.\n- \"matter_number\"\n - \"color\": Color used in the matter number section. Value is in 'Hex'.\n - \"font-family\": Font used in matter number section.\n - \"font-size\": Font size in matter number section. Value is in 'em'.\n- \"page_margins\"\n - \"margin-left\": Left margin size for the bill. Value is in 'em'.\n - \"margin-right\": Right margin size for the bill. Value is in 'em'.\n - \"margin-top\": Top margin size for the bill. Value is in 'em'.\n - \"margin-bottom\": Bottom margin size for the bill. Value is in 'em'.\n - \"size\": Size property for the bill, default is \"US-Letter\".\n- \"remittance_title\"\n - \"color\": Color used in the remittance title section. Value is in 'Hex'.\n - \"font-family\": Font used in remittance title section.\n - \"font-size\": Font size in remittance title section. Value is in 'em'.\n - \"background-color\": Background color for the remittance title section on a bill. Value is in 'Hex'.\n - \"border-color\": Border color property for the remittance title section on a bill. Value is in 'Hex'.\n - \"border-style\": Border style property for the remittance title section on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-width\": Border width property for the remittance title section on a bill. Accepts standard CSS options for 'border-width' property.\n- \"statement_of_accounts_title\"\n - \"color\": Color used in the statement of accounts section. Value is in 'Hex'.\n - \"font-family\": Font used in statement of accounts section.\n - \"font-size\": Font size in statement of accounts section. Value is in 'em'.\n - \"background-color\": Background color for the statement of accounts section on a bill. Value is in 'Hex'.\n - \"border-color\": Border color property for the statement of accounts section on a bill. Value is in 'Hex'.\n - \"border-style\": Border style property for the statement of accounts section on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-width\": Border width property for the statement of accounts section on a bill. Accepts standard CSS options for 'border-width' property.\n- \"table_even_line\"\n - \"background-color\": Background color for even table rows. Value is in 'Hex'.\n- \"table_h4\"\n - \"background-color\": Background color for table headers. Value is in 'Hex'.\n- \"table_line\"\n - \"border-bottom-width\": Bottom border width for table rows. Value is in 'px'.\n - \"border-bottom-style\": Bottom border style property for table rows on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-bottom-color\": Bottom border color property for table rows on a bill. Value is in 'Hex'.\n- \"table_odd_line\"\n - \"background-color\": Background color for odd table rows. Value is in 'Hex'.\n\n\nA config with samples of each type of option is shown below:\n```\n config = {\n \"show\": {\n \"statement_of_accounts_summary\": \"left\"\n \"statement_of_accounts_note\": true,\n \"footer_invoice_payable\": true,\n \"footer_invoice_memo\": true,\n \"payment_profile_no_grace_period\": true,\n \"payment_profile_grace_period\": true,\n \"payment_profile_discount\": true,\n \"payment_profile_interest\": true,\n \"interest_headings_order\": [\"interest_type\",\" interest_date\", \"interest_details_description\", \"interest_total\"]\n },\n \"text\": {\n \"statement_of_accounts_note\": \"Please make all amounts payable to: {{firm_name}}\",\n \"footer_invoice_payable\": \"Please make all amounts payable to: {{firm_name}}\",\n \"footer_invoice_memo\": \"{{bill_memo}}\",\n \"payment_profile_no_grace_period\": \"Payment is due upon receipt.\",\n \"payment_profile_grace_period\": \"Please pay within {{grace_period}}.\",\n \"payment_profile_discount\": \"{{discount_rate}}% discount will be applied if payment is received within {{discount_period}}.\",\n \"payment_profile_interest\": \"{{interest_rate}}% {{interest_type}} annual interest will be charged every {{interest_period}}.\",\n },\n \"css\": {\n \"statement_of_accounts_title\": {\n \"color\": \"#00cc00\",\n \"font-family\": \"Times New Roman\",\n \"font-size\": \"0.875em\",\n \"background-color\": \"#ccff99\",\n \"border-color\": \"#0033ff\",\n \"border-style\": \"dotted\",\n \"border-width\": \"thick\"\n },\n \"remittance_title\": {\n \"color\": \"#00ff00\",\n \"background-color\": \"None\",\n \"border-color\": \"#0033cc\",\n \"border-width\": \"medium\",\n \"border-style\": \"dotted\",\n \"font-family\": \"Arial\",\n \"font-size\": \"1.5em\"\n }\n }\n }\n```\n" }, "name": { "type": "string", "description": "Name of the BillTheme." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "config": { "type": "string", "description": "A string containing settings for the BillTheme.\nValues set in this string will apply to any bill using this BillTheme, unless overridden by the bill.\n\nAvailable settings within this string:\n- \"show\": Values set under this key determine how/if sections will appear on a bill.\n- \"text\": Values set under this key determine what will display if the section is shown.\n- \"css\": Values set under this key determine CSS rules for sections on a bill.\n\nAvailable settings under \"show\":\n- \"client_account\": Can be set to \"hidden\", \"details\", or \"summary\" to control the display and content of this section.\n- \"client_account_details_balance_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_include_matter_transfers\": Can be set to true/false to toggle displaying this section.\n- \"client_account_matter_date_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_matter_details_description_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_matter_title_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_matter_type_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_only_bill_matters\": Can be set to true/false to toggle displaying this section.\n- \"client_account_other_matters\": Can be set to true/false to toggle displaying this section.\n- \"client_account_payments_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_receipts_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_account_summary_balance_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"client_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"client_operating_account_omit_balance\": Can be set to true/false to toggle displaying this section.\n- \"clio_payments_amount_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_amount_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_date_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_date_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_note_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_note_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_reference_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_reference_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_status_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"clio_payments_status_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"draft_watermark\": Can be set to true/false to toggle displaying a draft watermark. Will only affect bills in draft.\n- \"envelope_friendly\": Can be set to true/false to toggle size styling for the bill.\n- \"firm_address\": Can be set to true/false to toggle displaying this section.\n- \"firm_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"firm_title\": Can be set to true/false to toggle displaying this section.\n- \"footer_invoice_memo\": Can be set to true/false to toggle displaying this section.\n- \"footer_invoice_payable\": Can be set to true/false to toggle displaying this section.\n- \"footer_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"footer_page_numbers\": Can be set to true/false to toggle displaying this section.\n- \"header_invoice_issued_date\": Can be set to true/false to toggle displaying this section.\n- \"header_invoice_number\": Can be set to true/false to toggle displaying this section.\n- \"header_on_first_page\": Can be set to true/false to toggle displaying this section.\n- \"interest_date\": Can be set to true/false to toggle displaying this section.\n- \"interest_date_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_date_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_description\": Can be set to true/false to toggle displaying this section.\n- \"interest_details_description\": Can be set to true/false to toggle displaying this section.\n- \"interest_details_description_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_details_description_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_details_description_new_line\": Can be set to true/false to toggle displaying a interest descriptions on a new line.\n- \"interest_headings_order\": Should be set to an array that contains the values: [\"interest_type\",\" interest_date\", \"interest_details_description\", \"interest_total\"] in the order you would like the sections to display on your bills.\n- \"interest_total\": Can be set to true/false to toggle displaying this section.\n- \"interest_total_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_total_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_totals_subtotal\": Can be set to true/false to toggle displaying this section.\n- \"interest_type\": Can be set to true/false to toggle displaying this section.\n- \"interest_type_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"interest_type_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"invoice_information_due_date\": Can be set to true/false to toggle displaying this section.\n- \"invoice_information_invoice_number\": Can be set to true/false to toggle displaying this section.\n- \"invoice_information_issue_date\": Can be set to true/false to toggle displaying this section.\n- \"invoice_title\": Can be set to true/false to toggle displaying this section.\n- \"logo\": Can be set to true/false to toggle displaying this section.\n- \"logo_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"matter_attorney_display\": Can be set to \"name\" or \"initials\" to control the content shown in this section.\n- \"matter_attorney_initials\": Can be set to true/false to toggle displaying this section.\n- \"matter_attorney_initials_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_attorney_initials_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_attorney_initials_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_attorney_initials_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_attorney_summary_position_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_attorney_summary_time_keeper_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_client_ref\": Can be set to true/false to toggle displaying this section.\n- \"matter_date\": Can be set to true/false to toggle displaying this section.\n- \"matter_date_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_date_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_date_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_date_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_date_trust\": Can be set to true/false to toggle displaying this section.\n- \"matter_description\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_details_description_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_details_description_new_line\": Can be set to true/false to toggle displaying a matter descriptions on a new line.\n- \"matter_details_description_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_details_description_trust\": Can be set to true/false to toggle displaying this section.\n- \"matter_heading_justification\": Can be set to \"center\", \"left\", or \"right\" to control the justification of this section.\n- \"matter_headings_order\": Should be set to an array that contains the values: [\"matter_type\", \"matter_attorney_initials\", \"matter_date\", \"matter_details_description\", \"matter_quantity\", \"matter_rate\", \"matter_line_item_discount\", \"matter_total\", \"matter_total_with_tax\", \"matter_tax\"]\nin the order you would like the sections to display on your bills.\n- \"matter_headings_order_expenses\": Should be set to an array that contains the values: [\"matter_type\", \"matter_attorney_initials\", \"matter_date\", \"matter_details_description\", \"matter_quantity\", \"matter_rate\", \"matter_line_item_discount\", \"matter_total\", \"matter_total_with_tax\", \"matter_tax\"]\nin the order you would like the sections to display on your bills.\n- \"matter_headings_order_products\": Should be set to an array that contains the values: [\"matter_type\", \"matter_attorney_initials\", \"matter_date\", \"matter_details_description\", \"matter_quantity\", \"matter_rate\", \"matter_line_item_discount\", \"matter_total\", \"matter_total_with_tax\", \"matter_tax\"]\nin the order you would like the sections to display on your bills.\n- \"matter_headings_order_trust\": Should be set to an array that contains the values: [\"matter_date\", \"matter_details_description\", \"matter_total\"] in the order you would like the sections to display on your bills.\n- \"matter_individual_payments\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_line_item_discount_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_line_item_discount_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_line_item_discount_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_line_items_activity_descriptions\": Can be set to true/false to toggle displaying this section.\n- \"matter_number\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_quantity_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_quantity_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_quantity_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_rate\": Can be set to true/false to toggle displaying this section.\n- \"matter_rate_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_rate_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_rate_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_rate_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_rate_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_separate_line_items\": Can be set to true/false to toggle displaying this section.\n- \"matter_show_amount_with_percentage\": Can be set to true/false to toggle displaying this section.\n- \"matter_tax_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_tax_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_products\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_text_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_trust\": Can be set to true/false to toggle displaying this section.\n- \"matter_total_with_tax_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_total_with_tax_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_totals_subtotal\": Can be set to true/false to toggle displaying this section.\n- \"matter_totals_subtotal_line_item_discount\": Can be set to true/false to toggle displaying this section.\n- \"matter_type\": Can be set to true/false to toggle displaying this section.\n- \"matter_type_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_type_expenses\": Can be set to true/false to toggle displaying this section.\n- \"matter_type_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"matter_type_products\": Can be set to true/false to toggle displaying this section.\n- \"payment_profile_discount\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill does not have an early payment discount.\n- \"payment_profile_grace_period\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill does not have a grace period.\n- \"payment_profile_interest\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill does not have a recurring interest charge.\n- \"payment_profile_no_grace_period\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if the bill has a grace period.\n- \"show_clio_payments\": Can be set to true/false to toggle displaying this section.\n- \"soa_title\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts_amount_due_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_amount_due_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_balance_due_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_balance_due_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_details\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts_due_on_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_due_on_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_include_trust\": Can be set to true/false to toggle displaying this section.\n- \"statement_of_accounts_invoice_number_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_invoice_number_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_note\": Can be set to true/false to toggle displaying this section. Even if set to true, this section will not be shown if \"statement_of_accounts_summary\" is \"hidden\".\n- \"statement_of_accounts_payments_received_body_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_payments_received_header_alignment\": Can be set to \"center\", \"left\", or \"right\" to control the alignment of this section.\n- \"statement_of_accounts_summary\": Can be set to \"hidden\", \"above\", or \"below\" to control the location of this section. This will determine if the statements of account section on the bill is displayed, and if it displays above or below the line items.\n- \"statement_of_accounts_summary_detail\": Can be set to \"simple\", \"with_payment\", or \"with_account_balance\" to control the values shown in this section.\n- \"statement_of_accounts_summary_only_bill_matters\": Can be set to true/false to control the values shown in this section.\n- \"void_watermark\": Can be set to true/false to toggle displaying a void watermark. Will only affect bills that have been void.\n\n\nAvailable settings under \"text\", each of these can be set to the text you would like to display when they are shown, some of these fields allow substituting values with codes wrapped in curly braces:\n- \"address_email\"\n- \"address_fax\"\n- \"address_phone\"\n- \"vat_number_au\"\n- \"vat_number_eu\"\n- \"attorney_summary_position\"\n- \"attorney_summary_time_keeper\"\n- \"client_account_account\"\n- \"client_account_balance\"\n- \"client_account_payments\"\n- \"client_account_receipts\"\n- \"client_account_total_balance\"\n- \"clio_payments_amount\"\n- \"clio_payments_date\"\n- \"clio_payments_note\"\n- \"clio_payments_reference\"\n- \"clio_payments_status\"\n- \"clio_payments_title\"\n- \"clio_payments_total\"\n- \"discount_early_payment_balance_owing_text\"\n- \"discount_early_payment_end_date_text\"\n- \"discount_early_payment_text\"\n- \"discount_early_payment_total_text\"\n- \"footer_invoice_memo\"\n - {{billing_setting_memo}}\" can be used to reference your billing settings memo.\n - {{bill_memo}} can be used to reference your bills memo.\n- \"footer_invoice_payable\"\n - {{firm_name}} can be used to reference your firms name.\n- \"footer_page\"\n- \"footer_page_of\"\n- \"grand_total_text\"\n - {{same_as_total_heading}} can be used to reference the value in \"text\" => \"matter_total_text\"\n- \"interest_date_text\"\n- \"interest_details_description_text\"\n- \"interest_subtotal_text\"\n- \"interest_text\"\n- \"interest_title_text\"\n- \"interest_total_text\"\n- \"interest_type_text\"\n- \"invoice_client_sales_tax_text\"\n- \"invoice_due_date_text\"\n- \"invoice_information_due_date_receipt_text\"\n- \"invoice_issued_date_text\"\n- \"invoice_lc\"\n- \"invoice_number_text\"\n- \"invoice_purchase_order_text\"\n- \"invoice_title\"\n- \"matter_attorney_initials_text\"\n- \"matter_balance_owing_text\"\n- \"matter_client_ref\"\n - {{client_ref_num}}\" can be used to reference the matters client reference.\n- \"matter_credit_note_text\"\n- \"matter_date_text\"\n- \"matter_details_description_text\"\n- \"matter_discount_text\"\n- \"matter_expense_disbursement_title_text\"\n- \"matter_expense_subtotal_text\"\n- \"matter_expense_text\"\n- \"matter_expense_title_text\"\n- \"matter_grand_total_text\"\n - {{same_as_total_heading}} can be used to reference the value in \"text\" => \"matter_total_text\"\n- \"matter_line_item_discount_expenses_text\"\n- \"matter_line_item_discount_products_text\"client_address_custom\"\n- \"matter_line_item_discount_subtotal_text\"\n- \"matter_line_item_discount_text\"\n- \"matter_non_billable_expenses_title_text\"\n- \"matter_non_billable_grouped_title_text\"\n- \"matter_non_billable_products_title_text\"\n- \"matter_non_billable_services_title_text\"\n- \"matter_payment_text\"\n- \"matter_product_subtotal_text\"\n- \"matter_product_text\"\n- \"matter_product_title_text\"\n- \"matter_quantity_expenses_text\"\n- \"matter_quantity_products_text\"\n- \"matter_quantity_subtotal_text\"\n- \"matter_quantity_text\"\n- \"matter_quantity_total_text\"\n- \"matter_rate_expenses_text\"\n- \"matter_rate_products_text\"\n- \"matter_rate_text\"\n- \"matter_refund_text\"\n- \"matter_service_subtotal_text\"\n- \"matter_service_text\"\n- \"matter_service_title_text\"\n- \"matter_subtotal_text\"\n- \"matter_tax_text\"\n- \"matter_title\"\n- \"matter_total_text\"\n- \"matter_total_with_tax_text\"\n- \"matter_trust_line_items_title_text\"\n- \"matter_trust_text\"\n- \"matter_type_text\"\n- \"payment_profile\"\n- \"payment_profile_discount\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"payment_profile_grace_period\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"payment_profile_interest\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"payment_profile_no_grace_period\"\n - {{discount_rate}} can be used to reference the bills discount rate.\n - {{interest_rate}} can be used to reference the bills interest rate.\n - {{interest_type}} can be used to reference the bills interest type.\n - {{grace_period}} can be used to reference the grace period for the bill.\n - {{discount_period}} can be used to reference the discount period for the bill.\n - {{interest_period}} can be used to reference the interest period for the bill.\n- \"remittance_checks\"\n- \"remittance_checks_label\"\n- \"remittance_checks_title\"\n- \"remittance_note\"\n - {{bill_number}} can be used to reference the bills number.\n- \"remittance_note_soa\"\n- \"remittance_title\"\n- \"remittance_wire_bank_account\"\n- \"remittance_wire_bank_account_label\"\n- \"remittance_wire_bank_name\"\n- \"remittance_wire_bank_name_label\"\n- \"remittance_wire_bank_routing\"\n- \"remittance_wire_bank_routing_label\"\n- \"remittance_wire_bank_swift\"\n- \"remittance_wire_bank_swift_label\"\n- \"remittance_wire_title\"\n- \"soa_title\"\n- \"statement_of_accounts_amount\"\n- \"statement_of_accounts_amount_in_trust\"\n- \"statement_of_accounts_amount_on_account\"\n- \"statement_of_accounts_balance\"\n- \"statement_of_accounts_current_invoice\"\n- \"statement_of_accounts_details_title\"\n- \"statement_of_accounts_due_on\"\n- \"statement_of_accounts_invoice_number\"\n- \"statement_of_accounts_new_charges\"\n- \"statement_of_accounts_note\"\n - {{firm_name}} can be used to reference your firms name.\n- \"statement_of_accounts_original_invoice_number\"\n- \"statement_of_accounts_other_interest_invoices\"\n- \"statement_of_accounts_other_invoices\"\n- \"statement_of_accounts_outstanding_balance\"\n- \"statement_of_accounts_detailed_outstanding_balance\"\n- \"statement_of_accounts_payments\"\n- \"statement_of_accounts_summary_title\"\n- \"statement_of_accounts_total_balance\"\n- \"statement_of_accounts_total_credit\"\n- \"statement_of_accounts_total_outstanding_balance\"\n- \"statement_of_accounts_detailed_total_outstanding_balance\"\n- \"trust_request_adjustments_title_text\"\n- \"trust_request_lc\"\n- \"trust_request_number_text\"\n- \"trust_request_title\"\n- \"trust_request_total_text\"\n\n\nAvailable settings under \"css\", each of these has nested values that can be set to apply CSS rules to bills:\n- \"client\"\n - \"color\": Color used in the client section. Value is in 'Hex'.\n - \"font-family\": Font used in client section.\n - \"font-size\": Font size in client section. Value is in 'em'.\n- \"client_address\"\n - \"margin-bottom\": Bottom margin size for the client address. Value is in 'em'.\n- \"firm_title\"\n - \"margin-bottom\": Bottom margin height for the bills firm title. Value is in 'em'.\n - \"color\": Color for the bills firm title section. Value is in 'Hex'.\n - \"font-family\": Font used for text in the firm title.\n - \"font-size\": Font size for the bills firm title. Value is in 'em'.\n - \"border-color\": Border color property for the firm title on a bill. Value is in 'Hex'.\n - \"border-style\": Border style property for the firm title on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-width\": Border width property for table rows on a bill. Accepts standard CSS options for 'border-width' property.\n - \"background-color\": Background color for the firm title on a bill. Value is in 'Hex'.\n- \"header\"\n - \"margin-bottom\": Bottom margin size for the bill header. Value is in 'em'.\n- \"inside_margins\"\n - \"font-family\": Primary font used on the bill.\n - \"font-size\": Primary font size used for bill.\n - \"color\": Primary font used on the bill, default is \"Arial\".\n- \"invoice_title\"\n - \"color\": Color used in the invoice title section. Value is in 'Hex'.\n - \"font-family\": Font used in invoice title section.\n - \"font-size\": Font size in invoice title section. Value is in 'em'.\n- \"logo_img\"\n - \"height\": Height for the bills logo image. Value is in 'em'.\n - \"margin-top\": Top margin height for the bills logo image. Value is in 'em'.\n - \"margin-bottom\": Bottom margin height for the bills logo image. Value is in 'em'.\n- \"matter_description\"\n - \"margin-top\": Top margin size for matter description section. Value is in 'em'.\n - \"color\": Color used in the matter description section. Value is in 'Hex'.\n - \"font-family\": Font used in matter description section.\n - \"font-size\": Font size in matter description section. Value is in 'em'.\n- \"matter_number\"\n - \"color\": Color used in the matter number section. Value is in 'Hex'.\n - \"font-family\": Font used in matter number section.\n - \"font-size\": Font size in matter number section. Value is in 'em'.\n- \"page_margins\"\n - \"margin-left\": Left margin size for the bill. Value is in 'em'.\n - \"margin-right\": Right margin size for the bill. Value is in 'em'.\n - \"margin-top\": Top margin size for the bill. Value is in 'em'.\n - \"margin-bottom\": Bottom margin size for the bill. Value is in 'em'.\n - \"size\": Size property for the bill, default is \"US-Letter\".\n- \"remittance_title\"\n - \"color\": Color used in the remittance title section. Value is in 'Hex'.\n - \"font-family\": Font used in remittance title section.\n - \"font-size\": Font size in remittance title section. Value is in 'em'.\n - \"background-color\": Background color for the remittance title section on a bill. Value is in 'Hex'.\n - \"border-color\": Border color property for the remittance title section on a bill. Value is in 'Hex'.\n - \"border-style\": Border style property for the remittance title section on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-width\": Border width property for the remittance title section on a bill. Accepts standard CSS options for 'border-width' property.\n- \"statement_of_accounts_title\"\n - \"color\": Color used in the statement of accounts section. Value is in 'Hex'.\n - \"font-family\": Font used in statement of accounts section.\n - \"font-size\": Font size in statement of accounts section. Value is in 'em'.\n - \"background-color\": Background color for the statement of accounts section on a bill. Value is in 'Hex'.\n - \"border-color\": Border color property for the statement of accounts section on a bill. Value is in 'Hex'.\n - \"border-style\": Border style property for the statement of accounts section on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-width\": Border width property for the statement of accounts section on a bill. Accepts standard CSS options for 'border-width' property.\n- \"table_even_line\"\n - \"background-color\": Background color for even table rows. Value is in 'Hex'.\n- \"table_h4\"\n - \"background-color\": Background color for table headers. Value is in 'Hex'.\n- \"table_line\"\n - \"border-bottom-width\": Bottom border width for table rows. Value is in 'px'.\n - \"border-bottom-style\": Bottom border style property for table rows on a bill. Accepts standard CSS options for 'border-style' property.\n - \"border-bottom-color\": Bottom border color property for table rows on a bill. Value is in 'Hex'.\n- \"table_odd_line\"\n - \"background-color\": Background color for odd table rows. Value is in 'Hex'.\n\n\nA config with samples of each type of option is shown below:\n```\n config = {\n \"show\": {\n \"statement_of_accounts_summary\": \"left\"\n \"statement_of_accounts_note\": true,\n \"footer_invoice_payable\": true,\n \"footer_invoice_memo\": true,\n \"payment_profile_no_grace_period\": true,\n \"payment_profile_grace_period\": true,\n \"payment_profile_discount\": true,\n \"payment_profile_interest\": true,\n \"interest_headings_order\": [\"interest_type\",\" interest_date\", \"interest_details_description\", \"interest_total\"]\n },\n \"text\": {\n \"statement_of_accounts_note\": \"Please make all amounts payable to: {{firm_name}}\",\n \"footer_invoice_payable\": \"Please make all amounts payable to: {{firm_name}}\",\n \"footer_invoice_memo\": \"{{bill_memo}}\",\n \"payment_profile_no_grace_period\": \"Payment is due upon receipt.\",\n \"payment_profile_grace_period\": \"Please pay within {{grace_period}}.\",\n \"payment_profile_discount\": \"{{discount_rate}}% discount will be applied if payment is received within {{discount_period}}.\",\n \"payment_profile_interest\": \"{{interest_rate}}% {{interest_type}} annual interest will be charged every {{interest_period}}.\",\n },\n \"css\": {\n \"statement_of_accounts_title\": {\n \"color\": \"#00cc00\",\n \"font-family\": \"Times New Roman\",\n \"font-size\": \"0.875em\",\n \"background-color\": \"#ccff99\",\n \"border-color\": \"#0033ff\",\n \"border-style\": \"dotted\",\n \"border-width\": \"thick\"\n },\n \"remittance_title\": {\n \"color\": \"#00ff00\",\n \"background-color\": \"None\",\n \"border-color\": \"#0033cc\",\n \"border-width\": \"medium\",\n \"border-style\": \"dotted\",\n \"font-family\": \"Arial\",\n \"font-size\": \"1.5em\"\n }\n }\n }\n```\n" }, "name": { "type": "string", "description": "Name of the BillTheme." } } } } } } }, "required": false } } }, "/billable_clients.json": { "get": { "tags": [ "Billable Clients" ], "summary": "Return the data for all BillableClients", "operationId": "BillableClient#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all BillableClients", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableClient records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "custom_field_values", "in": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif 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.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n", "required": false, "schema": { "type": "string", "enum": [ "=", "<", ">", "<=", ">=" ] } }, { "name": "end_date", "in": "query", "description": "Filter BillableClient records to those that have Matters with unbilled Activities on or before this date (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "A limit on the number of BillableClient records to be returned. Limit can range between 1 and 25. Default: `25`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableClient records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "originating_attorney_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableClient. The list will be filtered to include only the BillableClient records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `display_number` or `number` or `description` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "responsible_attorney_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableClient. The list will be filtered to include only the BillableClient records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_date", "in": "query", "description": "Filter BillableClient records to those that have Matters with unbilled Activities on or after this date (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillableClient_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/billable_matters/ids.json": { "get": { "tags": [ "Billable Matters" ], "summary": "Returns the unique identifiers of all BillableMatter", "operationId": "BillableMatter#ids", "description": "This data is retrieved asynchronously", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "custom_field_values", "in": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif 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.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n", "required": false, "schema": { "type": "string", "enum": [ "=", "<", ">", "<=", ">=" ] } }, { "name": "end_date", "in": "query", "description": "Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: `1000`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "originating_attorney_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `display_number` or `number` or `description` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "responsible_attorney_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_date", "in": "query", "description": "Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillableMatter_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/billable_matters.json": { "get": { "tags": [ "Billable Matters" ], "summary": "Return the data for all BillableMatters", "operationId": "BillableMatter#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all BillableMatters", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "custom_field_values", "in": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif 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.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n", "required": false, "schema": { "type": "string", "enum": [ "=", "<", ">", "<=", ">=" ] } }, { "name": "end_date", "in": "query", "description": "Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: `1000`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "originating_attorney_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `display_number` or `number` or `description` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "responsible_attorney_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_date", "in": "query", "description": "Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillableMatter_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/bills/{id}/preview.json": { "get": { "tags": [ "Bills" ], "summary": "Returns the pre-rendered html for the Bill", "operationId": "Bill#preview", "description": "This endpoint returns a pre-rendered HTML object that you can use to view a preview of your bills.\nThe HTML provided contains all of the CSS rules it requires to show the bill correctly,\nas well as the DOCTYPE setting it requires.\nIt's best to use an iframe, or similar object, to render the results of this endpoint.\n", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier for the Bill.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok" }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/bills.json": { "get": { "tags": [ "Bills" ], "summary": "Return the data for all Bills", "operationId": "Bill#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Bills", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "bill_number", "in": "query", "description": "Filter Bill records to those with this exact bill number", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Bill records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter Bill records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "currency_id", "in": "query", "description": "Filter Bill records to those of a specific currency.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "custom_field_values", "in": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif 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.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n", "required": false, "schema": { "type": "string", "enum": [ "=", "<", ">", "<=", ">=" ] } }, { "name": "due_after", "in": "query", "description": "Filter Bill records to those that have a `due_date` after the one provided (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "due_at", "in": "query", "description": "Filter Bill records to those that have a specific `due_date` (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "due_before", "in": "query", "description": "Filter Bill records to those that have a `due_date` before the one provided (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter Bill records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "issued_after", "in": "query", "description": "Filter Bill records to those that have an `issue_date` after the one provided (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "issued_before", "in": "query", "description": "Filter Bill records to those that have an `issue_date` before the one provided (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "last_sent_end_date", "in": "query", "description": "Filter Bill records for those whose bills have been sent before the specified date", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "last_sent_start_date", "in": "query", "description": "Filter Bill records for those whose bills have been sent after the specified date", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Bill records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. Use the keyword `null` to match those without a Bill. The list will be filtered to include only the Bill records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "order", "in": "query", "description": "Orders the Bill records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "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)" ] } }, { "name": "originating_attorney_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a Bill. The list will be filtered to include only the Bill records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "overdue_only", "in": "query", "description": "Filter Bill records to those that are overdue.", "required": false, "schema": { "type": "boolean" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Allows matching search on invoice number.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "responsible_attorney_id", "in": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a Bill. The list will be filtered to include only the Bill records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "state", "in": "query", "description": "Filter Bill records to those in a given state.", "required": false, "schema": { "type": "string", "enum": [ "draft", "awaiting_approval", "awaiting_payment", "paid", "void", "deleted" ] } }, { "name": "status", "in": "query", "description": "Filter Bill records to those with particular payment status.", "required": false, "schema": { "type": "string", "enum": [ "all", "overdue" ] } }, { "name": "type", "in": "query", "description": "Filter Bill records to those of a specific type.", "required": false, "schema": { "type": "string", "enum": [ "revenue", "trust" ] } }, { "name": "updated_since", "in": "query", "description": "Filter Bill records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Bill_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/bills/{id}.json": { "get": { "tags": [ "Bills" ], "summary": "Return the data for a single Bill", "operationId": "Bill#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Bill", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Bill.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "navigation.next", "in": "query", "description": "The id of the next *Bill* available for viewing", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "navigation.previous", "in": "query", "description": "The id of the previous *Bill* available for viewing", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Bill_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Bills" ], "summary": "Update a single Bill", "operationId": "Bill#update", "description": "Outlines the parameters and data fields used when updating a single Bill", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Bill.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Bill_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Bills", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "bill_theme": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier of the bill theme applied to the Bill." } } }, "currency_id": { "type": "integer", "format": "int64", "description": "ID of the currency applied to the Bill." }, "discount": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Discount amount for the Bill. This can either be a percentage or monetary value, this is determined by the `discount[type]`." }, "type": { "type": "string", "enum": [ "percentage", "money" ], "description": "The type of discount you are applying to your Bill with the `discount[rate]`." }, "note": { "type": "string", "description": "A note for your Bill's discount." } } }, "due_at": { "type": "string", "format": "date", "description": "Date the Bill is due. If `use_grace_period` is true, this field is ignored." }, "interest": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Interest amount for the Bill as percentage." }, "type": { "type": "string", "enum": [ "simple", "compound" ], "description": "The type of interest you are applying to your Bill with the `interest[rate]`." }, "period": { "type": "integer", "format": "int32", "description": "The interest period for how frequently your Bill will charge interest." } } }, "issued_at": { "type": "string", "format": "date", "description": "Date the Bill was issued." }, "memo": { "type": "string", "description": "Memo for the Bill." }, "number": { "type": "string", "description": "Bill's number." }, "purchase_order": { "type": "string", "description": "Purchase order information for the Bill." }, "secondary_tax_rate": { "type": "number", "format": "double", "description": "Secondary tax rate as percentage for the Bill." }, "state": { "type": "string", "enum": [ "draft", "awaiting_approval", "awaiting_payment", "paid", "void", "deleted" ], "description": "Bill's state." }, "subject": { "type": "string", "description": "Subject details for the Bill." }, "tax_rate": { "type": "number", "format": "double", "description": "Tax rate as percentage for the Bill" }, "use_grace_period": { "type": "boolean", "description": "When true, sets the bill's due date based on the client's grace period. This setting overrides the `due_at` parameter." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "bill_theme": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier of the bill theme applied to the Bill." } } }, "currency_id": { "type": "integer", "format": "int64", "description": "ID of the currency applied to the Bill." }, "discount": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Discount amount for the Bill. This can either be a percentage or monetary value, this is determined by the `discount[type]`." }, "type": { "type": "string", "enum": [ "percentage", "money" ], "description": "The type of discount you are applying to your Bill with the `discount[rate]`." }, "note": { "type": "string", "description": "A note for your Bill's discount." } } }, "due_at": { "type": "string", "format": "date", "description": "Date the Bill is due. If `use_grace_period` is true, this field is ignored." }, "interest": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Interest amount for the Bill as percentage." }, "type": { "type": "string", "enum": [ "simple", "compound" ], "description": "The type of interest you are applying to your Bill with the `interest[rate]`." }, "period": { "type": "integer", "format": "int32", "description": "The interest period for how frequently your Bill will charge interest." } } }, "issued_at": { "type": "string", "format": "date", "description": "Date the Bill was issued." }, "memo": { "type": "string", "description": "Memo for the Bill." }, "number": { "type": "string", "description": "Bill's number." }, "purchase_order": { "type": "string", "description": "Purchase order information for the Bill." }, "secondary_tax_rate": { "type": "number", "format": "double", "description": "Secondary tax rate as percentage for the Bill." }, "state": { "type": "string", "enum": [ "draft", "awaiting_approval", "awaiting_payment", "paid", "void", "deleted" ], "description": "Bill's state." }, "subject": { "type": "string", "description": "Subject details for the Bill." }, "tax_rate": { "type": "number", "format": "double", "description": "Tax rate as percentage for the Bill" }, "use_grace_period": { "type": "boolean", "description": "When true, sets the bill's due date based on the client's grace period. This setting overrides the `due_at` parameter." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "bill_theme": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier of the bill theme applied to the Bill." } } }, "currency_id": { "type": "integer", "format": "int64", "description": "ID of the currency applied to the Bill." }, "discount": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Discount amount for the Bill. This can either be a percentage or monetary value, this is determined by the `discount[type]`." }, "type": { "type": "string", "enum": [ "percentage", "money" ], "description": "The type of discount you are applying to your Bill with the `discount[rate]`." }, "note": { "type": "string", "description": "A note for your Bill's discount." } } }, "due_at": { "type": "string", "format": "date", "description": "Date the Bill is due. If `use_grace_period` is true, this field is ignored." }, "interest": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Interest amount for the Bill as percentage." }, "type": { "type": "string", "enum": [ "simple", "compound" ], "description": "The type of interest you are applying to your Bill with the `interest[rate]`." }, "period": { "type": "integer", "format": "int32", "description": "The interest period for how frequently your Bill will charge interest." } } }, "issued_at": { "type": "string", "format": "date", "description": "Date the Bill was issued." }, "memo": { "type": "string", "description": "Memo for the Bill." }, "number": { "type": "string", "description": "Bill's number." }, "purchase_order": { "type": "string", "description": "Purchase order information for the Bill." }, "secondary_tax_rate": { "type": "number", "format": "double", "description": "Secondary tax rate as percentage for the Bill." }, "state": { "type": "string", "enum": [ "draft", "awaiting_approval", "awaiting_payment", "paid", "void", "deleted" ], "description": "Bill's state." }, "subject": { "type": "string", "description": "Subject details for the Bill." }, "tax_rate": { "type": "number", "format": "double", "description": "Tax rate as percentage for the Bill" }, "use_grace_period": { "type": "boolean", "description": "When true, sets the bill's due date based on the client's grace period. This setting overrides the `due_at` parameter." } } } } } } }, "required": false } }, "delete": { "tags": [ "Bills" ], "summary": "Delete or void a Bill", "operationId": "Bill#destroy", "description": "This endpoint will transition a bill to either its deleted or voided state.\nA bill can only be deleted or voided if it has no payments recorded\nand its current state is one of the following:\n* Draft\n* Pending Approval\n* Unpaid\n\nA bill will automatically be moved to a deleted or void state based on its current state.\nThe mappings for this are:\n* Draft -> Deleted\n* Pending Approval -> Deleted\n* Unpaid -> Void\n", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Bill.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/calendar_entries.json": { "get": { "tags": [ "Calendar Entries" ], "summary": "Return the data for all CalendarEntries", "operationId": "CalendarEntry#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all CalendarEntries", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "calendar_id", "in": "query", "description": "The unique identifier for a single Calendar. The keyword `null` is not valid for this field. The list will be filtered to include only the CalendarEntry records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter CalendarEntry records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "expanded", "in": "query", "description": "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.", "required": false, "schema": { "type": "boolean" } }, { "name": "external_property_name", "in": "query", "description": "Filter records to only those with the given external property(s) name set.\n\ne.g. `?external_property_name=Name`\n", "required": false, "schema": { "type": "string" } }, { "name": "external_property_value", "in": "query", "description": "Filter records to only those with the given external property(s) value set. Requires external property name as well.\n\ne.g. `?external_property_name=Name&external_property_value=Value`\n", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Filter CalendarEntry records to those that end on or after the provided time (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "has_court_rule", "in": "query", "description": "Allows matching court rule on calendar entry.", "required": false, "schema": { "type": "boolean" } }, { "name": "ids[]", "in": "query", "description": "Filter CalendarEntry records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "is_all_day", "in": "query", "description": "Filter CalendarEntry records to those that are marked as all day events.", "required": false, "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "A limit on the number of CalendarEntry records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. Use the keyword `null` to match those without a CalendarEntry. The list will be filtered to include only the CalendarEntry records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "owner_entries_across_all_users", "in": "query", "description": "Returns CalendarEntry records for all users related to a matter. Requires matter id.", "required": false, "schema": { "type": "boolean" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Allows matching search on calendar entry.", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Filter CalendarEntry records to those having a specific calendar visibility source (mobile, web).", "required": false, "schema": { "type": "string", "enum": [ "web", "mobile" ] } }, { "name": "to", "in": "query", "description": "Filter CalendarEntry records to those that begin on or before the provided time (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "updated_since", "in": "query", "description": "Filter CalendarEntry records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "visible", "in": "query", "description": "Filter CalendarEntry records to those that are visible.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CalendarEntry_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Calendar Entries" ], "summary": "Create a new CalendarEntry", "operationId": "CalendarEntry#create", "description": "Outlines the parameters and data fields used when creating a new CalendarEntry", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CalendarEntry_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Calendar Entries", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "_deleted": { "type": "string", "enum": [ "single", "future" ], "description": "Flag to delete a specific instance of a recurring event." }, "all_day": { "type": "boolean", "description": "Whether or not the CalendarEntry is for all day." }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Attendee associated with the CalendarEntry. The keyword `null` is not valid for this field. Not required for creating new Attendee, but required for updating or deleting existing ones." }, "type": { "type": "string", "description": "The type of attendee (Calendar, Contact)" }, "_destroy": { "type": "boolean", "description": "Flag to delete a specific attendee." } } } }, "calendar_entry_event_type": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntryEventType associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "calendar_owner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Calendar associated with the CalendarEntry. The keyword `null` is not valid for this field." } }, "required": [ "id" ] }, "conference_meeting": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "zoom" ], "description": "The type of conference meeting. If no conference meeting is present or the user is in an ineligible pricing tier for this feature, it will be null." } } }, "description": { "type": "string", "description": "A detailed description of the CalendarEntry." }, "end_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry ends (Expects an ISO-8601 timestamp)." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per CalendarEntry**" }, "value": { "type": "string", "description": "The ExternalProperty value." } } } }, "location": { "type": "string", "description": "The geographic location of the CalendarEntry." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "recurrence_rule": { "type": "string", "description": "Recurrence rule for expanding recurring CalendarEntry. To convert an existing recurring event to a non-recurring event, `''` or `null` are valid values." }, "send_email_notification": { "type": "boolean", "description": "Whether the calendar Entry should send email notifications to attendees" }, "start_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry starts (Expects an ISO-8601 timestamp)." }, "summary": { "type": "string", "description": "A short summary of the CalendarEntry." } }, "required": [ "summary", "start_at", "end_at", "calendar_owner" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "_deleted": { "type": "string", "enum": [ "single", "future" ], "description": "Flag to delete a specific instance of a recurring event." }, "all_day": { "type": "boolean", "description": "Whether or not the CalendarEntry is for all day." }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Attendee associated with the CalendarEntry. The keyword `null` is not valid for this field. Not required for creating new Attendee, but required for updating or deleting existing ones." }, "type": { "type": "string", "description": "The type of attendee (Calendar, Contact)" }, "_destroy": { "type": "boolean", "description": "Flag to delete a specific attendee." } } } }, "calendar_entry_event_type": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntryEventType associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "calendar_owner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Calendar associated with the CalendarEntry. The keyword `null` is not valid for this field." } }, "required": [ "id" ] }, "conference_meeting": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "zoom" ], "description": "The type of conference meeting. If no conference meeting is present or the user is in an ineligible pricing tier for this feature, it will be null." } } }, "description": { "type": "string", "description": "A detailed description of the CalendarEntry." }, "end_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry ends (Expects an ISO-8601 timestamp)." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per CalendarEntry**" }, "value": { "type": "string", "description": "The ExternalProperty value." } } } }, "location": { "type": "string", "description": "The geographic location of the CalendarEntry." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "recurrence_rule": { "type": "string", "description": "Recurrence rule for expanding recurring CalendarEntry. To convert an existing recurring event to a non-recurring event, `''` or `null` are valid values." }, "send_email_notification": { "type": "boolean", "description": "Whether the calendar Entry should send email notifications to attendees" }, "start_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry starts (Expects an ISO-8601 timestamp)." }, "summary": { "type": "string", "description": "A short summary of the CalendarEntry." } }, "required": [ "summary", "start_at", "end_at", "calendar_owner" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "_deleted": { "type": "string", "enum": [ "single", "future" ], "description": "Flag to delete a specific instance of a recurring event." }, "all_day": { "type": "boolean", "description": "Whether or not the CalendarEntry is for all day." }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Attendee associated with the CalendarEntry. The keyword `null` is not valid for this field. Not required for creating new Attendee, but required for updating or deleting existing ones." }, "type": { "type": "string", "description": "The type of attendee (Calendar, Contact)" }, "_destroy": { "type": "boolean", "description": "Flag to delete a specific attendee." } } } }, "calendar_entry_event_type": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntryEventType associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "calendar_owner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Calendar associated with the CalendarEntry. The keyword `null` is not valid for this field." } }, "required": [ "id" ] }, "conference_meeting": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "zoom" ], "description": "The type of conference meeting. If no conference meeting is present or the user is in an ineligible pricing tier for this feature, it will be null." } } }, "description": { "type": "string", "description": "A detailed description of the CalendarEntry." }, "end_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry ends (Expects an ISO-8601 timestamp)." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per CalendarEntry**" }, "value": { "type": "string", "description": "The ExternalProperty value." } } } }, "location": { "type": "string", "description": "The geographic location of the CalendarEntry." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "recurrence_rule": { "type": "string", "description": "Recurrence rule for expanding recurring CalendarEntry. To convert an existing recurring event to a non-recurring event, `''` or `null` are valid values." }, "send_email_notification": { "type": "boolean", "description": "Whether the calendar Entry should send email notifications to attendees" }, "start_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry starts (Expects an ISO-8601 timestamp)." }, "summary": { "type": "string", "description": "A short summary of the CalendarEntry." } }, "required": [ "summary", "start_at", "end_at", "calendar_owner" ] } } } } }, "required": false } } }, "/calendar_entries/{id}.json": { "get": { "tags": [ "Calendar Entries" ], "summary": "Return the data for a single CalendarEntry", "operationId": "CalendarEntry#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single CalendarEntry", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CalendarEntry.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CalendarEntry_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Calendar Entries" ], "summary": "Update a single CalendarEntry", "operationId": "CalendarEntry#update", "description": "Outlines the parameters and data fields used when updating a single CalendarEntry", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CalendarEntry.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CalendarEntry_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Calendar Entries", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "_deleted": { "type": "string", "enum": [ "single", "future" ], "description": "Flag to delete a specific instance of a recurring event." }, "all_day": { "type": "boolean", "description": "Whether or not the CalendarEntry is for all day." }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Attendee associated with the CalendarEntry. The keyword `null` is not valid for this field. Not required for creating new Attendee, but required for updating or deleting existing ones." }, "type": { "type": "string", "description": "The type of attendee (Calendar, Contact)" }, "_destroy": { "type": "boolean", "description": "Flag to delete a specific attendee." } } } }, "calendar_entry_event_type": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntryEventType associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "calendar_owner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Calendar associated with the CalendarEntry. The keyword `null` is not valid for this field." } } }, "conference_meeting": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "zoom" ], "description": "The type of conference meeting. If no conference meeting is present or the user is in an ineligible pricing tier for this feature, it will be null." } } }, "description": { "type": "string", "description": "A detailed description of the CalendarEntry." }, "end_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry ends (Expects an ISO-8601 timestamp)." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExternalProperty associated with the CalendarEntry. The keyword `null` is not valid for this field." }, "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per CalendarEntry**" }, "value": { "type": "string", "description": "The ExternalProperty value." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated ExternalProperty is present, the ExternalProperty is deleted from the CalendarEntry." } } } }, "location": { "type": "string", "description": "The geographic location of the CalendarEntry." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "recurrence_rule": { "type": "string", "description": "Recurrence rule for expanding recurring CalendarEntry. To convert an existing recurring event to a non-recurring event, `''` or `null` are valid values." }, "send_email_notification": { "type": "boolean", "description": "Whether the calendar Entry should send email notifications to attendees" }, "start_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry starts (Expects an ISO-8601 timestamp)." }, "summary": { "type": "string", "description": "A short summary of the CalendarEntry." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "_deleted": { "type": "string", "enum": [ "single", "future" ], "description": "Flag to delete a specific instance of a recurring event." }, "all_day": { "type": "boolean", "description": "Whether or not the CalendarEntry is for all day." }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Attendee associated with the CalendarEntry. The keyword `null` is not valid for this field. Not required for creating new Attendee, but required for updating or deleting existing ones." }, "type": { "type": "string", "description": "The type of attendee (Calendar, Contact)" }, "_destroy": { "type": "boolean", "description": "Flag to delete a specific attendee." } } } }, "calendar_entry_event_type": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntryEventType associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "calendar_owner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Calendar associated with the CalendarEntry. The keyword `null` is not valid for this field." } } }, "conference_meeting": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "zoom" ], "description": "The type of conference meeting. If no conference meeting is present or the user is in an ineligible pricing tier for this feature, it will be null." } } }, "description": { "type": "string", "description": "A detailed description of the CalendarEntry." }, "end_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry ends (Expects an ISO-8601 timestamp)." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExternalProperty associated with the CalendarEntry. The keyword `null` is not valid for this field." }, "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per CalendarEntry**" }, "value": { "type": "string", "description": "The ExternalProperty value." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated ExternalProperty is present, the ExternalProperty is deleted from the CalendarEntry." } } } }, "location": { "type": "string", "description": "The geographic location of the CalendarEntry." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "recurrence_rule": { "type": "string", "description": "Recurrence rule for expanding recurring CalendarEntry. To convert an existing recurring event to a non-recurring event, `''` or `null` are valid values." }, "send_email_notification": { "type": "boolean", "description": "Whether the calendar Entry should send email notifications to attendees" }, "start_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry starts (Expects an ISO-8601 timestamp)." }, "summary": { "type": "string", "description": "A short summary of the CalendarEntry." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "_deleted": { "type": "string", "enum": [ "single", "future" ], "description": "Flag to delete a specific instance of a recurring event." }, "all_day": { "type": "boolean", "description": "Whether or not the CalendarEntry is for all day." }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Attendee associated with the CalendarEntry. The keyword `null` is not valid for this field. Not required for creating new Attendee, but required for updating or deleting existing ones." }, "type": { "type": "string", "description": "The type of attendee (Calendar, Contact)" }, "_destroy": { "type": "boolean", "description": "Flag to delete a specific attendee." } } } }, "calendar_entry_event_type": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CalendarEntryEventType associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "calendar_owner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Calendar associated with the CalendarEntry. The keyword `null` is not valid for this field." } } }, "conference_meeting": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "zoom" ], "description": "The type of conference meeting. If no conference meeting is present or the user is in an ineligible pricing tier for this feature, it will be null." } } }, "description": { "type": "string", "description": "A detailed description of the CalendarEntry." }, "end_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry ends (Expects an ISO-8601 timestamp)." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExternalProperty associated with the CalendarEntry. The keyword `null` is not valid for this field." }, "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per CalendarEntry**" }, "value": { "type": "string", "description": "The ExternalProperty value." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated ExternalProperty is present, the ExternalProperty is deleted from the CalendarEntry." } } } }, "location": { "type": "string", "description": "The geographic location of the CalendarEntry." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the CalendarEntry. Use the keyword `null` to specify no association." } } }, "recurrence_rule": { "type": "string", "description": "Recurrence rule for expanding recurring CalendarEntry. To convert an existing recurring event to a non-recurring event, `''` or `null` are valid values." }, "send_email_notification": { "type": "boolean", "description": "Whether the calendar Entry should send email notifications to attendees" }, "start_at": { "type": "string", "format": "date-time", "description": "The time the CalendarEntry starts (Expects an ISO-8601 timestamp)." }, "summary": { "type": "string", "description": "A short summary of the CalendarEntry." } } } } } } }, "required": false } }, "delete": { "tags": [ "Calendar Entries" ], "summary": "Delete a single CalendarEntry", "operationId": "CalendarEntry#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single CalendarEntry", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CalendarEntry.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/calendar_entry_event_types.json": { "get": { "tags": [ "Calendar Entry Event Types" ], "summary": "Return the data for all calendar entry event types", "operationId": "CalendarEntryEventType#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all CalendarEntryEventTypes", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter CalendarEntryEventType records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter CalendarEntryEventType records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of CalendarEntryEventType records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter CalendarEntryEventType records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CalendarEntryEventType" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Calendar Entry Event Types" ], "summary": "Create a new calendar entry event type", "operationId": "CalendarEntryEventType#create", "description": "Outlines the parameters and data fields used when creating a new CalendarEntryEventType", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CalendarEntryEventType" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Calendar Entry Event Types", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "The color assigned to the CalendarEntryEventType" }, "name": { "type": "string", "description": "The name of the CalendarEntryEventType" } }, "required": [ "color", "name" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "The color assigned to the CalendarEntryEventType" }, "name": { "type": "string", "description": "The name of the CalendarEntryEventType" } }, "required": [ "color", "name" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "The color assigned to the CalendarEntryEventType" }, "name": { "type": "string", "description": "The name of the CalendarEntryEventType" } }, "required": [ "color", "name" ] } } } } }, "required": false } } }, "/calendar_entry_event_types/{id}.json": { "get": { "tags": [ "Calendar Entry Event Types" ], "summary": "Return the data for a single calendar entry event type", "operationId": "CalendarEntryEventType#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single CalendarEntryEventType", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CalendarEntryEventType.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CalendarEntryEventType" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Calendar Entry Event Types" ], "summary": "Update a single calendar entry event type", "operationId": "CalendarEntryEventType#update", "description": "Outlines the parameters and data fields used when updating a single CalendarEntryEventType", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CalendarEntryEventType.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CalendarEntryEventType" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Calendar Entry Event Types", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "The color assigned to the CalendarEntryEventType" }, "name": { "type": "string", "description": "The name of the CalendarEntryEventType" } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "The color assigned to the CalendarEntryEventType" }, "name": { "type": "string", "description": "The name of the CalendarEntryEventType" } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "The color assigned to the CalendarEntryEventType" }, "name": { "type": "string", "description": "The name of the CalendarEntryEventType" } } } } } } }, "required": false } }, "delete": { "tags": [ "Calendar Entry Event Types" ], "summary": "Delete a single calendar entry event type", "operationId": "CalendarEntryEventType#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single CalendarEntryEventType", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CalendarEntryEventType.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/calendars.json": { "get": { "tags": [ "Calendars" ], "summary": "Return the data for all Calendars", "operationId": "Calendar#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Calendars", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter Calendar records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "filter_inactive_users", "in": "query", "description": "Filter any shared UserCalendar records whose owner is inactive.", "required": false, "schema": { "type": "boolean" } }, { "name": "ids[]", "in": "query", "description": "Filter Calendar records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Calendar records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the Calendar records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "name(asc)", "name(desc)", "id(asc)", "id(desc)" ] } }, { "name": "owner", "in": "query", "description": "Filter Calendar records to those that the user owns.", "required": false, "schema": { "type": "boolean" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Filter Calendar records to those having a specific calendar visibility source (mobile, web).", "required": false, "schema": { "type": "string", "enum": [ "web", "mobile" ] } }, { "name": "type", "in": "query", "description": "Filter Calendar records to those of the specified type.", "required": false, "schema": { "type": "string", "enum": [ "AccountCalendar", "AdhocCalendar", "UserCalendar" ] } }, { "name": "updated_since", "in": "query", "description": "Filter Calendar records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "visible", "in": "query", "description": "Filter Calendar records to those that are visible.", "required": false, "schema": { "type": "boolean" } }, { "name": "writeable", "in": "query", "description": "Filter Calendar records to those which the user can write to.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Calendar_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Calendars" ], "summary": "Create a new Calendar", "operationId": "Calendar#create", "description": "Outlines the parameters and data fields used when creating a new Calendar", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Calendar_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Calendars", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "Calendar color as seen in the Clio Web UI." }, "name": { "type": "string", "description": "Calendar name." }, "source": { "type": "string", "enum": [ "web", "mobile" ], "description": "The source that visible applies to, by default the Clio Web UI (Expects 'mobile' or 'web')." }, "visible": { "type": "boolean", "description": "Whether or not the Calendar should be visible by default in the Clio Web UI (assuming no source is provided)." } }, "required": [ "name" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "Calendar color as seen in the Clio Web UI." }, "name": { "type": "string", "description": "Calendar name." }, "source": { "type": "string", "enum": [ "web", "mobile" ], "description": "The source that visible applies to, by default the Clio Web UI (Expects 'mobile' or 'web')." }, "visible": { "type": "boolean", "description": "Whether or not the Calendar should be visible by default in the Clio Web UI (assuming no source is provided)." } }, "required": [ "name" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "Calendar color as seen in the Clio Web UI." }, "name": { "type": "string", "description": "Calendar name." }, "source": { "type": "string", "enum": [ "web", "mobile" ], "description": "The source that visible applies to, by default the Clio Web UI (Expects 'mobile' or 'web')." }, "visible": { "type": "boolean", "description": "Whether or not the Calendar should be visible by default in the Clio Web UI (assuming no source is provided)." } }, "required": [ "name" ] } } } } }, "required": false } } }, "/calendars/{id}.json": { "get": { "tags": [ "Calendars" ], "summary": "Return the data for a single Calendar", "operationId": "Calendar#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Calendar", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Calendar.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Calendar_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Calendars" ], "summary": "Update a single Calendar", "operationId": "Calendar#update", "description": "Outlines the parameters and data fields used when updating a single Calendar", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Calendar.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Calendar_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Calendars", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "Calendar color as seen in the Clio Web UI." }, "name": { "type": "string", "description": "Calendar name." }, "source": { "type": "string", "enum": [ "web", "mobile" ], "description": "The source that visible applies to, by default the Clio Web UI (Expects 'mobile' or 'web')." }, "visible": { "type": "boolean", "description": "Whether or not the Calendar should be visible by default in the Clio Web UI (assuming no source is provided)." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "Calendar color as seen in the Clio Web UI." }, "name": { "type": "string", "description": "Calendar name." }, "source": { "type": "string", "enum": [ "web", "mobile" ], "description": "The source that visible applies to, by default the Clio Web UI (Expects 'mobile' or 'web')." }, "visible": { "type": "boolean", "description": "Whether or not the Calendar should be visible by default in the Clio Web UI (assuming no source is provided)." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "color": { "type": "string", "enum": [ "#367B9C", "#FFA5A4", "#83D17F", "#FFAC7B", "#8E3F64", "#C75300", "#009CEC", "#62D6B1", "#9EEDCB", "#F9A2C4", "#616161", "#BBDA81", "#DFD3F8", "#D6C4A5", "#FFD478", "#6AC9DE", "#EABBB0", "#BFC2E1", "#DADADA", "#CDE2F5" ], "description": "Calendar color as seen in the Clio Web UI." }, "name": { "type": "string", "description": "Calendar name." }, "source": { "type": "string", "enum": [ "web", "mobile" ], "description": "The source that visible applies to, by default the Clio Web UI (Expects 'mobile' or 'web')." }, "visible": { "type": "boolean", "description": "Whether or not the Calendar should be visible by default in the Clio Web UI (assuming no source is provided)." } } } } } } }, "required": false } }, "delete": { "tags": [ "Calendars" ], "summary": "Delete a single Calendar", "operationId": "Calendar#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single Calendar", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Calendar.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/clio_file/submissions_reports.json": { "get": { "tags": [ "Clio File/Submissions" ], "summary": "Return the data for all ClioFile::Submissions", "operationId": "ClioFile::Submission#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all ClioFile::Submissions", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter ClioFile::Submission records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter ClioFile::Submission records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of ClioFile::Submission records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the ClioFile::Submission records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "submitted_date(asc)", "submitted_date(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "submitted_after", "in": "query", "description": "Filter ClioFile::Submission records to those whose `submitted_date` is on or after the given date (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "submitted_before", "in": "query", "description": "Filter ClioFile::Submission records to those whose `submitted_date` is on or before the given date (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "updated_since", "in": "query", "description": "Filter ClioFile::Submission records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClioFileSubmissionsReport_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/clio_payments/links.json": { "get": { "tags": [ "Clio Payments Links" ], "summary": "Return the data for all ClioPaymentsLinks", "operationId": "ClioPaymentsLink#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all ClioPaymentsLinks", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Filter ClioPaymentsLink records based on whether or not they have expired.", "required": false, "schema": { "type": "boolean" } }, { "name": "created_since", "in": "query", "description": "Filter ClioPaymentsLink records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter ClioPaymentsLink records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of ClioPaymentsLink records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter ClioPaymentsLink records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClioPaymentsLink_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Clio Payments Links" ], "summary": "Create a new ClioPaymentsLink", "operationId": "ClioPaymentsLink#create", "description": "Outlines the parameters and data fields used when creating a new ClioPaymentsLink", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClioPaymentsLink_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Links", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "The amount to be paid. If not provided, the client will be able to specify an amount." }, "currency": { "type": "string", "description": "The currency the payment will be processed in. The supported currency depends on the account's location ('USD' for a US account). The currency must be a valid ISO 4217 currency code." }, "description": { "type": "string", "description": "Only applicable for a direct payment. A short description of the purpose of the payment. Max 255 characters." }, "destination_account": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The ID of the bank account that the payment will be deposited into." } }, "required": [ "id" ] }, "destination_contact": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Only applicable for a direct payment. The contact that the payment will be associated with. If not defined, and the payment is collecting an unallocated balance, then the payment can be associated with a contact manually within Manage after it has been made." } } }, "duration": { "type": "integer", "format": "int64", "description": "The amount of time, in seconds, that the payment link will be active for. The maximum allowed value is '7776000' (90 days in seconds)." }, "email_address": { "type": "string", "description": "Pre-fills the relevant field for the client when filling out their details in the payment link." }, "is_allocated_as_revenue": { "type": "boolean", "description": "Only applicable for a direct payment. If true, the payment will be allocated as revenue. If false, the payment will be collected as an unallocated balance. Payments into trust can not be allocated as revenue. Defaults to false." }, "subject": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The ID of the record associated with the payment link." }, "type": { "type": "string", "enum": [ "BankAccount", "Bill", "Contact" ], "description": "The type of the record associated with the payment link. The type of record determines the behavior of the payment link.\n\nType of subject object:\n* 'BankAccount' results in a payment link for a direct payment.\n* 'Bill' results in a payment link for paying an existing invoice or trust request.\n* 'Contact' results in a payment link for paying the outstanding invoices of a contact.\n" } }, "required": [ "id", "type" ] } }, "required": [ "currency", "description", "destination_account", "duration", "subject" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "The amount to be paid. If not provided, the client will be able to specify an amount." }, "currency": { "type": "string", "description": "The currency the payment will be processed in. The supported currency depends on the account's location ('USD' for a US account). The currency must be a valid ISO 4217 currency code." }, "description": { "type": "string", "description": "Only applicable for a direct payment. A short description of the purpose of the payment. Max 255 characters." }, "destination_account": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The ID of the bank account that the payment will be deposited into." } }, "required": [ "id" ] }, "destination_contact": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Only applicable for a direct payment. The contact that the payment will be associated with. If not defined, and the payment is collecting an unallocated balance, then the payment can be associated with a contact manually within Manage after it has been made." } } }, "duration": { "type": "integer", "format": "int64", "description": "The amount of time, in seconds, that the payment link will be active for. The maximum allowed value is '7776000' (90 days in seconds)." }, "email_address": { "type": "string", "description": "Pre-fills the relevant field for the client when filling out their details in the payment link." }, "is_allocated_as_revenue": { "type": "boolean", "description": "Only applicable for a direct payment. If true, the payment will be allocated as revenue. If false, the payment will be collected as an unallocated balance. Payments into trust can not be allocated as revenue. Defaults to false." }, "subject": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The ID of the record associated with the payment link." }, "type": { "type": "string", "enum": [ "BankAccount", "Bill", "Contact" ], "description": "The type of the record associated with the payment link. The type of record determines the behavior of the payment link.\n\nType of subject object:\n* 'BankAccount' results in a payment link for a direct payment.\n* 'Bill' results in a payment link for paying an existing invoice or trust request.\n* 'Contact' results in a payment link for paying the outstanding invoices of a contact.\n" } }, "required": [ "id", "type" ] } }, "required": [ "currency", "description", "destination_account", "duration", "subject" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "The amount to be paid. If not provided, the client will be able to specify an amount." }, "currency": { "type": "string", "description": "The currency the payment will be processed in. The supported currency depends on the account's location ('USD' for a US account). The currency must be a valid ISO 4217 currency code." }, "description": { "type": "string", "description": "Only applicable for a direct payment. A short description of the purpose of the payment. Max 255 characters." }, "destination_account": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The ID of the bank account that the payment will be deposited into." } }, "required": [ "id" ] }, "destination_contact": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Only applicable for a direct payment. The contact that the payment will be associated with. If not defined, and the payment is collecting an unallocated balance, then the payment can be associated with a contact manually within Manage after it has been made." } } }, "duration": { "type": "integer", "format": "int64", "description": "The amount of time, in seconds, that the payment link will be active for. The maximum allowed value is '7776000' (90 days in seconds)." }, "email_address": { "type": "string", "description": "Pre-fills the relevant field for the client when filling out their details in the payment link." }, "is_allocated_as_revenue": { "type": "boolean", "description": "Only applicable for a direct payment. If true, the payment will be allocated as revenue. If false, the payment will be collected as an unallocated balance. Payments into trust can not be allocated as revenue. Defaults to false." }, "subject": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The ID of the record associated with the payment link." }, "type": { "type": "string", "enum": [ "BankAccount", "Bill", "Contact" ], "description": "The type of the record associated with the payment link. The type of record determines the behavior of the payment link.\n\nType of subject object:\n* 'BankAccount' results in a payment link for a direct payment.\n* 'Bill' results in a payment link for paying an existing invoice or trust request.\n* 'Contact' results in a payment link for paying the outstanding invoices of a contact.\n" } }, "required": [ "id", "type" ] } }, "required": [ "currency", "description", "destination_account", "duration", "subject" ] } } } } }, "required": false } } }, "/clio_payments/links/{id}.json": { "get": { "tags": [ "Clio Payments Links" ], "summary": "Return the data for a single ClioPaymentsLink", "operationId": "ClioPaymentsLink#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single ClioPaymentsLink", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ClioPaymentsLink.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClioPaymentsLink_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Clio Payments Links" ], "summary": "Update a single ClioPaymentsLink", "operationId": "ClioPaymentsLink#update", "description": "Outlines the parameters and data fields used when updating a single ClioPaymentsLink", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ClioPaymentsLink.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClioPaymentsLink_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Links", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "expired": { "type": "boolean", "description": "Setting this will update the payment link to be immediately expired." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "expired": { "type": "boolean", "description": "Setting this will update the payment link to be immediately expired." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "expired": { "type": "boolean", "description": "Setting this will update the payment link to be immediately expired." } } } } } } }, "required": false } } }, "/clio_payments/payments.json": { "get": { "tags": [ "Clio Payments Payments" ], "summary": "Return the data for all ClioPaymentsPayments", "operationId": "ClioPaymentsPayment#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all ClioPaymentsPayments", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "bill_id", "in": "query", "description": "Filter ClioPaymentsPayment records to those that are allocated to the specified bill.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "contact_id", "in": "query", "description": "Filter ClioPaymentsPayment records to those that are assigned to the specified contact.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter ClioPaymentsPayment records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of ClioPaymentsPayment records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Filter ClioPaymentsPayment records to those in a given state.", "required": false, "schema": { "type": "string", "enum": [ "pending", "authorized", "completed", "voided", "failed", "canceled", "requires_confirmation", "completed_requiring_allocation" ] } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClioPaymentsPayment_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/clio_payments/payments/{id}.json": { "get": { "tags": [ "Clio Payments Payments" ], "summary": "Return the data for a single ClioPaymentsPayment", "operationId": "ClioPaymentsPayment#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single ClioPaymentsPayment", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ClioPaymentsPayment.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClioPaymentsPayment_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } } }, "/communications.json": { "get": { "tags": [ "Communications" ], "summary": "Return the data for all Communications", "operationId": "Communication#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Communications", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Communication records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter Communication records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "date", "in": "query", "description": "Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "external_property_name", "in": "query", "description": "Filter records to only those with the given external property(s) name set.\n\ne.g. `?external_property_name=Name`\n", "required": false, "schema": { "type": "string" } }, { "name": "external_property_value", "in": "query", "description": "Filter records to only those with the given external property(s) value set. Requires external property name as well.\n\ne.g. `?external_property_name=Name&external_property_value=Value`\n", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "having_time_entries", "in": "query", "description": "Filter Communication records to those that do or do not have time entries.", "required": false, "schema": { "type": "boolean" } }, { "name": "ids[]", "in": "query", "description": "Filter Communication records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Communication records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. Use the keyword `null` to match those without a Communication. The list will be filtered to include only the Communication records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "order", "in": "query", "description": "Orders the Communication records by the given field. Default: `date(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "date(asc)", "date(desc)", "received_at(asc)", "received_at(desc)", "matter(asc)", "matter(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `body` or `subject` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "received_at", "in": "query", "description": "Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date-time).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "received_before", "in": "query", "description": "Filter Communication records to those whose `date` is on or before the date provided (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "received_since", "in": "query", "description": "Filter Communication records to those whose `date` is on or after the date provided (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "type", "in": "query", "description": "Filter Communication records to those of the specified type.", "required": false, "schema": { "type": "string", "enum": [ "EmailCommunication", "PhoneCommunication" ] } }, { "name": "updated_since", "in": "query", "description": "Filter Communication records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "user_id", "in": "query", "description": "The unique identifier for a single User. The keyword `null` is not valid for this field. The list will be filtered to include only the Communication records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Communication_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Communications" ], "summary": "Create a new Communication", "operationId": "Communication#create", "description": "Outlines the parameters and data fields used when creating a new Communication", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Communication_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Communications", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per Communication**" }, "value": { "type": "string", "description": "The ExternalProperty value." } } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Communication. The keyword `null` is not valid for this field." } } }, "notification_event_subscribers": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier for a User to be added as a notification event subscriber to the Phone Log Communication. Note: Only applicable to Phone Log Communications, invalid for other communication types." } }, "required": [ "user_id" ] } }, "received_at": { "type": "string", "description": "The date-time for the Communication. (Expects an ISO-8601 date-time.)" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the receivers should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the receivers of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the receivers of this Communication." } } } }, "senders": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the senders should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the senders of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the senders of this Communication." } } } }, "subject": { "type": "string", "description": "The subject value." }, "type": { "type": "string", "enum": [ "PhoneCommunication", "EmailCommunication" ], "description": "Type of the Communication." } }, "required": [ "body", "received_at", "subject", "type" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per Communication**" }, "value": { "type": "string", "description": "The ExternalProperty value." } } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Communication. The keyword `null` is not valid for this field." } } }, "notification_event_subscribers": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier for a User to be added as a notification event subscriber to the Phone Log Communication. Note: Only applicable to Phone Log Communications, invalid for other communication types." } }, "required": [ "user_id" ] } }, "received_at": { "type": "string", "description": "The date-time for the Communication. (Expects an ISO-8601 date-time.)" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the receivers should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the receivers of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the receivers of this Communication." } } } }, "senders": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the senders should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the senders of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the senders of this Communication." } } } }, "subject": { "type": "string", "description": "The subject value." }, "type": { "type": "string", "enum": [ "PhoneCommunication", "EmailCommunication" ], "description": "Type of the Communication." } }, "required": [ "body", "received_at", "subject", "type" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per Communication**" }, "value": { "type": "string", "description": "The ExternalProperty value." } } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Communication. The keyword `null` is not valid for this field." } } }, "notification_event_subscribers": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier for a User to be added as a notification event subscriber to the Phone Log Communication. Note: Only applicable to Phone Log Communications, invalid for other communication types." } }, "required": [ "user_id" ] } }, "received_at": { "type": "string", "description": "The date-time for the Communication. (Expects an ISO-8601 date-time.)" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the receivers should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the receivers of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the receivers of this Communication." } } } }, "senders": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the senders should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the senders of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the senders of this Communication." } } } }, "subject": { "type": "string", "description": "The subject value." }, "type": { "type": "string", "enum": [ "PhoneCommunication", "EmailCommunication" ], "description": "Type of the Communication." } }, "required": [ "body", "received_at", "subject", "type" ] } } } } }, "required": false } } }, "/communications/{id}.json": { "get": { "tags": [ "Communications" ], "summary": "Return the data for a single Communication", "operationId": "Communication#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Communication", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Communication.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Communication_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Communications" ], "summary": "Update a single Communication", "operationId": "Communication#update", "description": "Outlines the parameters and data fields used when updating a single Communication", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Communication.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Communication_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Communications", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExternalProperty associated with the Communication. The keyword `null` is not valid for this field." }, "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per Communication**" }, "value": { "type": "string", "description": "The ExternalProperty value." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated ExternalProperty is present, the ExternalProperty is deleted from the Communication." } } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Communication. The keyword `null` is not valid for this field." } } }, "notification_event_subscribers": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier for a User to be added as a notification event subscriber to the Phone Log Communication. Note: Only applicable to Phone Log Communications, invalid for other communication types." }, "id": { "type": "integer", "format": "int64", "description": "Unique id of this Communication. Note: Only applicable to Phone Log Communications, invalid for other communication types." }, "_destroy": { "type": "boolean", "description": "Whether or not the notification event subscriber should be deleted. Note: Only applicable to Phone Log Communications, invalid for other communication types." } } } }, "received_at": { "type": "string", "description": "The date-time for the Communication. (Expects an ISO-8601 date-time.)" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the receivers should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the receivers of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the receivers of this Communication." } } } }, "senders": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the senders should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the senders of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the senders of this Communication." } } } }, "subject": { "type": "string", "description": "The subject value." }, "type": { "type": "string", "enum": [ "PhoneCommunication", "EmailCommunication" ], "description": "Type of the Communication." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExternalProperty associated with the Communication. The keyword `null` is not valid for this field." }, "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per Communication**" }, "value": { "type": "string", "description": "The ExternalProperty value." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated ExternalProperty is present, the ExternalProperty is deleted from the Communication." } } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Communication. The keyword `null` is not valid for this field." } } }, "notification_event_subscribers": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier for a User to be added as a notification event subscriber to the Phone Log Communication. Note: Only applicable to Phone Log Communications, invalid for other communication types." }, "id": { "type": "integer", "format": "int64", "description": "Unique id of this Communication. Note: Only applicable to Phone Log Communications, invalid for other communication types." }, "_destroy": { "type": "boolean", "description": "Whether or not the notification event subscriber should be deleted. Note: Only applicable to Phone Log Communications, invalid for other communication types." } } } }, "received_at": { "type": "string", "description": "The date-time for the Communication. (Expects an ISO-8601 date-time.)" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the receivers should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the receivers of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the receivers of this Communication." } } } }, "senders": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the senders should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the senders of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the senders of this Communication." } } } }, "subject": { "type": "string", "description": "The subject value." }, "type": { "type": "string", "enum": [ "PhoneCommunication", "EmailCommunication" ], "description": "Type of the Communication." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value." }, "external_properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single ExternalProperty associated with the Communication. The keyword `null` is not valid for this field." }, "name": { "type": "string", "description": "The ExternalProperty name. Note: **there is a limit of 5 external_properties per Communication**" }, "value": { "type": "string", "description": "The ExternalProperty value." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated ExternalProperty is present, the ExternalProperty is deleted from the Communication." } } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Communication. The keyword `null` is not valid for this field." } } }, "notification_event_subscribers": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier for a User to be added as a notification event subscriber to the Phone Log Communication. Note: Only applicable to Phone Log Communications, invalid for other communication types." }, "id": { "type": "integer", "format": "int64", "description": "Unique id of this Communication. Note: Only applicable to Phone Log Communications, invalid for other communication types." }, "_destroy": { "type": "boolean", "description": "Whether or not the notification event subscriber should be deleted. Note: Only applicable to Phone Log Communications, invalid for other communication types." } } } }, "received_at": { "type": "string", "description": "The date-time for the Communication. (Expects an ISO-8601 date-time.)" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the receivers should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the receivers of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the receivers of this Communication." } } } }, "senders": { "type": "array", "items": { "type": "object", "properties": { "_deleted": { "type": "boolean", "description": "Whether or not the senders should be deleted." }, "id": { "type": "integer", "format": "int64", "description": "Unique ids for the senders of this Communication." }, "type": { "type": "string", "enum": [ "User", "Contact" ], "description": "Types of the senders of this Communication." } } } }, "subject": { "type": "string", "description": "The subject value." }, "type": { "type": "string", "enum": [ "PhoneCommunication", "EmailCommunication" ], "description": "Type of the Communication." } } } } } } }, "required": false } }, "delete": { "tags": [ "Communications" ], "summary": "Delete a single Communication", "operationId": "Communication#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single Communication", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Communication.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/contacts/{contact_id}/email_addresses.json": { "get": { "tags": [ "Email Addresses" ], "summary": "Return the data for all EmailAddresses", "operationId": "EmailAddress#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all EmailAddresses", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "contact_id", "in": "path", "description": "ID of the Contact", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter EmailAddress records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter EmailAddress records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of EmailAddress records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter EmailAddress records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/EmailAddress_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/contacts/{contact_id}/phone_numbers.json": { "get": { "tags": [ "Phone Numbers" ], "summary": "Return the data for all PhoneNumbers", "operationId": "PhoneNumber#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all PhoneNumbers", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "contact_id", "in": "path", "description": "ID of the Contact", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter PhoneNumber records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter PhoneNumber records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of PhoneNumber records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter PhoneNumber records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PhoneNumber_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/contacts.json": { "get": { "tags": [ "Contacts" ], "summary": "Return the data for all Contacts", "operationId": "Contact#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Contacts", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "client_only", "in": "query", "description": "Filter Contact records to those that are clients.", "required": false, "schema": { "type": "boolean" } }, { "name": "clio_connect_only", "in": "query", "description": "Filter Contact records to those that are Clio Connect users.", "required": false, "schema": { "type": "boolean" } }, { "name": "created_since", "in": "query", "description": "Filter Contact records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "custom_field_ids[]", "in": "query", "description": "Filter Contact's custom_field_values to only include values for the given custom field unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "custom_field_values", "in": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif 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.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n", "required": false, "schema": { "type": "string", "enum": [ "=", "<", ">", "<=", ">=" ] } }, { "name": "email_only", "in": "query", "description": "Filter Contact records to those that have email addresses.", "required": false, "schema": { "type": "boolean" } }, { "name": "exclude_ids[]", "in": "query", "description": "Filter Contact records to those who are not included in the given list of unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter Contact records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "initial", "in": "query", "description": "Filter Contact records to those where the last name or company name start with the given initial.", "required": false, "schema": { "type": "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" ] } }, { "name": "limit", "in": "query", "description": "A limit on the number of Contact records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the Contact records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "name(asc)", "name(desc)", "shared_at(asc)", "shared_at(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for name, title, email address, address, phone number, web site, instant messenger address,\ncustom fields, related matter name, or company name matching a given string.\n", "required": false, "schema": { "type": "string" } }, { "name": "shared_resource_id", "in": "query", "description": "Filter Contact records to those that currently have access to a given shared resource.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "type", "in": "query", "description": "Filter Contact records to those that match the given type.", "required": false, "schema": { "type": "string", "enum": [ "Company", "Person" ] } }, { "name": "updated_since", "in": "query", "description": "Filter Contact records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Contact_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Contacts" ], "summary": "Create a new Contact", "operationId": "Contact#create", "description": "Outlines the parameters and data fields used when creating a new Contact", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "custom_field_ids[]", "in": "query", "description": "Filter Contact's custom_field_values to only include values for the given custom field unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Contact_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Contacts", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Billing", "Other" ], "description": "Name of the Address." }, "street": { "type": "string", "description": "Street." }, "city": { "type": "string", "description": "City." }, "province": { "type": "string", "description": "Province or state." }, "postal_code": { "type": "string", "description": "Postal code or zip code." }, "country": { "type": "string", "description": "Country" } } } }, "avatar": { "type": "object", "properties": { "image": { "type": "string", "description": "The avatar image for the *Contact*, base64-encoded. Must be a valid GIF, JPG, or PNG image of less than 2 megabytes in size." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated Avatar is present, the Avatar is deleted from the Contact." } } }, "clio_connect_email": { "type": "string", "description": "Notifications will be sent to this email when a resource is shared." }, "co_counsel_rate": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Billing rate if the Contact is a co-counsel.\n\nNote: this value can only be provided during PATCH requests. It cannot be provided at the time a Contact is created (i.e. POST requests).\n" } } }, "company": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Company associated with the Contact. The keyword `null` is not valid for this field." } } }, "currency": { "type": "object", "description": "The Currency the contact is associated with." }, "custom_field_set_associations": { "type": "array", "items": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int32", "description": "The order to display the CustomFieldSet in a Contact. If not specified, it is added as the last CustomFieldSet of the Contact." }, "custom_field_set": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldSet associated with the CustomFieldSetAssociation. The keyword `null` is not valid for this field." } }, "required": [ "id" ] } }, "required": [ "custom_field_set" ] } }, "custom_field_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "The value of the CustomFieldValue." }, "custom_field": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomField associated with the CustomFieldValue. The keyword `null` is not valid for this field." } }, "required": [ "id" ] } }, "required": [ "value", "custom_field" ] } }, "date_of_birth": { "type": "string", "format": "date", "description": "Date of birth of the Contact." }, "email_addresses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Other" ], "description": "Name of the EmailAddress." }, "address": { "type": "string", "description": "Email address." }, "default_email": { "type": "boolean", "description": "Whether or not the Contact should be the default email for the Contact." } } } }, "first_name": { "type": "string", "description": "First name of the Contact." }, "instant_messengers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Other" ], "description": "Name of the InstantMessenger." }, "address": { "type": "string", "description": "Address of the InstantMessenger." } } } }, "kyc_field_values": { "type": "array", "items": { "type": "object", "properties": { "field_name": { "type": "string", "description": "The name of the KYC/KYB field. KYC/KYB fields are available for eligible accounts in Australia, Canada, Channel Islands, Ireland, Isle of Man, New Zealand, and United Kingdom." }, "field_type": { "type": "string", "enum": [ "date", "text", "picklist" ], "description": "The type of the KYC/KYB field. Must be one of: date, text, picklist." }, "field_value": { "type": "string", "description": "The value of the KYC/KYB field." } }, "required": [ "field_name", "field_type", "field_value" ] } }, "last_name": { "type": "string", "description": "Last name of the Contact." }, "ledes_client_id": { "type": "string", "description": "LEDES client id of the Contact." }, "middle_name": { "type": "string", "description": "Middle name of the Contact." }, "name": { "type": "string", "description": "Full name of the Contact. For requirements, see [Contact Name](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Contacts/Contact-Name)." }, "phone_numbers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Mobile", "Fax", "Pager", "Skype", "Other" ], "description": "Name of the PhoneNumber." }, "number": { "type": "string", "description": "Phone number." }, "default_number": { "type": "boolean", "description": "Whether or not the PhoneNumber should be the default number for the Contact." } } } }, "prefix": { "type": "string", "description": "Personal title of the Contact." }, "sales_tax_number": { "type": "string", "description": "A contact's sales tax number will appear on invoices generated for the Contact." }, "title": { "type": "string", "description": "Professional title of the Contact." }, "type": { "type": "string", "enum": [ "Person", "Company" ], "description": "Type of the Contact." }, "web_sites": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Twitter", "Facebook", "LinkedIn", "Instant Messenger", "Other" ], "description": "Name of the WebSite." }, "address": { "type": "string", "description": "URL of the WebSite." }, "default_web_site": { "type": "boolean", "description": "Whether or not the Contact should be the default website for the Contact." } } } } }, "required": [ "name", "type" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Billing", "Other" ], "description": "Name of the Address." }, "street": { "type": "string", "description": "Street." }, "city": { "type": "string", "description": "City." }, "province": { "type": "string", "description": "Province or state." }, "postal_code": { "type": "string", "description": "Postal code or zip code." }, "country": { "type": "string", "description": "Country" } } } }, "avatar": { "type": "object", "properties": { "image": { "type": "string", "description": "The avatar image for the *Contact*, base64-encoded. Must be a valid GIF, JPG, or PNG image of less than 2 megabytes in size." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated Avatar is present, the Avatar is deleted from the Contact." } } }, "clio_connect_email": { "type": "string", "description": "Notifications will be sent to this email when a resource is shared." }, "co_counsel_rate": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Billing rate if the Contact is a co-counsel.\n\nNote: this value can only be provided during PATCH requests. It cannot be provided at the time a Contact is created (i.e. POST requests).\n" } } }, "company": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Company associated with the Contact. The keyword `null` is not valid for this field." } } }, "currency": { "type": "object", "description": "The Currency the contact is associated with." }, "custom_field_set_associations": { "type": "array", "items": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int32", "description": "The order to display the CustomFieldSet in a Contact. If not specified, it is added as the last CustomFieldSet of the Contact." }, "custom_field_set": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldSet associated with the CustomFieldSetAssociation. The keyword `null` is not valid for this field." } }, "required": [ "id" ] } }, "required": [ "custom_field_set" ] } }, "custom_field_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "The value of the CustomFieldValue." }, "custom_field": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomField associated with the CustomFieldValue. The keyword `null` is not valid for this field." } }, "required": [ "id" ] } }, "required": [ "value", "custom_field" ] } }, "date_of_birth": { "type": "string", "format": "date", "description": "Date of birth of the Contact." }, "email_addresses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Other" ], "description": "Name of the EmailAddress." }, "address": { "type": "string", "description": "Email address." }, "default_email": { "type": "boolean", "description": "Whether or not the Contact should be the default email for the Contact." } } } }, "first_name": { "type": "string", "description": "First name of the Contact." }, "instant_messengers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Other" ], "description": "Name of the InstantMessenger." }, "address": { "type": "string", "description": "Address of the InstantMessenger." } } } }, "kyc_field_values": { "type": "array", "items": { "type": "object", "properties": { "field_name": { "type": "string", "description": "The name of the KYC/KYB field. KYC/KYB fields are available for eligible accounts in Australia, Canada, Channel Islands, Ireland, Isle of Man, New Zealand, and United Kingdom." }, "field_type": { "type": "string", "enum": [ "date", "text", "picklist" ], "description": "The type of the KYC/KYB field. Must be one of: date, text, picklist." }, "field_value": { "type": "string", "description": "The value of the KYC/KYB field." } }, "required": [ "field_name", "field_type", "field_value" ] } }, "last_name": { "type": "string", "description": "Last name of the Contact." }, "ledes_client_id": { "type": "string", "description": "LEDES client id of the Contact." }, "middle_name": { "type": "string", "description": "Middle name of the Contact." }, "name": { "type": "string", "description": "Full name of the Contact. For requirements, see [Contact Name](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Contacts/Contact-Name)." }, "phone_numbers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Mobile", "Fax", "Pager", "Skype", "Other" ], "description": "Name of the PhoneNumber." }, "number": { "type": "string", "description": "Phone number." }, "default_number": { "type": "boolean", "description": "Whether or not the PhoneNumber should be the default number for the Contact." } } } }, "prefix": { "type": "string", "description": "Personal title of the Contact." }, "sales_tax_number": { "type": "string", "description": "A contact's sales tax number will appear on invoices generated for the Contact." }, "title": { "type": "string", "description": "Professional title of the Contact." }, "type": { "type": "string", "enum": [ "Person", "Company" ], "description": "Type of the Contact." }, "web_sites": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Twitter", "Facebook", "LinkedIn", "Instant Messenger", "Other" ], "description": "Name of the WebSite." }, "address": { "type": "string", "description": "URL of the WebSite." }, "default_web_site": { "type": "boolean", "description": "Whether or not the Contact should be the default website for the Contact." } } } } }, "required": [ "name", "type" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Billing", "Other" ], "description": "Name of the Address." }, "street": { "type": "string", "description": "Street." }, "city": { "type": "string", "description": "City." }, "province": { "type": "string", "description": "Province or state." }, "postal_code": { "type": "string", "description": "Postal code or zip code." }, "country": { "type": "string", "description": "Country" } } } }, "avatar": { "type": "object", "properties": { "image": { "type": "string", "description": "The avatar image for the *Contact*, base64-encoded. Must be a valid GIF, JPG, or PNG image of less than 2 megabytes in size." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated Avatar is present, the Avatar is deleted from the Contact." } } }, "clio_connect_email": { "type": "string", "description": "Notifications will be sent to this email when a resource is shared." }, "co_counsel_rate": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Billing rate if the Contact is a co-counsel.\n\nNote: this value can only be provided during PATCH requests. It cannot be provided at the time a Contact is created (i.e. POST requests).\n" } } }, "company": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Company associated with the Contact. The keyword `null` is not valid for this field." } } }, "currency": { "type": "object", "description": "The Currency the contact is associated with." }, "custom_field_set_associations": { "type": "array", "items": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int32", "description": "The order to display the CustomFieldSet in a Contact. If not specified, it is added as the last CustomFieldSet of the Contact." }, "custom_field_set": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldSet associated with the CustomFieldSetAssociation. The keyword `null` is not valid for this field." } }, "required": [ "id" ] } }, "required": [ "custom_field_set" ] } }, "custom_field_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "The value of the CustomFieldValue." }, "custom_field": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomField associated with the CustomFieldValue. The keyword `null` is not valid for this field." } }, "required": [ "id" ] } }, "required": [ "value", "custom_field" ] } }, "date_of_birth": { "type": "string", "format": "date", "description": "Date of birth of the Contact." }, "email_addresses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Other" ], "description": "Name of the EmailAddress." }, "address": { "type": "string", "description": "Email address." }, "default_email": { "type": "boolean", "description": "Whether or not the Contact should be the default email for the Contact." } } } }, "first_name": { "type": "string", "description": "First name of the Contact." }, "instant_messengers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Other" ], "description": "Name of the InstantMessenger." }, "address": { "type": "string", "description": "Address of the InstantMessenger." } } } }, "kyc_field_values": { "type": "array", "items": { "type": "object", "properties": { "field_name": { "type": "string", "description": "The name of the KYC/KYB field. KYC/KYB fields are available for eligible accounts in Australia, Canada, Channel Islands, Ireland, Isle of Man, New Zealand, and United Kingdom." }, "field_type": { "type": "string", "enum": [ "date", "text", "picklist" ], "description": "The type of the KYC/KYB field. Must be one of: date, text, picklist." }, "field_value": { "type": "string", "description": "The value of the KYC/KYB field." } }, "required": [ "field_name", "field_type", "field_value" ] } }, "last_name": { "type": "string", "description": "Last name of the Contact." }, "ledes_client_id": { "type": "string", "description": "LEDES client id of the Contact." }, "middle_name": { "type": "string", "description": "Middle name of the Contact." }, "name": { "type": "string", "description": "Full name of the Contact. For requirements, see [Contact Name](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Contacts/Contact-Name)." }, "phone_numbers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Mobile", "Fax", "Pager", "Skype", "Other" ], "description": "Name of the PhoneNumber." }, "number": { "type": "string", "description": "Phone number." }, "default_number": { "type": "boolean", "description": "Whether or not the PhoneNumber should be the default number for the Contact." } } } }, "prefix": { "type": "string", "description": "Personal title of the Contact." }, "sales_tax_number": { "type": "string", "description": "A contact's sales tax number will appear on invoices generated for the Contact." }, "title": { "type": "string", "description": "Professional title of the Contact." }, "type": { "type": "string", "enum": [ "Person", "Company" ], "description": "Type of the Contact." }, "web_sites": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Twitter", "Facebook", "LinkedIn", "Instant Messenger", "Other" ], "description": "Name of the WebSite." }, "address": { "type": "string", "description": "URL of the WebSite." }, "default_web_site": { "type": "boolean", "description": "Whether or not the Contact should be the default website for the Contact." } } } } }, "required": [ "name", "type" ] } } } } }, "required": false } } }, "/contacts/{id}.json": { "get": { "tags": [ "Contacts" ], "summary": "Return the data for a single Contact", "operationId": "Contact#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Contact", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "custom_field_ids[]", "in": "query", "description": "Filter Contact's custom_field_values to only include values for the given custom field unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Contact.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Contact_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Contacts" ], "summary": "Update a single Contact", "operationId": "Contact#update", "description": "Outlines the parameters and data fields used when updating a single Contact", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "custom_field_ids[]", "in": "query", "description": "Filter Contact's custom_field_values to only include values for the given custom field unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Contact.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Contact_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Contacts", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Billing", "Other" ], "description": "Name of the Address." }, "street": { "type": "string", "description": "Street." }, "city": { "type": "string", "description": "City." }, "province": { "type": "string", "description": "Province or state." }, "postal_code": { "type": "string", "description": "Postal code or zip code." }, "country": { "type": "string", "description": "Country" }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Address associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated Address is present, the Address is deleted from the Contact." } } } }, "avatar": { "type": "object", "properties": { "image": { "type": "string", "description": "The avatar image for the *Contact*, base64-encoded. Must be a valid GIF, JPG, or PNG image of less than 2 megabytes in size." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated Avatar is present, the Avatar is deleted from the Contact." } } }, "clio_connect_email": { "type": "string", "description": "Notifications will be sent to this email when a resource is shared." }, "co_counsel_rate": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Billing rate if the Contact is a co-counsel.\n\nNote: this value can only be provided during PATCH requests. It cannot be provided at the time a Contact is created (i.e. POST requests).\n" } } }, "company": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Company associated with the Contact. The keyword `null` is not valid for this field." } } }, "currency": { "type": "object", "description": "The Currency the contact is associated with." }, "custom_field_set_associations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldSetAssociation associated with the Contact. The keyword `null` is not valid for this field." }, "display_order": { "type": "integer", "format": "int32", "description": "The order to display the CustomFieldSet in a Contact. If not specified, it is added as the last CustomFieldSet of the Contact." }, "custom_field_set": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldSet associated with the CustomFieldSetAssociation. The keyword `null` is not valid for this field." } } }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated CustomFieldSetAssociation is present, the CustomFieldSetAssociation is deleted from the Contact." } } } }, "custom_field_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "The value of the CustomFieldValue." }, "custom_field": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomField associated with the CustomFieldValue. The keyword `null` is not valid for this field." } } }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldValue associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated CustomFieldValue is present, the CustomFieldValue is deleted from the Contact." } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Date of birth of the Contact." }, "email_addresses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single EmailAddress associated with the Contact. The keyword `null` is not valid for this field." }, "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Other" ], "description": "Name of the EmailAddress." }, "address": { "type": "string", "description": "Email address." }, "default_email": { "type": "boolean", "description": "Whether or not the Contact should be the default email for the Contact." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated EmailAddress is present, the EmailAddress is deleted from the Contact." } } } }, "first_name": { "type": "string", "description": "First name of the Contact." }, "instant_messengers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Other" ], "description": "Name of the InstantMessenger." }, "address": { "type": "string", "description": "Address of the InstantMessenger." }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single InstantMessenger associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated InstantMessenger is present, the InstantMessenger is deleted from the Contact." } } } }, "kyc_field_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single KycFieldValue associated with the Contact. The keyword `null` is not valid for this field." }, "field_name": { "type": "string", "description": "The name of the KYC/KYB field. KYC/KYB fields are available for eligible accounts in Australia, Canada, Channel Islands, Ireland, Isle of Man, New Zealand, and United Kingdom." }, "field_type": { "type": "string", "enum": [ "date", "text", "picklist" ], "description": "The type of the KYC/KYB field. Must be one of: date, text, picklist." }, "field_value": { "type": "string", "description": "The value of the KYC/KYB field." } } } }, "last_name": { "type": "string", "description": "Last name of the Contact." }, "ledes_client_id": { "type": "string", "description": "LEDES client id of the Contact." }, "middle_name": { "type": "string", "description": "Middle name of the Contact." }, "name": { "type": "string", "description": "Full name of the Contact. For requirements, see [Contact Name](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Contacts/Contact-Name)." }, "phone_numbers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Mobile", "Fax", "Pager", "Skype", "Other" ], "description": "Name of the PhoneNumber." }, "number": { "type": "string", "description": "Phone number." }, "default_number": { "type": "boolean", "description": "Whether or not the PhoneNumber should be the default number for the Contact." }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single PhoneNumber associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated PhoneNumber is present, the PhoneNumber is deleted from the Contact." } } } }, "prefix": { "type": "string", "description": "Personal title of the Contact." }, "sales_tax_number": { "type": "string", "description": "A contact's sales tax number will appear on invoices generated for the Contact." }, "title": { "type": "string", "description": "Professional title of the Contact." }, "type": { "type": "string", "enum": [ "Person", "Company" ], "description": "Type of the Contact." }, "web_sites": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Twitter", "Facebook", "LinkedIn", "Instant Messenger", "Other" ], "description": "Name of the WebSite." }, "address": { "type": "string", "description": "URL of the WebSite." }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single WebSite associated with the Contact. The keyword `null` is not valid for this field." }, "default_web_site": { "type": "boolean", "description": "Whether or not the Contact should be the default website for the Contact." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated WebSite is present, the WebSite is deleted from the Contact." } } } } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Billing", "Other" ], "description": "Name of the Address." }, "street": { "type": "string", "description": "Street." }, "city": { "type": "string", "description": "City." }, "province": { "type": "string", "description": "Province or state." }, "postal_code": { "type": "string", "description": "Postal code or zip code." }, "country": { "type": "string", "description": "Country" }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Address associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated Address is present, the Address is deleted from the Contact." } } } }, "avatar": { "type": "object", "properties": { "image": { "type": "string", "description": "The avatar image for the *Contact*, base64-encoded. Must be a valid GIF, JPG, or PNG image of less than 2 megabytes in size." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated Avatar is present, the Avatar is deleted from the Contact." } } }, "clio_connect_email": { "type": "string", "description": "Notifications will be sent to this email when a resource is shared." }, "co_counsel_rate": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Billing rate if the Contact is a co-counsel.\n\nNote: this value can only be provided during PATCH requests. It cannot be provided at the time a Contact is created (i.e. POST requests).\n" } } }, "company": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Company associated with the Contact. The keyword `null` is not valid for this field." } } }, "currency": { "type": "object", "description": "The Currency the contact is associated with." }, "custom_field_set_associations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldSetAssociation associated with the Contact. The keyword `null` is not valid for this field." }, "display_order": { "type": "integer", "format": "int32", "description": "The order to display the CustomFieldSet in a Contact. If not specified, it is added as the last CustomFieldSet of the Contact." }, "custom_field_set": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldSet associated with the CustomFieldSetAssociation. The keyword `null` is not valid for this field." } } }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated CustomFieldSetAssociation is present, the CustomFieldSetAssociation is deleted from the Contact." } } } }, "custom_field_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "The value of the CustomFieldValue." }, "custom_field": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomField associated with the CustomFieldValue. The keyword `null` is not valid for this field." } } }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldValue associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated CustomFieldValue is present, the CustomFieldValue is deleted from the Contact." } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Date of birth of the Contact." }, "email_addresses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single EmailAddress associated with the Contact. The keyword `null` is not valid for this field." }, "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Other" ], "description": "Name of the EmailAddress." }, "address": { "type": "string", "description": "Email address." }, "default_email": { "type": "boolean", "description": "Whether or not the Contact should be the default email for the Contact." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated EmailAddress is present, the EmailAddress is deleted from the Contact." } } } }, "first_name": { "type": "string", "description": "First name of the Contact." }, "instant_messengers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Other" ], "description": "Name of the InstantMessenger." }, "address": { "type": "string", "description": "Address of the InstantMessenger." }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single InstantMessenger associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated InstantMessenger is present, the InstantMessenger is deleted from the Contact." } } } }, "kyc_field_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single KycFieldValue associated with the Contact. The keyword `null` is not valid for this field." }, "field_name": { "type": "string", "description": "The name of the KYC/KYB field. KYC/KYB fields are available for eligible accounts in Australia, Canada, Channel Islands, Ireland, Isle of Man, New Zealand, and United Kingdom." }, "field_type": { "type": "string", "enum": [ "date", "text", "picklist" ], "description": "The type of the KYC/KYB field. Must be one of: date, text, picklist." }, "field_value": { "type": "string", "description": "The value of the KYC/KYB field." } } } }, "last_name": { "type": "string", "description": "Last name of the Contact." }, "ledes_client_id": { "type": "string", "description": "LEDES client id of the Contact." }, "middle_name": { "type": "string", "description": "Middle name of the Contact." }, "name": { "type": "string", "description": "Full name of the Contact. For requirements, see [Contact Name](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Contacts/Contact-Name)." }, "phone_numbers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Mobile", "Fax", "Pager", "Skype", "Other" ], "description": "Name of the PhoneNumber." }, "number": { "type": "string", "description": "Phone number." }, "default_number": { "type": "boolean", "description": "Whether or not the PhoneNumber should be the default number for the Contact." }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single PhoneNumber associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated PhoneNumber is present, the PhoneNumber is deleted from the Contact." } } } }, "prefix": { "type": "string", "description": "Personal title of the Contact." }, "sales_tax_number": { "type": "string", "description": "A contact's sales tax number will appear on invoices generated for the Contact." }, "title": { "type": "string", "description": "Professional title of the Contact." }, "type": { "type": "string", "enum": [ "Person", "Company" ], "description": "Type of the Contact." }, "web_sites": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Twitter", "Facebook", "LinkedIn", "Instant Messenger", "Other" ], "description": "Name of the WebSite." }, "address": { "type": "string", "description": "URL of the WebSite." }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single WebSite associated with the Contact. The keyword `null` is not valid for this field." }, "default_web_site": { "type": "boolean", "description": "Whether or not the Contact should be the default website for the Contact." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated WebSite is present, the WebSite is deleted from the Contact." } } } } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Billing", "Other" ], "description": "Name of the Address." }, "street": { "type": "string", "description": "Street." }, "city": { "type": "string", "description": "City." }, "province": { "type": "string", "description": "Province or state." }, "postal_code": { "type": "string", "description": "Postal code or zip code." }, "country": { "type": "string", "description": "Country" }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Address associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated Address is present, the Address is deleted from the Contact." } } } }, "avatar": { "type": "object", "properties": { "image": { "type": "string", "description": "The avatar image for the *Contact*, base64-encoded. Must be a valid GIF, JPG, or PNG image of less than 2 megabytes in size." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated Avatar is present, the Avatar is deleted from the Contact." } } }, "clio_connect_email": { "type": "string", "description": "Notifications will be sent to this email when a resource is shared." }, "co_counsel_rate": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Billing rate if the Contact is a co-counsel.\n\nNote: this value can only be provided during PATCH requests. It cannot be provided at the time a Contact is created (i.e. POST requests).\n" } } }, "company": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Company associated with the Contact. The keyword `null` is not valid for this field." } } }, "currency": { "type": "object", "description": "The Currency the contact is associated with." }, "custom_field_set_associations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldSetAssociation associated with the Contact. The keyword `null` is not valid for this field." }, "display_order": { "type": "integer", "format": "int32", "description": "The order to display the CustomFieldSet in a Contact. If not specified, it is added as the last CustomFieldSet of the Contact." }, "custom_field_set": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldSet associated with the CustomFieldSetAssociation. The keyword `null` is not valid for this field." } } }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated CustomFieldSetAssociation is present, the CustomFieldSetAssociation is deleted from the Contact." } } } }, "custom_field_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "The value of the CustomFieldValue." }, "custom_field": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomField associated with the CustomFieldValue. The keyword `null` is not valid for this field." } } }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single CustomFieldValue associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated CustomFieldValue is present, the CustomFieldValue is deleted from the Contact." } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Date of birth of the Contact." }, "email_addresses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single EmailAddress associated with the Contact. The keyword `null` is not valid for this field." }, "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Other" ], "description": "Name of the EmailAddress." }, "address": { "type": "string", "description": "Email address." }, "default_email": { "type": "boolean", "description": "Whether or not the Contact should be the default email for the Contact." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated EmailAddress is present, the EmailAddress is deleted from the Contact." } } } }, "first_name": { "type": "string", "description": "First name of the Contact." }, "instant_messengers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Other" ], "description": "Name of the InstantMessenger." }, "address": { "type": "string", "description": "Address of the InstantMessenger." }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single InstantMessenger associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated InstantMessenger is present, the InstantMessenger is deleted from the Contact." } } } }, "kyc_field_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single KycFieldValue associated with the Contact. The keyword `null` is not valid for this field." }, "field_name": { "type": "string", "description": "The name of the KYC/KYB field. KYC/KYB fields are available for eligible accounts in Australia, Canada, Channel Islands, Ireland, Isle of Man, New Zealand, and United Kingdom." }, "field_type": { "type": "string", "enum": [ "date", "text", "picklist" ], "description": "The type of the KYC/KYB field. Must be one of: date, text, picklist." }, "field_value": { "type": "string", "description": "The value of the KYC/KYB field." } } } }, "last_name": { "type": "string", "description": "Last name of the Contact." }, "ledes_client_id": { "type": "string", "description": "LEDES client id of the Contact." }, "middle_name": { "type": "string", "description": "Middle name of the Contact." }, "name": { "type": "string", "description": "Full name of the Contact. For requirements, see [Contact Name](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Contacts/Contact-Name)." }, "phone_numbers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Home", "Mobile", "Fax", "Pager", "Skype", "Other" ], "description": "Name of the PhoneNumber." }, "number": { "type": "string", "description": "Phone number." }, "default_number": { "type": "boolean", "description": "Whether or not the PhoneNumber should be the default number for the Contact." }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single PhoneNumber associated with the Contact. The keyword `null` is not valid for this field." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated PhoneNumber is present, the PhoneNumber is deleted from the Contact." } } } }, "prefix": { "type": "string", "description": "Personal title of the Contact." }, "sales_tax_number": { "type": "string", "description": "A contact's sales tax number will appear on invoices generated for the Contact." }, "title": { "type": "string", "description": "Professional title of the Contact." }, "type": { "type": "string", "enum": [ "Person", "Company" ], "description": "Type of the Contact." }, "web_sites": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "default": "Other", "enum": [ "Work", "Personal", "Twitter", "Facebook", "LinkedIn", "Instant Messenger", "Other" ], "description": "Name of the WebSite." }, "address": { "type": "string", "description": "URL of the WebSite." }, "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single WebSite associated with the Contact. The keyword `null` is not valid for this field." }, "default_web_site": { "type": "boolean", "description": "Whether or not the Contact should be the default website for the Contact." }, "_destroy": { "type": "boolean", "description": "The destroy flag. If the flag is set to `true` and the unique identifier of the associated WebSite is present, the WebSite is deleted from the Contact." } } } } } } } } } }, "required": false } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete a single Contact", "operationId": "Contact#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single Contact", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Contact.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/conversation_messages.json": { "get": { "tags": [ "Conversation Messages" ], "summary": "Return the data for all ConversationMessages", "operationId": "ConversationMessage#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all ConversationMessages", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "conversation_id", "in": "query", "description": "The unique identifier for a single Conversation. Use the keyword `null` to match those without a ConversationMessage. The list will be filtered to include only the ConversationMessage records with the matching property.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter ConversationMessage records to those having the `created_at` field on the related Conversation after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter ConversationMessage records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of ConversationMessage records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the ConversationMessage records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `body` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter ConversationMessage records to those having the `updated_at` field on the related Conversation after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ConversationMessage_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Conversation Messages" ], "summary": "Create a new ConversationMessage", "operationId": "ConversationMessage#create", "description": "Outlines the parameters and data fields used when creating a new ConversationMessage", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ConversationMessage_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Conversation Messages", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "document_id": { "type": "integer", "format": "int64", "description": "The document id of the attached document." }, "document_version_id": { "type": "integer", "format": "int64", "description": "The document version id of the attached document." } } }, "body": { "type": "string", "description": "The body value." }, "conversation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Conversation associated with this ConversationMessage." } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the ConversationMessage. The keyword `null` is not valid for this field." } } }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single receiver for this ConversationMessage." }, "type": { "type": "string", "enum": [ "Contact", "User" ], "description": "The type for a single receiver for this ConversationMessage, could be `Contact` or `User`." } }, "required": [ "id", "type" ] } }, "subject": { "type": "string", "description": "The subject value." } }, "required": [ "body", "subject", "receivers" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "document_id": { "type": "integer", "format": "int64", "description": "The document id of the attached document." }, "document_version_id": { "type": "integer", "format": "int64", "description": "The document version id of the attached document." } } }, "body": { "type": "string", "description": "The body value." }, "conversation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Conversation associated with this ConversationMessage." } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the ConversationMessage. The keyword `null` is not valid for this field." } } }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single receiver for this ConversationMessage." }, "type": { "type": "string", "enum": [ "Contact", "User" ], "description": "The type for a single receiver for this ConversationMessage, could be `Contact` or `User`." } }, "required": [ "id", "type" ] } }, "subject": { "type": "string", "description": "The subject value." } }, "required": [ "body", "subject", "receivers" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "document_id": { "type": "integer", "format": "int64", "description": "The document id of the attached document." }, "document_version_id": { "type": "integer", "format": "int64", "description": "The document version id of the attached document." } } }, "body": { "type": "string", "description": "The body value." }, "conversation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Conversation associated with this ConversationMessage." } } }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the ConversationMessage. The keyword `null` is not valid for this field." } } }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single receiver for this ConversationMessage." }, "type": { "type": "string", "enum": [ "Contact", "User" ], "description": "The type for a single receiver for this ConversationMessage, could be `Contact` or `User`." } }, "required": [ "id", "type" ] } }, "subject": { "type": "string", "description": "The subject value." } }, "required": [ "body", "subject", "receivers" ] } } } } }, "required": false } } }, "/conversation_messages/{id}.json": { "get": { "tags": [ "Conversation Messages" ], "summary": "Return the data for a single ConversationMessage", "operationId": "ConversationMessage#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single ConversationMessage", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ConversationMessage.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ConversationMessage_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } } }, "/conversations.json": { "get": { "tags": [ "Conversations" ], "summary": "Return the data for all Conversations", "operationId": "Conversation#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Conversations", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "archived", "in": "query", "description": "Filter archived Conversation records.", "required": false, "schema": { "type": "boolean" } }, { "name": "contact_id", "in": "query", "description": "Filter Conversation records for the contact.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter Conversation records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "date", "in": "query", "description": "Filter Conversation records created on a given date. (Expects an ISO-8601 date).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "for_user", "in": "query", "description": "If set to true, filter Conversation records accessible to any groups of the user.\nNote that the user may not be member of the conversations.\n\nIf set to false, filter Conversation records of which the user is a member.\n", "required": false, "schema": { "type": "boolean" } }, { "name": "ids[]", "in": "query", "description": "Filter Conversation records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Conversation records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. Use the keyword `null` to match those without a Conversation. The list will be filtered to include only the Conversation records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "order", "in": "query", "description": "Orders the Conversation records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "last_message_id(asc)", "last_message_id(desc)", "matter_id(asc)", "matter_id(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "read_status", "in": "query", "description": "Filter Conversation records to those which have been read.", "required": false, "schema": { "type": "boolean" } }, { "name": "time_entries", "in": "query", "description": "Filter Conversation records to those with or without associated time entries.", "required": false, "schema": { "type": "boolean" } }, { "name": "updated_since", "in": "query", "description": "Filter Conversation records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Conversation_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/conversations/{id}.json": { "get": { "tags": [ "Conversations" ], "summary": "Return the data for a single Conversation", "operationId": "Conversation#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Conversation", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Conversation.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Conversation_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Conversations" ], "summary": "Update a single Conversation", "operationId": "Conversation#update", "description": "Outlines the parameters and data fields used when updating a single Conversation", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Conversation.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Conversation_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Conversations", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "archived": { "type": "boolean", "description": "Whether or not the Conversation has been archived." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Conversation. The keyword `null` is not valid for this field." } } }, "read": { "type": "boolean", "description": "Whether or not the Conversation has been read." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "archived": { "type": "boolean", "description": "Whether or not the Conversation has been archived." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Conversation. The keyword `null` is not valid for this field." } } }, "read": { "type": "boolean", "description": "Whether or not the Conversation has been read." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "archived": { "type": "boolean", "description": "Whether or not the Conversation has been archived." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the Conversation. The keyword `null` is not valid for this field." } } }, "read": { "type": "boolean", "description": "Whether or not the Conversation has been read." } } } } } } }, "required": false } } }, "/court_rules/jurisdictions/{jurisdiction_id}/triggers.json": { "get": { "tags": [ "Jurisdictions To Triggers" ], "summary": "Return the data for all triggers", "operationId": "JurisdictionsToTrigger#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all JurisdictionsToTriggers", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter JurisdictionsToTrigger records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter JurisdictionsToTrigger records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "is_requirements_required", "in": "query", "description": "Filter JurisdictionsToTrigger records to those which require addition requirements to be checked (usually specifying trigger time).", "required": false, "schema": { "type": "boolean" } }, { "name": "is_served", "in": "query", "description": "Filter JurisdictionsToTrigger records to those which require a service type to be selected.", "required": false, "schema": { "type": "boolean" } }, { "name": "jurisdiction_id", "in": "path", "description": "The unique identifier for the Jurisdiction.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of JurisdictionsToTrigger records to be returned. Limit can range between 1 and 1000. Default: `1000`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the JurisdictionsToTrigger records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "description(asc)", "description(desc)", "id(asc)", "id(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `description` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter JurisdictionsToTrigger records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JurisdictionsToTrigger_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/court_rules/jurisdictions/{jurisdiction_id}/triggers/{id}.json": { "get": { "tags": [ "Jurisdictions To Triggers" ], "summary": "Return the data for the trigger", "operationId": "JurisdictionsToTrigger#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single JurisdictionsToTrigger", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the JurisdictionsToTrigger.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "jurisdiction_id", "in": "path", "description": "The unique identifier for the Jurisdiction.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JurisdictionsToTrigger_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } } }, "/court_rules/jurisdictions.json": { "get": { "tags": [ "Jurisdictions" ], "summary": "Return the data for all jurisdictions", "operationId": "Jurisdiction#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Jurisdictions", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter Jurisdiction records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "for_current_account", "in": "query", "description": "Filter Jurisdiction records to those set up for this account.", "required": false, "schema": { "type": "boolean" } }, { "name": "ids[]", "in": "query", "description": "Filter Jurisdiction records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Jurisdiction records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the Jurisdiction records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "description(asc)", "description(desc)", "id(asc)", "id(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `description` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter Jurisdiction records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Jurisdiction_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/court_rules/jurisdictions/{id}.json": { "get": { "tags": [ "Jurisdictions" ], "summary": "Return the data for the jurisdiction", "operationId": "Jurisdiction#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Jurisdiction", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Jurisdiction.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Jurisdiction_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } } }, "/court_rules/matter_dockets/preview.json": { "get": { "tags": [ "Matter Dockets" ], "summary": "Preview calendar dates for the docket", "operationId": "MatterDocket#preview", "description": "Preview calendar dates for the docket", "parameters": [ { "name": "event_prefix", "in": "query", "description": "The prefix that will be added to the beginning of all court rule event titles", "required": false, "schema": { "type": "string" } }, { "name": "jurisdiction[id]", "in": "query", "description": "The unique identifier for a single Jurisdiction. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "service_type[id]", "in": "query", "description": "The unique identifier for a single ServiceType. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_date", "in": "query", "description": "The date the MatterDocket should start. (Expects an ISO-8601 date).", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "start_time", "in": "query", "description": "The time the MatterDocket should start. (Expects an ISO-8601 timestamp).", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "trigger[id]", "in": "query", "description": "The unique identifier for a single JurisdictionsToTrigger. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "303": { "description": "See Other" }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/court_rules/matter_dockets.json": { "get": { "tags": [ "Matter Dockets" ], "summary": "Return the data for all matter dockets", "operationId": "MatterDocket#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all MatterDockets", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter MatterDocket records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter MatterDocket records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of MatterDocket records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "matter_status", "in": "query", "description": "Filter MatterDocket records to those with Matters having a specific status.", "required": false, "schema": { "type": "string", "enum": [ "open", "closed", "pending" ] } }, { "name": "order", "in": "query", "description": "Orders the MatterDocket records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "date(asc)", "date(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `name` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "service_type_id", "in": "query", "description": "The unique identifier for a single ServiceType. Use the keyword `null` to match those without a MatterDocket. The list will be filtered to include only the MatterDocket records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "description": "Filter MatterDocket records to those having a specific status.", "required": false, "schema": { "type": "string", "enum": [ "not_started,", "in_progress,", "failed,", "completed" ] } }, { "name": "updated_since", "in": "query", "description": "Filter MatterDocket records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/MatterDocket_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Matter Dockets" ], "summary": "Creates a matter docket", "operationId": "MatterDocket#create", "description": "Outlines the parameters and data fields used when creating a new MatterDocket", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/MatterDocket_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Matter Dockets", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "jurisdiction": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Jurisdiction associated with the MatterDocket. The keyword `null` is not valid for this field." } }, "required": [ "id" ] }, "name": { "type": "string", "description": "Name of the MatterDocket." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the MatterDocket. (Expects an ISO-8601 date)." }, "start_time": { "type": "string", "format": "date-time", "description": "Start time of the MatterDocket. Required for some triggers. (Expects an ISO-8601 timestamp)." }, "trigger": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Trigger associated with the MatterDocket. The keyword `null` is not valid for this field." } }, "required": [ "id" ] } }, "required": [ "jurisdiction", "name", "start_date", "trigger" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "jurisdiction": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Jurisdiction associated with the MatterDocket. The keyword `null` is not valid for this field." } }, "required": [ "id" ] }, "name": { "type": "string", "description": "Name of the MatterDocket." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the MatterDocket. (Expects an ISO-8601 date)." }, "start_time": { "type": "string", "format": "date-time", "description": "Start time of the MatterDocket. Required for some triggers. (Expects an ISO-8601 timestamp)." }, "trigger": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Trigger associated with the MatterDocket. The keyword `null` is not valid for this field." } }, "required": [ "id" ] } }, "required": [ "jurisdiction", "name", "start_date", "trigger" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "jurisdiction": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Jurisdiction associated with the MatterDocket. The keyword `null` is not valid for this field." } }, "required": [ "id" ] }, "name": { "type": "string", "description": "Name of the MatterDocket." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the MatterDocket. (Expects an ISO-8601 date)." }, "start_time": { "type": "string", "format": "date-time", "description": "Start time of the MatterDocket. Required for some triggers. (Expects an ISO-8601 timestamp)." }, "trigger": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Trigger associated with the MatterDocket. The keyword `null` is not valid for this field." } }, "required": [ "id" ] } }, "required": [ "jurisdiction", "name", "start_date", "trigger" ] } } } } }, "required": false } } }, "/court_rules/matter_dockets/{id}.json": { "get": { "tags": [ "Matter Dockets" ], "summary": "Return the data for the matter docket", "operationId": "MatterDocket#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single MatterDocket", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the MatterDocket.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/MatterDocket_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "delete": { "tags": [ "Matter Dockets" ], "summary": "Deletes the requested matter docket", "operationId": "MatterDocket#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single MatterDocket", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the MatterDocket.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/court_rules/service_types.json": { "get": { "tags": [ "Service Types" ], "summary": "Return the data for all service types", "operationId": "ServiceType#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all ServiceTypes", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter ServiceType records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter ServiceType records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of ServiceType records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the ServiceType records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "description(asc)", "description(desc)", "id(asc)", "id(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter ServiceType records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceType_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/court_rules/service_types/{id}.json": { "get": { "tags": [ "Service Types" ], "summary": "Return the data for the service type", "operationId": "ServiceType#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single ServiceType", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ServiceType.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceType_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } } }, "/credit_memos.json": { "get": { "tags": [ "Credit Memos" ], "summary": "Return the data for all CreditMemos", "operationId": "CreditMemo#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all CreditMemos", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the CreditMemo records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter CreditMemo records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter CreditMemo records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of CreditMemo records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the CreditMemo records by the given field. Default: `date(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "date(asc)", "date(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter CreditMemo records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreditMemo_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/credit_memos/{id}.json": { "get": { "tags": [ "Credit Memos" ], "summary": "Return the data for a single CreditMemo", "operationId": "CreditMemo#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single CreditMemo", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CreditMemo.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreditMemo_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } } }, "/currencies.json": { "get": { "tags": [ "Currencies" ], "summary": "Return the data for all Currencies", "operationId": "Currency#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Currencies", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter Currency records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter Currency records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Currency records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter Currency records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Currency_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/custom_fields.json": { "get": { "tags": [ "Custom Fields" ], "summary": "Return the data for all CustomFields", "operationId": "CustomField#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all CustomFields", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter CustomField records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "deleted", "in": "query", "description": "Filter CustomField records to those that have been deleted for future use.", "required": false, "schema": { "type": "boolean" } }, { "name": "field_type", "in": "query", "description": "Field type of this custom field", "required": false, "schema": { "type": "string", "enum": [ "checkbox", "contact", "currency", "date", "time", "email", "matter", "numeric", "picklist", "text_area", "text_line", "url" ] } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter CustomField records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of CustomField records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the CustomField records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "name(asc)", "name(desc)", "display_order(asc)", "display_order(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "parent_type", "in": "query", "description": "Filter CustomField records to those that have the specified `parent_type`.", "required": false, "schema": { "type": "string", "enum": [ "matter", "contact" ] } }, { "name": "query", "in": "query", "description": "Wildcard search for `name` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter CustomField records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "visible_and_required", "in": "query", "description": "Filter CustomField records to those that are visible and required.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomField_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Custom Fields" ], "summary": "Create a new CustomField", "operationId": "CustomField#create", "description": "Outlines the parameters and data fields used when creating a new CustomField", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomField_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Custom Fields", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int32", "description": "The display position of the CustomField." }, "displayed": { "type": "boolean", "default": true, "description": "Whether or not the CustomField should be displayed by default." }, "field_type": { "type": "string", "enum": [ "checkbox", "contact", "currency", "date", "time", "email", "matter", "numeric", "picklist", "text_area", "text_line", "url" ], "description": "Field type of the CustomField." }, "name": { "type": "string", "description": "CustomField name." }, "parent_type": { "type": "string", "enum": [ "Contact", "Matter" ], "description": "Type of object the CustomField is for." }, "picklist_options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single PicklistOption associated with the CustomField. The keyword `null` is not valid for this field. Not required for creating new PicklistOptions, but required for updating or deleting existing ones." }, "option": { "type": "string", "description": "The option value." }, "_deleted": { "type": "boolean", "description": "Whether or not the PicklistOption should be deleted." } } } }, "required": { "type": "boolean", "default": false, "description": "Whether or not the CustomField should require a value." } }, "required": [ "name", "parent_type", "field_type" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int32", "description": "The display position of the CustomField." }, "displayed": { "type": "boolean", "default": true, "description": "Whether or not the CustomField should be displayed by default." }, "field_type": { "type": "string", "enum": [ "checkbox", "contact", "currency", "date", "time", "email", "matter", "numeric", "picklist", "text_area", "text_line", "url" ], "description": "Field type of the CustomField." }, "name": { "type": "string", "description": "CustomField name." }, "parent_type": { "type": "string", "enum": [ "Contact", "Matter" ], "description": "Type of object the CustomField is for." }, "picklist_options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single PicklistOption associated with the CustomField. The keyword `null` is not valid for this field. Not required for creating new PicklistOptions, but required for updating or deleting existing ones." }, "option": { "type": "string", "description": "The option value." }, "_deleted": { "type": "boolean", "description": "Whether or not the PicklistOption should be deleted." } } } }, "required": { "type": "boolean", "default": false, "description": "Whether or not the CustomField should require a value." } }, "required": [ "name", "parent_type", "field_type" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int32", "description": "The display position of the CustomField." }, "displayed": { "type": "boolean", "default": true, "description": "Whether or not the CustomField should be displayed by default." }, "field_type": { "type": "string", "enum": [ "checkbox", "contact", "currency", "date", "time", "email", "matter", "numeric", "picklist", "text_area", "text_line", "url" ], "description": "Field type of the CustomField." }, "name": { "type": "string", "description": "CustomField name." }, "parent_type": { "type": "string", "enum": [ "Contact", "Matter" ], "description": "Type of object the CustomField is for." }, "picklist_options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single PicklistOption associated with the CustomField. The keyword `null` is not valid for this field. Not required for creating new PicklistOptions, but required for updating or deleting existing ones." }, "option": { "type": "string", "description": "The option value." }, "_deleted": { "type": "boolean", "description": "Whether or not the PicklistOption should be deleted." } } } }, "required": { "type": "boolean", "default": false, "description": "Whether or not the CustomField should require a value." } }, "required": [ "name", "parent_type", "field_type" ] } } } } }, "required": false } } }, "/custom_fields/{id}.json": { "get": { "tags": [ "Custom Fields" ], "summary": "Return the data for a single CustomField", "operationId": "CustomField#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single CustomField", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CustomField.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomField_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Custom Fields" ], "summary": "Update a single CustomField", "operationId": "CustomField#update", "description": "Outlines the parameters and data fields used when updating a single CustomField", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CustomField.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomField_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Custom Fields", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int32", "description": "The display position of the CustomField." }, "displayed": { "type": "boolean", "default": true, "description": "Whether or not the CustomField should be displayed by default." }, "name": { "type": "string", "description": "CustomField name." }, "picklist_options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single PicklistOption associated with the CustomField. The keyword `null` is not valid for this field. Not required for creating new PicklistOptions, but required for updating or deleting existing ones." }, "option": { "type": "string", "description": "The option value." }, "_deleted": { "type": "boolean", "description": "Whether or not the PicklistOption should be deleted." } } } }, "required": { "type": "boolean", "default": false, "description": "Whether or not the CustomField should require a value." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int32", "description": "The display position of the CustomField." }, "displayed": { "type": "boolean", "default": true, "description": "Whether or not the CustomField should be displayed by default." }, "name": { "type": "string", "description": "CustomField name." }, "picklist_options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single PicklistOption associated with the CustomField. The keyword `null` is not valid for this field. Not required for creating new PicklistOptions, but required for updating or deleting existing ones." }, "option": { "type": "string", "description": "The option value." }, "_deleted": { "type": "boolean", "description": "Whether or not the PicklistOption should be deleted." } } } }, "required": { "type": "boolean", "default": false, "description": "Whether or not the CustomField should require a value." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int32", "description": "The display position of the CustomField." }, "displayed": { "type": "boolean", "default": true, "description": "Whether or not the CustomField should be displayed by default." }, "name": { "type": "string", "description": "CustomField name." }, "picklist_options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single PicklistOption associated with the CustomField. The keyword `null` is not valid for this field. Not required for creating new PicklistOptions, but required for updating or deleting existing ones." }, "option": { "type": "string", "description": "The option value." }, "_deleted": { "type": "boolean", "description": "Whether or not the PicklistOption should be deleted." } } } }, "required": { "type": "boolean", "default": false, "description": "Whether or not the CustomField should require a value." } } } } } } }, "required": false } }, "delete": { "tags": [ "Custom Fields" ], "summary": "Delete a single CustomField", "operationId": "CustomField#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single CustomField", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CustomField.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/custom_field_sets.json": { "get": { "tags": [ "Custom Field Sets" ], "summary": "Return the data for all CustomFieldSets", "operationId": "CustomFieldSet#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all CustomFieldSets", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter CustomFieldSet records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "displayed", "in": "query", "description": "Filter CustomFieldSet records to those that should be displayed by default.", "required": false, "schema": { "type": "boolean" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter CustomFieldSet records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of CustomFieldSet records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the CustomFieldSet records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "name(asc)", "name(desc)", "id(asc)", "id(desc)", "parent_type(asc)", "parent_type(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "parent_type", "in": "query", "description": "Filter CustomFieldSet records to those that have the specified `parent_type`.", "required": false, "schema": { "type": "string", "enum": [ "Matter", "Contact" ] } }, { "name": "query", "in": "query", "description": "Wildcard search for `name` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter CustomFieldSet records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomFieldSet_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Custom Field Sets" ], "summary": "Create a new CustomFieldSet", "operationId": "CustomFieldSet#create", "description": "Outlines the parameters and data fields used when creating a new CustomFieldSet", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomFieldSet_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Custom Field Sets", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "custom_field_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The unique identifiers of the custom fields associated with the CustomFieldSet." }, "displayed": { "type": "boolean", "description": "Whether or not the CustomFieldSet should be displayed by default." }, "name": { "type": "string", "description": "CustomFieldSet name." }, "parent_type": { "type": "string", "enum": [ "Contact", "Matter" ], "description": "Type of object the CustomFieldSet is for." } }, "required": [ "name" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "custom_field_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The unique identifiers of the custom fields associated with the CustomFieldSet." }, "displayed": { "type": "boolean", "description": "Whether or not the CustomFieldSet should be displayed by default." }, "name": { "type": "string", "description": "CustomFieldSet name." }, "parent_type": { "type": "string", "enum": [ "Contact", "Matter" ], "description": "Type of object the CustomFieldSet is for." } }, "required": [ "name" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "custom_field_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The unique identifiers of the custom fields associated with the CustomFieldSet." }, "displayed": { "type": "boolean", "description": "Whether or not the CustomFieldSet should be displayed by default." }, "name": { "type": "string", "description": "CustomFieldSet name." }, "parent_type": { "type": "string", "enum": [ "Contact", "Matter" ], "description": "Type of object the CustomFieldSet is for." } }, "required": [ "name" ] } } } } }, "required": false } } }, "/custom_field_sets/{id}.json": { "get": { "tags": [ "Custom Field Sets" ], "summary": "Return the data for a single CustomFieldSet", "operationId": "CustomFieldSet#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single CustomFieldSet", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CustomFieldSet.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomFieldSet_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Custom Field Sets" ], "summary": "Update a single CustomFieldSet", "operationId": "CustomFieldSet#update", "description": "Outlines the parameters and data fields used when updating a single CustomFieldSet", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CustomFieldSet.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomFieldSet_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Custom Field Sets", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "custom_field_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The unique identifiers of the custom fields associated with the CustomFieldSet." }, "displayed": { "type": "boolean", "description": "Whether or not the CustomFieldSet should be displayed by default." }, "name": { "type": "string", "description": "CustomFieldSet name." }, "parent_type": { "type": "string", "enum": [ "Contact", "Matter" ], "description": "Type of object the CustomFieldSet is for." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "custom_field_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The unique identifiers of the custom fields associated with the CustomFieldSet." }, "displayed": { "type": "boolean", "description": "Whether or not the CustomFieldSet should be displayed by default." }, "name": { "type": "string", "description": "CustomFieldSet name." }, "parent_type": { "type": "string", "enum": [ "Contact", "Matter" ], "description": "Type of object the CustomFieldSet is for." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "custom_field_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The unique identifiers of the custom fields associated with the CustomFieldSet." }, "displayed": { "type": "boolean", "description": "Whether or not the CustomFieldSet should be displayed by default." }, "name": { "type": "string", "description": "CustomFieldSet name." }, "parent_type": { "type": "string", "enum": [ "Contact", "Matter" ], "description": "Type of object the CustomFieldSet is for." } } } } } } }, "required": false } }, "delete": { "tags": [ "Custom Field Sets" ], "summary": "Delete a single CustomFieldSet", "operationId": "CustomFieldSet#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single CustomFieldSet", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CustomFieldSet.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/custom_actions.json": { "get": { "tags": [ "Custom Actions" ], "summary": "Return the data for all CustomActions", "operationId": "CustomAction#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all CustomActions", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter CustomAction records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter CustomAction records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of CustomAction records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter CustomAction records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomAction_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Custom Actions" ], "summary": "Create a new CustomAction", "operationId": "CustomAction#create", "description": "Outlines the parameters and data fields used when creating a new CustomAction", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomAction_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Custom Actions", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "label": { "type": "string", "description": "Text label to be displayed on the custom link." }, "target_url": { "type": "string", "description": "Target URL which will be opened in a new tab when the user clicks the custom link." }, "ui_reference": { "type": "string", "enum": [ "activities/show", "documents/show", "contacts/show", "matters/show", "folders/show" ], "description": "UI reference location within Clio where the link will be displayed." } }, "required": [ "label", "target_url", "ui_reference" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "label": { "type": "string", "description": "Text label to be displayed on the custom link." }, "target_url": { "type": "string", "description": "Target URL which will be opened in a new tab when the user clicks the custom link." }, "ui_reference": { "type": "string", "enum": [ "activities/show", "documents/show", "contacts/show", "matters/show", "folders/show" ], "description": "UI reference location within Clio where the link will be displayed." } }, "required": [ "label", "target_url", "ui_reference" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "label": { "type": "string", "description": "Text label to be displayed on the custom link." }, "target_url": { "type": "string", "description": "Target URL which will be opened in a new tab when the user clicks the custom link." }, "ui_reference": { "type": "string", "enum": [ "activities/show", "documents/show", "contacts/show", "matters/show", "folders/show" ], "description": "UI reference location within Clio where the link will be displayed." } }, "required": [ "label", "target_url", "ui_reference" ] } } } } }, "required": false } } }, "/custom_actions/{id}.json": { "get": { "tags": [ "Custom Actions" ], "summary": "Return the data for a single CustomAction", "operationId": "CustomAction#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single CustomAction", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CustomAction.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomAction_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Custom Actions" ], "summary": "Update a single CustomAction", "operationId": "CustomAction#update", "description": "Outlines the parameters and data fields used when updating a single CustomAction", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CustomAction.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomAction_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Custom Actions", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "label": { "type": "string", "description": "Text label to be displayed on the custom link." }, "target_url": { "type": "string", "description": "Target URL which will be opened in a new tab when the user clicks the custom link." }, "ui_reference": { "type": "string", "enum": [ "activities/show", "documents/show", "contacts/show", "matters/show", "folders/show" ], "description": "UI reference location within Clio where the link will be displayed." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "label": { "type": "string", "description": "Text label to be displayed on the custom link." }, "target_url": { "type": "string", "description": "Target URL which will be opened in a new tab when the user clicks the custom link." }, "ui_reference": { "type": "string", "enum": [ "activities/show", "documents/show", "contacts/show", "matters/show", "folders/show" ], "description": "UI reference location within Clio where the link will be displayed." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "label": { "type": "string", "description": "Text label to be displayed on the custom link." }, "target_url": { "type": "string", "description": "Target URL which will be opened in a new tab when the user clicks the custom link." }, "ui_reference": { "type": "string", "enum": [ "activities/show", "documents/show", "contacts/show", "matters/show", "folders/show" ], "description": "UI reference location within Clio where the link will be displayed." } } } } } } }, "required": false } }, "delete": { "tags": [ "Custom Actions" ], "summary": "Delete a single CustomAction", "operationId": "CustomAction#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single CustomAction", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the CustomAction.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/damages.json": { "get": { "tags": [ "Damages" ], "summary": "Return the data for all Damages", "operationId": "Damage#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Damages", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter Damage records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter Damage records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Damage records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter Damage records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Damage_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Damages" ], "summary": "Creating a Damage", "operationId": "Damage#create", "description": "Outlines the parameters and data fields used when creating a new Damage", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Damage_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Damages", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Amount" }, "damage_type": { "type": "string", "enum": [ "special", "general", "other" ], "description": "Damage type" }, "description": { "type": "string", "description": "Description" }, "matter_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the Matter to which the Damage is associated." } }, "required": [ "amount", "damage_type", "description", "matter_id" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Amount" }, "damage_type": { "type": "string", "enum": [ "special", "general", "other" ], "description": "Damage type" }, "description": { "type": "string", "description": "Description" }, "matter_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the Matter to which the Damage is associated." } }, "required": [ "amount", "damage_type", "description", "matter_id" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Amount" }, "damage_type": { "type": "string", "enum": [ "special", "general", "other" ], "description": "Damage type" }, "description": { "type": "string", "description": "Description" }, "matter_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the Matter to which the Damage is associated." } }, "required": [ "amount", "damage_type", "description", "matter_id" ] } } } } }, "required": false } } }, "/damages/{id}.json": { "get": { "tags": [ "Damages" ], "summary": "Return a specific Damage", "operationId": "Damage#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Damage", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Damage.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Damage_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Damages" ], "summary": "Updating a Damage", "operationId": "Damage#update", "description": "Outlines the parameters and data fields used when updating a single Damage", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Damage.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Damage_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Damages", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Amount" }, "damage_type": { "type": "string", "enum": [ "special", "general", "other" ], "description": "Damage type" }, "description": { "type": "string", "description": "Description" } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Amount" }, "damage_type": { "type": "string", "enum": [ "special", "general", "other" ], "description": "Damage type" }, "description": { "type": "string", "description": "Description" } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Amount" }, "damage_type": { "type": "string", "enum": [ "special", "general", "other" ], "description": "Damage type" }, "description": { "type": "string", "description": "Description" } } } } } } }, "required": false } }, "delete": { "tags": [ "Damages" ], "summary": "Deleting a Damage", "operationId": "Damage#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single Damage", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Damage.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/expense_categories.json": { "get": { "tags": [ "Expense Categories" ], "summary": "Return the data for all ExpenseCategories", "operationId": "ExpenseCategory#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all ExpenseCategories", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter ExpenseCategory records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "entry_type", "in": "query", "description": "Filter ExpenseCategory records to those that match the given type.", "required": false, "schema": { "type": "string", "enum": [ "hard_cost", "soft_cost", "unassociated" ] } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "A limit on the number of ExpenseCategory records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the ExpenseCategory records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "name(asc)", "name(desc)", "rate(asc)", "rate(desc)", "entry_type(asc)", "entry_type(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Allows matching search on expense category name.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter ExpenseCategory records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExpenseCategory_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Expense Categories" ], "summary": "Create a new ExpenseCategory", "operationId": "ExpenseCategory#create", "description": "Outlines the parameters and data fields used when creating a new ExpenseCategory", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExpenseCategory_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Expense Categories", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the Expense Category." }, "entry_type": { "type": "string", "enum": [ "hard_cost", "soft_cost", "unassociated" ], "description": "Defaults to unassociated." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ExpenseCategory. The keyword `null` is not valid for this field." }, "_deleted": { "type": "boolean", "description": "A flag to determine if this Group should lose access to this ExpenseCategory." } } } }, "name": { "type": "string", "description": "Name of the Expense Category." }, "rate": { "type": "number", "format": "double", "description": "Rate of the Expense Category, default is null." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration associated with the tax setting." }, "order": { "type": "integer", "format": "int32", "description": "The order that the tax setting should be applied in." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule that the tax setting should be applied in." } }, "required": [ "tax_rate_configuration_id", "order" ] }, "description": "Array of objects, with each object representing a tax setting with 'tax_rate_configuration_id', 'order', and 'rule' properties." }, "utbms_code": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsCode associated with the ExpenseCategory. The keyword `null` is not valid for this field." } } } }, "required": [ "name" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the Expense Category." }, "entry_type": { "type": "string", "enum": [ "hard_cost", "soft_cost", "unassociated" ], "description": "Defaults to unassociated." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ExpenseCategory. The keyword `null` is not valid for this field." }, "_deleted": { "type": "boolean", "description": "A flag to determine if this Group should lose access to this ExpenseCategory." } } } }, "name": { "type": "string", "description": "Name of the Expense Category." }, "rate": { "type": "number", "format": "double", "description": "Rate of the Expense Category, default is null." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration associated with the tax setting." }, "order": { "type": "integer", "format": "int32", "description": "The order that the tax setting should be applied in." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule that the tax setting should be applied in." } }, "required": [ "tax_rate_configuration_id", "order" ] }, "description": "Array of objects, with each object representing a tax setting with 'tax_rate_configuration_id', 'order', and 'rule' properties." }, "utbms_code": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsCode associated with the ExpenseCategory. The keyword `null` is not valid for this field." } } } }, "required": [ "name" ] } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the Expense Category." }, "entry_type": { "type": "string", "enum": [ "hard_cost", "soft_cost", "unassociated" ], "description": "Defaults to unassociated." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ExpenseCategory. The keyword `null` is not valid for this field." }, "_deleted": { "type": "boolean", "description": "A flag to determine if this Group should lose access to this ExpenseCategory." } } } }, "name": { "type": "string", "description": "Name of the Expense Category." }, "rate": { "type": "number", "format": "double", "description": "Rate of the Expense Category, default is null." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration associated with the tax setting." }, "order": { "type": "integer", "format": "int32", "description": "The order that the tax setting should be applied in." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule that the tax setting should be applied in." } }, "required": [ "tax_rate_configuration_id", "order" ] }, "description": "Array of objects, with each object representing a tax setting with 'tax_rate_configuration_id', 'order', and 'rule' properties." }, "utbms_code": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsCode associated with the ExpenseCategory. The keyword `null` is not valid for this field." } } } }, "required": [ "name" ] } } } } }, "required": false } } }, "/expense_categories/{id}.json": { "get": { "tags": [ "Expense Categories" ], "summary": "Return the data for a single ExpenseCategory", "operationId": "ExpenseCategory#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single ExpenseCategory", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ExpenseCategory.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExpenseCategory_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Expense Categories" ], "summary": "Update a single ExpenseCategory", "operationId": "ExpenseCategory#update", "description": "Outlines the parameters and data fields used when updating a single ExpenseCategory", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ExpenseCategory.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExpenseCategory_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Expense Categories", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the Expense Category." }, "entry_type": { "type": "string", "enum": [ "hard_cost", "soft_cost", "unassociated" ], "description": "Defaults to unassociated." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ExpenseCategory. The keyword `null` is not valid for this field." }, "_deleted": { "type": "boolean", "description": "A flag to determine if this Group should lose access to this ExpenseCategory." } } } }, "name": { "type": "string", "description": "Name of the Expense Category." }, "rate": { "type": "number", "format": "double", "description": "Rate of the Expense Category, default is null." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration associated with the tax setting." }, "order": { "type": "integer", "format": "int32", "description": "The order that the tax setting should be applied in." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule that the tax setting should be applied in." } } }, "description": "Array of objects, with each object representing a tax setting with 'tax_rate_configuration_id', 'order', and 'rule' properties." }, "utbms_code": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsCode associated with the ExpenseCategory. The keyword `null` is not valid for this field." } } } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the Expense Category." }, "entry_type": { "type": "string", "enum": [ "hard_cost", "soft_cost", "unassociated" ], "description": "Defaults to unassociated." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ExpenseCategory. The keyword `null` is not valid for this field." }, "_deleted": { "type": "boolean", "description": "A flag to determine if this Group should lose access to this ExpenseCategory." } } } }, "name": { "type": "string", "description": "Name of the Expense Category." }, "rate": { "type": "number", "format": "double", "description": "Rate of the Expense Category, default is null." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration associated with the tax setting." }, "order": { "type": "integer", "format": "int32", "description": "The order that the tax setting should be applied in." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule that the tax setting should be applied in." } } }, "description": "Array of objects, with each object representing a tax setting with 'tax_rate_configuration_id', 'order', and 'rule' properties." }, "utbms_code": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsCode associated with the ExpenseCategory. The keyword `null` is not valid for this field." } } } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "currency": { "type": "object", "description": "Currency of the Expense Category." }, "entry_type": { "type": "string", "enum": [ "hard_cost", "soft_cost", "unassociated" ], "description": "Defaults to unassociated." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Group associated with the ExpenseCategory. The keyword `null` is not valid for this field." }, "_deleted": { "type": "boolean", "description": "A flag to determine if this Group should lose access to this ExpenseCategory." } } } }, "name": { "type": "string", "description": "Name of the Expense Category." }, "rate": { "type": "number", "format": "double", "description": "Rate of the Expense Category, default is null." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration associated with the tax setting." }, "order": { "type": "integer", "format": "int32", "description": "The order that the tax setting should be applied in." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule that the tax setting should be applied in." } } }, "description": "Array of objects, with each object representing a tax setting with 'tax_rate_configuration_id', 'order', and 'rule' properties." }, "utbms_code": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single UtbmsCode associated with the ExpenseCategory. The keyword `null` is not valid for this field." } } } } } } } } }, "required": false } }, "delete": { "tags": [ "Expense Categories" ], "summary": "Delete a single ExpenseCategory", "operationId": "ExpenseCategory#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single ExpenseCategory", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the ExpenseCategory.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/grants.json": { "get": { "tags": [ "Grants" ], "summary": "Return the data for all grants", "operationId": "Grant#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Grants", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter Grant records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter Grant records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Grant records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Filter Grant records to those that match the given name.", "required": false, "schema": { "type": "string" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter Grant records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Grant_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Grants" ], "summary": "Create a new grant", "operationId": "Grant#create", "description": "Outlines the parameters and data fields used when creating a new Grant", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Grant_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Grants", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Grant." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Grant." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Grant." } } } } } } }, "required": false } } }, "/grants/{id}.json": { "get": { "tags": [ "Grants" ], "summary": "Return the data for a single grant", "operationId": "Grant#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Grant", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Grant.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Grant_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Grants" ], "summary": "Update a single grant", "operationId": "Grant#update", "description": "Outlines the parameters and data fields used when updating a single Grant", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Grant.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Grant_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Grants", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Grant." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Grant." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Grant." } } } } } } }, "required": false } }, "delete": { "tags": [ "Grants" ], "summary": "Deletes a single grant", "operationId": "Grant#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single Grant", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Grant.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/grant_funding_sources.json": { "get": { "tags": [ "Grant Funding Sources" ], "summary": "Return the data for all grant funding sources", "operationId": "GrantFundingSource#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all GrantFundingSources", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter GrantFundingSource records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter GrantFundingSource records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of GrantFundingSource records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Filter GrantFundingSource records to those that match the given name.", "required": false, "schema": { "type": "string" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter GrantFundingSource records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/GrantFundingSource_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Grant Funding Sources" ], "summary": "Create a new grant funding source", "operationId": "GrantFundingSource#create", "description": "Outlines the parameters and data fields used when creating a new GrantFundingSource", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/GrantFundingSource_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Grant Funding Sources", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the GrantFundingSource." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the GrantFundingSource." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the GrantFundingSource." } } } } } } }, "required": false } } }, "/grant_funding_sources/{id}.json": { "patch": { "tags": [ "Grant Funding Sources" ], "summary": "Update a single grant funding source", "operationId": "GrantFundingSource#update", "description": "Outlines the parameters and data fields used when updating a single GrantFundingSource", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the GrantFundingSource.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/GrantFundingSource_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Grant Funding Sources", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the GrantFundingSource." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the GrantFundingSource." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the GrantFundingSource." } } } } } } }, "required": false } }, "delete": { "tags": [ "Grant Funding Sources" ], "summary": "Delete a single grant funding source", "operationId": "GrantFundingSource#destroy", "description": "Outlines the parameters and data fields used when updating a single GrantFundingSource", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the GrantFundingSource.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/GrantFundingSource_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Grant Funding Sources", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the GrantFundingSource." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the GrantFundingSource." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the GrantFundingSource." } } } } } } }, "required": false } } }, "/groups.json": { "get": { "tags": [ "Groups" ], "summary": "Return the data for all Groups", "operationId": "Group#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Groups", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "archived", "in": "query", "description": "Filter archived Group records.", "required": false, "schema": { "type": "boolean" } }, { "name": "created_since", "in": "query", "description": "Filter Group records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter Group records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Group records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Filter Group records to those that match the given name.", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Orders the Group records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "name(asc)", "name(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `name` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Filter Group records to those that match the given type.", "required": false, "schema": { "type": "string", "enum": [ "AccountGroup", "AdhocGroup", "UserGroup" ] } }, { "name": "updated_since", "in": "query", "description": "Filter Group records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "user_id", "in": "query", "description": "The unique identifier for a single User. The keyword `null` is not valid for this field. The list will be filtered to include only the Group records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Group_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Groups" ], "summary": "Create a new Group", "operationId": "Group#create", "description": "Outlines the parameters and data fields used when creating a new Group", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Group_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Groups", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Group." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Group." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Group." } } } } } } }, "required": false } } }, "/groups/{id}.json": { "get": { "tags": [ "Groups" ], "summary": "Return the data for a single Group", "operationId": "Group#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Group", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Group.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Group_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } }, "patch": { "tags": [ "Groups" ], "summary": "Update a single Group", "operationId": "Group#update", "description": "Outlines the parameters and data fields used when updating a single Group", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Group.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Group_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Groups", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Group." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Group." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Group." } } } } } } }, "required": false } }, "delete": { "tags": [ "Groups" ], "summary": "Delete a single Group", "operationId": "Group#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single Group", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the Group.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/internal_notifications/event_metrics.json": { "get": { "tags": [ "Event Metrics" ], "summary": "Unread in-app notification events", "operationId": "EventMetrics#index", "description": "Outlines the parameters, optional and required, used when requesting Event Metrics", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventMetrics_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/internal_notifications/my_events.json": { "get": { "tags": [ "My Events" ], "summary": "Return the data for all of my in-app notification events", "operationId": "MyEvent#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all MyEvents", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "A limit on the number of MyEvent records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/MyEvent_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/internal_notifications/my_events/{id}.json": { "patch": { "tags": [ "My Events" ], "summary": "Mark a single in-app notification event as read/unread", "operationId": "MyEvent#update", "description": "Outlines the parameters and data fields used when updating a single MyEvent", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the MyEvent.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/MyEvent_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for My Events", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "marked_as_read": { "type": "boolean", "description": "Indicates whether the event notification should be marked as read by the current user. If `false` the event status is reset to unread." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "marked_as_read": { "type": "boolean", "description": "Indicates whether the event notification should be marked as read by the current user. If `false` the event status is reset to unread." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "marked_as_read": { "type": "boolean", "description": "Indicates whether the event notification should be marked as read by the current user. If `false` the event status is reset to unread." } } } } } } }, "required": false } }, "delete": { "tags": [ "My Events" ], "summary": "Clear (delete) a single in-app notification event", "operationId": "MyEvent#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single MyEvent", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the MyEvent.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/interest_charges.json": { "get": { "tags": [ "Interest Charges" ], "summary": "Return the data for all InterestCharges", "operationId": "InterestCharge#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all InterestCharges", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "bill_id", "in": "query", "description": "The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the InterestCharge records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter InterestCharge records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "exclude_ids[]", "in": "query", "description": "Array containing *InterestCharge* identifiers that should be excluded from the query.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter InterestCharge records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of InterestCharge records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter InterestCharge records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InterestCharge_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/interest_charges/{id}.json": { "delete": { "tags": [ "Interest Charges" ], "summary": "Delete a single InterestCharge", "operationId": "InterestCharge#destroy", "description": "Outlines the parameters, optional and required, used when deleting the record for a single InterestCharge", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the InterestCharge.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/line_items.json": { "get": { "tags": [ "Line Items" ], "summary": "Return the data for all LineItems", "operationId": "LineItem#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all LineItems", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "activity_id", "in": "query", "description": "The unique identifier for a single Activity. Use the keyword `null` to match those without a LineItem. The list will be filtered to include only the LineItem records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "bill_id", "in": "query", "description": "The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the LineItem records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_since", "in": "query", "description": "Filter LineItem records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "display", "in": "query", "description": "Set this flag to true to return only LineItems displayed on the bill.", "required": false, "schema": { "type": "boolean" } }, { "name": "exclude_ids[]", "in": "query", "description": "Array containing LineItem identifiers that should be excluded from the query.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "group_ordering", "in": "query", "description": "Filters LineItem records to match given group ordering.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "ids[]", "in": "query", "description": "Filter LineItem records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "kind", "in": "query", "description": "The kind of LineItem.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "A limit on the number of LineItem records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "query", "description": "The unique identifier for a single Matter. Use the keyword `null` to match those without a LineItem. The list will be filtered to include only the LineItem records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Wildcard search for `description` or `note` matching a given string.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter LineItem records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/LineItem_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/line_items/{id}.json": { "patch": { "tags": [ "Line Items" ], "summary": "Update a single LineItem", "operationId": "LineItem#update", "description": "Outlines the parameters and data fields used when updating a single LineItem", "parameters": [ { "name": "IF-MATCH", "in": "header", "description": "The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the LineItem.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/LineItem_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "description": "Request Body for Line Items", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "activity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Activity associated with the LineItem. The keyword `null` is not valid for this field." } } }, "bill": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Bill associated with the LineItem. The keyword `null` is not valid for this field." } } }, "date": { "type": "string", "format": "date", "description": "The LineItem date." }, "description": { "type": "string", "description": "Description of the LineItem." }, "discount": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Discount rate for the LineItem." }, "type": { "type": "boolean", "description": "Discount type. This should be set to one of: 'percentage' or 'money'." } } }, "group_ordering": { "type": "integer", "format": "int32", "description": "The LineItem group ordering." }, "kind": { "type": "string", "enum": [ "Expense", "Service", "Product" ], "description": "The specific type of activity which is associated with the LineItem." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the LineItem. The keyword `null` is not valid for this field." } } }, "note": { "type": "string", "description": "The note attached to the LineItem." }, "price": { "type": "number", "format": "double", "description": "The price of the LineItem." }, "quantity": { "type": "number", "format": "double", "description": "Quantity of the LineItem." }, "secondary_taxable": { "type": "boolean", "description": "Whether the LineItem is secondary taxable." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration associated with the tax setting." }, "order": { "type": "integer", "format": "int32", "description": "The order that the tax setting should be applied in." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule that the tax setting should be applied in." } } }, "description": "Array of objects, with each object representing a tax setting with 'tax_rate_configuration_id', 'order', and 'rule' properties." }, "taxable": { "type": "boolean", "description": "Whether the LineItem taxable." }, "update_original_record": { "type": "boolean", "description": "Whether the associated activity will be updated." } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "activity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Activity associated with the LineItem. The keyword `null` is not valid for this field." } } }, "bill": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Bill associated with the LineItem. The keyword `null` is not valid for this field." } } }, "date": { "type": "string", "format": "date", "description": "The LineItem date." }, "description": { "type": "string", "description": "Description of the LineItem." }, "discount": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Discount rate for the LineItem." }, "type": { "type": "boolean", "description": "Discount type. This should be set to one of: 'percentage' or 'money'." } } }, "group_ordering": { "type": "integer", "format": "int32", "description": "The LineItem group ordering." }, "kind": { "type": "string", "enum": [ "Expense", "Service", "Product" ], "description": "The specific type of activity which is associated with the LineItem." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the LineItem. The keyword `null` is not valid for this field." } } }, "note": { "type": "string", "description": "The note attached to the LineItem." }, "price": { "type": "number", "format": "double", "description": "The price of the LineItem." }, "quantity": { "type": "number", "format": "double", "description": "Quantity of the LineItem." }, "secondary_taxable": { "type": "boolean", "description": "Whether the LineItem is secondary taxable." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration associated with the tax setting." }, "order": { "type": "integer", "format": "int32", "description": "The order that the tax setting should be applied in." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule that the tax setting should be applied in." } } }, "description": "Array of objects, with each object representing a tax setting with 'tax_rate_configuration_id', 'order', and 'rule' properties." }, "taxable": { "type": "boolean", "description": "Whether the LineItem taxable." }, "update_original_record": { "type": "boolean", "description": "Whether the associated activity will be updated." } } } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "activity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Activity associated with the LineItem. The keyword `null` is not valid for this field." } } }, "bill": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Bill associated with the LineItem. The keyword `null` is not valid for this field." } } }, "date": { "type": "string", "format": "date", "description": "The LineItem date." }, "description": { "type": "string", "description": "Description of the LineItem." }, "discount": { "type": "object", "properties": { "rate": { "type": "number", "format": "double", "description": "Discount rate for the LineItem." }, "type": { "type": "boolean", "description": "Discount type. This should be set to one of: 'percentage' or 'money'." } } }, "group_ordering": { "type": "integer", "format": "int32", "description": "The LineItem group ordering." }, "kind": { "type": "string", "enum": [ "Expense", "Service", "Product" ], "description": "The specific type of activity which is associated with the LineItem." }, "matter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier for a single Matter associated with the LineItem. The keyword `null` is not valid for this field." } } }, "note": { "type": "string", "description": "The note attached to the LineItem." }, "price": { "type": "number", "format": "double", "description": "The price of the LineItem." }, "quantity": { "type": "number", "format": "double", "description": "Quantity of the LineItem." }, "secondary_taxable": { "type": "boolean", "description": "Whether the LineItem is secondary taxable." }, "tax_settings": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_configuration_id": { "type": "integer", "format": "int64", "description": "The unique identifier of the tax rate configuration associated with the tax setting." }, "order": { "type": "integer", "format": "int32", "description": "The order that the tax setting should be applied in." }, "rule": { "type": "string", "enum": [ "Pre", "Post" ], "description": "The rule that the tax setting should be applied in." } } }, "description": "Array of objects, with each object representing a tax setting with 'tax_rate_configuration_id', 'order', and 'rule' properties." }, "taxable": { "type": "boolean", "description": "Whether the LineItem taxable." }, "update_original_record": { "type": "boolean", "description": "Whether the associated activity will be updated." } } } } } } }, "required": false } }, "delete": { "tags": [ "Line Items" ], "summary": "Delete a single LineItem", "operationId": "LineItem#destroy", "description": "A LineItem can not be deleted if it's Bill is not editable", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the LineItem.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/log_entries.json": { "get": { "tags": [ "Log Entries" ], "summary": "Return the data for all LogEntries", "operationId": "LogEntry#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all LogEntries", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "created_since", "in": "query", "description": "Filter LogEntry records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "ids[]", "in": "query", "description": "Filter LogEntry records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of LogEntry records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "description": "Orders the LogEntry records by the given field. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "accessed_at(asc)", "accessed_at(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Filter LogEntry records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/LogEntry_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/matters/{matter_id}/client.json": { "get": { "tags": [ "Clients" ], "summary": "Return the client data for a single matter", "operationId": "Client#show", "description": "Outlines the parameters, optional and required, used when requesting the data for a single Client", "parameters": [ { "name": "IF-MODIFIED-SINCE", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "IF-NONE-MATCH", "in": "header", "description": "The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.", "required": false, "schema": { "type": "string" } }, { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "matter_id", "in": "path", "description": "Filters Client data by matter.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Client_Show" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "304": { "description": "Not Modified" } } } }, "/matters/{matter_id}/related_contacts.json": { "get": { "tags": [ "Related Contacts" ], "summary": "Return the related contact data for a single matter", "operationId": "RelatedContacts#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all RelatedContacts", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "A limit on the number of RelatedContacts records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "path", "description": "Filters RelatedContacts data by matter.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "order", "in": "query", "description": "Orders the RelatedContacts records by the given field. Note that `id` is ordered by the `id` of the nested Relationship record. Default: `id(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "id(asc)", "id(desc)", "contact.name(asc)", "contact.name(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/RelatedContacts_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/matters/{matter_id}/contacts.json": { "get": { "tags": [ "Matter Contacts" ], "summary": "Return the related contact data for a single matter", "operationId": "MatterContacts#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all MatterContacts", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "custom_field_ids[]", "in": "query", "description": "IDs of custom fields to include in results.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "A limit on the number of MatterContacts records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "matter_id", "in": "path", "description": "Filters contact data by matter.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "order", "in": "query", "description": "Orders the MatterContacts records by the given field. Note that `id` is ordered by the `id` of the nested Relationship record. Default: `is_client(asc)`.", "required": false, "schema": { "type": "string", "enum": [ "is_client(asc)", "is_client(desc)", "id(asc)", "id(desc)" ] } }, { "name": "page_token", "in": "query", "description": "A token specifying which page to return.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/MatterContacts_List" } } } }, "400": { "description": "Bad Request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/matters.json": { "get": { "tags": [ "Matters" ], "summary": "Return the data for all Matters", "operationId": "Matter#index", "description": "Outlines the parameters, optional and required, used when requesting the data for all Matters", "parameters": [ { "name": "X-API-VERSION", "in": "header", "description": "The [API minor version](#section/Minor-Versions). Default: latest version.", "required": false, "schema": { "type": "string" } }, { "name": "billable", "in": "query", "description": "Filter Matter records to those which are billable.", "required": false, "schema": { "type": "boolean" } }, { "name": "client_id", "in": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Matter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "close_date[]", "in": "query", "description": "Filter Matter records by the close date. The date should be provided in the format YYYY-MM-DD.\n\ne.g. `?close_date==2020-01-01`, `?close_date=<=2021-12-31`\n\nYou can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending `[]` to the parameter name.\n\ne.g. `?close_date[]=>=2020-01-01&close_date[]=<=2021-12-31`\n\nNote that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned.\n", "required": false, "schema": { "type": "string", "enum": [ ">DATE", ">=DATE", "=DATE", "<=DATE", "`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n", "required": false, "schema": { "type": "string", "enum": [ "=", "<", ">", "<=", ">=" ] } }, { "name": "fields", "in": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).", "required": false, "schema": { "type": "string" } }, { "name": "grant_id", "in": "query", "description": "The unique identifier for a single Grant. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "group_id", "in": "query", "description": "The unique identifier for a single Group. The keyword `null` is not valid for this field. The list will be filtered to include only the Matter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "ids[]", "in": "query", "description": "Filter Matter records to those having the specified unique identifiers.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "A limit on the number of Matter records to be returned. Limit can range between 1 and 200. Default: `200`.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "notification_event_subscriber_user_id", "in": "query", "description": "The unique identifier for a single NotificationEventSubscriber. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "open_date[]", "in": "query", "description": "Filter Matter records by the open date. The date should be provided in the format YYYY-MM-DD.\n\ne.g. `?open_date==2020-01-01`, `?open_date=<=2021-12-31`\n\nYou can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending `[]` to the parameter name.\n\ne.g. `?open_date[]=>=2020-01-01&open_date[]=<=2021-12-31`\n\nNote that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned.\n", "required": false, "schema": { "type": "string", "enum": [ ">DATE", ">=DATE", "=DATE", "<=DATE", "=2020-01-01&pending_date[]=<=2021-12-31`\n\nNote that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned.\n", "required": false, "schema": { "type": "string", "enum": [ ">DATE", ">=DATE", "=DATE", "<=DATE", "`, ``, `
`, `
`, ``, `` `
  • `, `
      `, `

      `, ``, ``, `` and `