{ "opencollection": "1.0.0", "info": { "name": "Clio API Documentation Activities Bills API", "version": "v4" }, "items": [ { "info": { "name": "Bills", "type": "folder" }, "items": [ { "info": { "name": "Returns the pre-rendered html for the Bill", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bills/:id/preview.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Bill." } ] }, "docs": "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" }, { "info": { "name": "Return the data for all Bills", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bills.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "bill_number", "value": "", "type": "query", "description": "Filter Bill records to those with this exact bill number" }, { "name": "client_id", "value": "", "type": "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." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Bill records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "currency_id", "value": "", "type": "query", "description": "Filter Bill records to those of a specific currency." }, { "name": "custom_field_values", "value": "", "type": "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" }, { "name": "due_after", "value": "", "type": "query", "description": "Filter Bill records to those that have a `due_date` after the one provided (Expects an ISO-8601 date)." }, { "name": "due_at", "value": "", "type": "query", "description": "Filter Bill records to those that have a specific `due_date` (Expects an ISO-8601 date)." }, { "name": "due_before", "value": "", "type": "query", "description": "Filter Bill records to those that have a `due_date` before the one provided (Expects an ISO-8601 date)." }, { "name": "fields", "value": "", "type": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter Bill records to those having the specified unique identifiers." }, { "name": "issued_after", "value": "", "type": "query", "description": "Filter Bill records to those that have an `issue_date` after the one provided (Expects an ISO-8601 date)." }, { "name": "issued_before", "value": "", "type": "query", "description": "Filter Bill records to those that have an `issue_date` before the one provided (Expects an ISO-8601 date)." }, { "name": "last_sent_end_date", "value": "", "type": "query", "description": "Filter Bill records for those whose bills have been sent before the specified date" }, { "name": "last_sent_start_date", "value": "", "type": "query", "description": "Filter Bill records for those whose bills have been sent after the specified date" }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Bill records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "matter_id", "value": "", "type": "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." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Bill records by the given field. Default: `id(asc)`." }, { "name": "originating_attorney_id", "value": "", "type": "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." }, { "name": "overdue_only", "value": "", "type": "query", "description": "Filter Bill records to those that are overdue." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Allows matching search on invoice number." }, { "name": "responsible_attorney_id", "value": "", "type": "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." }, { "name": "state", "value": "", "type": "query", "description": "Filter Bill records to those in a given state." }, { "name": "status", "value": "", "type": "query", "description": "Filter Bill records to those with particular payment status." }, { "name": "type", "value": "", "type": "query", "description": "Filter Bill records to those of a specific type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Bill records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Bills" }, { "info": { "name": "Return the data for a single Bill", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bills/:id.json", "headers": [ { "name": "IF-MODIFIED-SINCE", "value": "" }, { "name": "IF-NONE-MATCH", "value": "" }, { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Bill." }, { "name": "navigation.next", "value": "", "type": "query", "description": "The id of the next *Bill* available for viewing" }, { "name": "navigation.previous", "value": "", "type": "query", "description": "The id of the previous *Bill* available for viewing" } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Bill" }, { "info": { "name": "Update a single Bill", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/bills/:id.json", "headers": [ { "name": "IF-MATCH", "value": "" }, { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Bill." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Bill" }, { "info": { "name": "Delete or void a Bill", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/bills/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Bill." } ] }, "docs": "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" } ] } ], "bundled": true }