{ "opencollection": "1.0.0", "info": { "name": "Clio API Documentation Activities Allocations API", "version": "v4" }, "items": [ { "info": { "name": "Allocations", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Allocations", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/allocations.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "bill_id", "value": "", "type": "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." }, { "name": "contact_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 Allocation records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Allocation records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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 Allocation records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Allocation 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. The keyword `null` is not valid for this field. The list will be filtered to include only the Allocation records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Allocation records by the given field. Default: `date(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "parent_id", "value": "", "type": "query", "description": "ID of parent (either a Payment or CreditMemo) this allocation belongs to" }, { "name": "parent_type", "value": "", "type": "query", "description": "Filter Allocation records based on whether the parent is a CreditMemo or a Payment." }, { "name": "status", "value": "", "type": "query", "description": "Filter Allocation records to only those that are voided (`\"invalid\"`) or not voided (`\"valid\"`)." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Allocation 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 Allocations" }, { "info": { "name": "Return the data for a single Allocation", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/allocations/: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 Allocation." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Allocation" } ] } ], "bundled": true }