Clio Report Presets API

openapi: 3.0.0
info:
  title: Clio API Documentation Activities Report Presets API
  contact:
    name: Clio API Support
    email: api@clio.com
  description: "# Developer Support and Feedback\n* Clio takes the availability and stability of our API seriously; please report any **degradations** or **breakages** to Clio's API Support team at [api@clio.com](mailto:api@clio.com).\n* For business and partnership inquiries, contact our API Partnerships team at [api.partnerships@clio.com](mailto:api.partnerships@clio.com).\n* For best practices and tips from the Clio development community, join the conversation in the [Clio Developer Slack Channel](https://join.slack.com/t/clio-public/shared_invite/zt-36i0eqgo1-7POORPtMJpp2N0~_auL2IQ).\n\nA community-driven [Clio Developers Stack Overflow Group](https://stackoverflow.com/questions/tagged/clio-api) also exists where you can connect and ask questions from other Clio API users.\n# Getting Started\n> **Note:** The API is available in four distinct data regions: Australia (au.app.clio.com), Canada (ca.app.clio.com), EU (eu.app.clio.com) and US (app.clio.com).\n>\n> Likewise, the developer portal is available at region-specific links for the [Australia](https://au.developers.clio.com), [Canada](https://ca.developers.clio.com), [EU](https://eu.developers.clio.com), and [US](https://developers.clio.com) regions.\n>\n> This document assumes the US region is being used (app.clio.com). If you're building in one of the other regions, you should adapt the links and examples as necessary.\n\nTo start building on the Clio API, you’ll need a Clio account – you can review our [Developer Handbook](https://docs.developers.clio.com/) and follow the steps to sign up for an account.\n\nOnce you have an account, you can [create a developer application](https://docs.developers.clio.com/api-docs/applications) from the [Developer Portal](https://developers.clio.com) and start building!\n# Authorization with OAuth 2.0\nSee our [Authorization documentation →](https://docs.developers.clio.com/api-docs/authorization)\n# Permissions\nSee our [Permissions documentation →](https://docs.developers.clio.com/api-docs/permissions)\n# Fields\nSee our [Fields documentation →](https://docs.developers.clio.com/api-docs/fields)\n# Rate Limiting\nSee our [Rate Limits documentation →](https://docs.developers.clio.com/api-docs/rate-limits)\n# Paging\nSee our [Pagination documentation →](https://docs.developers.clio.com/api-docs/paging)\n# ETags\nSee our [ETags documentation →](https://docs.developers.clio.com/api-docs/etags)\n# Minor Versions\nAPI v4 supports multiple minor versions. Versions are of the form '4.X.Y'. To request a specific version, you can use an `X-API-VERSION` header in your request, with the header value set to the API version you're requesting. If this header is omitted, it will be treated as a request for the default API version. If the header is present but invalid, it will return a `410 Gone` response. If the header is present and valid, but it is no longer supported, it will return a `410 Gone` response.\n\nAn `X-API-VERSION` will be included in all successful responses, with the value being set to the API version used.\n\nYou can find our [API Versioning Policy and Guidelines](https://docs.developers.clio.com/api-docs/api-versioning-policy) in our documentation hub.\n\nThe [API Changelog](https://docs.developers.clio.com/api-docs/api-changelog) explains each version's changes in further detail.\n### [4.0.4](https://docs.developers.clio.com/api-docs/api-changelog#404)\n\n  * Update `quantity` field to return values in seconds rather than hours for Activities\n\n### [4.0.5](https://docs.developers.clio.com/api-docs/api-changelog#405)\n\n  * Remove `matter_balances` field from Bills\n* Standardize status/state enum values\n* Add a Document association to completed DocumentAutomations\n* Add rate visibility handling for Activity's price and total\n\n### [4.0.6](https://docs.developers.clio.com/api-docs/api-changelog#406)\n\n  * Remove `document_versions` collection field from Documents\n\n### [4.0.7](https://docs.developers.clio.com/api-docs/api-changelog#407)\n\n  * Change secure link format\n\n### [4.0.8](https://docs.developers.clio.com/api-docs/api-changelog#408)\n\n  * `Activity` hours are redacted in the response based on the activity hours visibility setting for the user\n  * Add `quantity_redacted` field to activities\n\n### [4.0.9](https://docs.developers.clio.com/api-docs/api-changelog#409)\n\n  * Contacts are filtered and redacted in the response based on the new 'Contacts Visibility' user permission setting.\n\n### [4.0.10](https://docs.developers.clio.com/api-docs/api-changelog#4010)\n\n  * Fixed validation of `type` query parameter when querying Notes\n\n### [4.0.12](https://docs.developers.clio.com/api-docs/api-changelog#4012)\n\n  * Restrict fields for CalendarEntry that should only be visible to event owners, editors, and viewers\n\n### [4.0.13](https://docs.developers.clio.com/api-docs/api-changelog#4013)\n\n  **This is the default version**\n\n  * Add association limits to Contacts\n* Returns 422 Unprocessable Entity when association limits are exceeded\n\n\n"
  version: v4
  x-logo:
    url: https://www.clio.com/wp-content/uploads/2015/05/Container-5-Logo.png
servers:
- url: https://app.clio.com/api/v4
  description: US region Production Server
- url: https://eu.app.clio.com/api/v4
  description: Europe region Production Server
- url: https://ca.app.clio.com/api/v4
  description: Canada region Production Server
- url: https://au.app.clio.com/api/v4
  description: Australia region Production Server
tags:
- name: Report Presets
  description: "Report Presets can be created to streamline report generation workflow by saving report option parameters as a Preset.\n\n[Support Link](https://help.clio.com/hc/en-us/articles/9290078155803-Generate-Reports-Presets-and-History#reports-presets-0-2)\n\n## Creating a Report Preset\n### Options\nWhen creating a Report Preset, the options sent in the request body is dependent on the report kind.\n\nCheck out the sample request to create a Report Preset for the Billing History web report for the current year and grouped by client.\n\n```\nRequest\n  POST /api/v4/report_presets.json\n  {\n    data:\n    { name: \"Current Yr Billing\",\n      kind: \"billing_history\",\n      options: {\n        date_range: \"year\",\n        format: \"html\",\n        group_by: \"client\",\n        start_date: null,\n        end_date: null,\n        kind: \"billing_history\"\n      },\n      format: \"html\"\n    }\n  }\n```\n"
paths:
  /report_presets/{id}/generate_report.json:
    post:
      tags:
      - Report Presets
      summary: Generate a new report for a given preset
      operationId: ReportPreset#generate_report
      description: Generate a new report for a given preset
      parameters:
      - name: id
        in: path
        description: The unique identifier for the ReportPreset.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '201':
          description: Created
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Report_Show'
        '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'
        '403':
          description: Forbidden
          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'
  /report_presets.json:
    get:
      tags:
      - Report Presets
      summary: Return the data for all ReportPresets
      operationId: ReportPreset#index
      description: Outlines the parameters, optional and required, used when requesting the data for all ReportPresets
      parameters:
      - name: X-API-VERSION
        in: header
        description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
        required: false
        schema:
          type: string
      - name: category
        in: query
        description: Filters ReportPreset data by category.
        required: false
        schema:
          type: string
          enum:
          - billing
          - client
          - compliance
          - financial
          - matter
          - online_payments
          - productivity
          - revenue
          - task
      - name: created_since
        in: query
        description: Filter ReportPreset 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: has_schedule
        in: query
        description: Filters ReportPreset records to those that have or do not have a Report Schedule.
        required: false
        schema:
          type: boolean
      - name: ids[]
        in: query
        description: Filter ReportPreset 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 ReportPreset 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 ReportPreset records by the given field. Default: `id(asc)`.'
        required: false
        schema:
          type: string
          enum:
          - created_at(asc)
          - created_at(desc)
          - last_generated_at(asc)
          - last_generated_at(desc)
          - last_modified_at(asc)
          - last_modified_at(desc)
          - name(asc)
          - name(desc)
          - next_scheduled_date(asc)
          - next_scheduled_date(desc)
      - name: output_format
        in: query
        description: Filters ReportPreset data by format.
        required: false
        schema:
          type: string
      - 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 ReportPreset name.
        required: false
        schema:
          type: string
      - name: schedule_frequency
        in: query
        description: Filters ReportPreset records to those that have a Report Schedule of the specified frequency.
        required: false
        schema:
          type: string
          enum:
          - daily
          - weekly
          - monthly
      - name: updated_since
        in: query
        description: Filter ReportPreset 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/ReportPreset_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:
      - Report Presets
      summary: Create a new ReportPreset
      operationId: ReportPreset#create
      description: Outlines the parameters and data fields used when creating a new ReportPreset
      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/ReportPreset_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 Report Presets
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    format:
                      type: string
                      enum:
                      - csv
                      - html
                      - json
                      - pdf
                      - xlsx
                      - zip
                      description: What format the report will be generated in.
                    kind:
                      type: string
                      enum:
                      - accounts_receivable
                      - accounts_receivable_aging
                      - bank_account_activity
                      - billing_history
                      - billing_rate
                      - client_activity
                      - client_ledger
                      - clio_payments_deposit
                      - clio_payments_ledger
                      - clio_payments_monthly_statement
                      - clio_payments_sales_tax
                      - clio_payments_transaction
                      - contact_information
                      - currency_conversion_gain_loss
                      - disbursement_payment
                      - fee_allocation
                      - general_ledger
                      - grant_matters
                      - invoice_payments_v2
                      - law_society_of_alberta
                      - law_society_of_alberta_al
                      - law_society_of_alberta_bar
                      - law_society_of_alberta_tl
                      - law_society_of_alberta_tt
                      - matter
                      - matter_balance_summary
                      - matter_ledger_full
                      - matter_productivity_by_user
                      - matters_by_responsible_attorney
                      - originating_attorney_revenue
                      - other_revenue
                      - potential_trust_to_office
                      - productivity_by_client
                      - productivity_by_user
                      - revenue
                      - task_productivity_by_user
                      - task_progress_by_user
                      - trust_ledger
                      - trust_ledger_nsw
                      - trust_listing
                      - trust_management
                      - work_in_progress
                      description: What kind of report will be generated.
                    name:
                      type: string
                      description: Name of the ReportPreset.
                    options:
                      type: string
                      description: What the report generation parameters are. See [Creating a Report Preset](#section/Creating-a-Report-Preset) for a sample request.
                  required:
                  - name
                  - format
                  - kind
                  - options
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    format:
                      type: string
                      enum:
                      - csv
                      - html
                      - json
                      - pdf
                      - xlsx
                      - zip
                      description: What format the report will be generated in.
                    kind:
                      type: string
                      enum:
                      - accounts_receivable
                      - accounts_receivable_aging
                      - bank_account_activity
                      - billing_history
                      - billing_rate
                      - client_activity
                      - client_ledger
                      - clio_payments_deposit
                      - clio_payments_ledger
                      - clio_payments_monthly_statement
                      - clio_payments_sales_tax
                      - clio_payments_transaction
                      - contact_information
                      - currency_conversion_gain_loss
                      - disbursement_payment
                      - fee_allocation
                      - general_ledger
                      - grant_matters
                      - invoice_payments_v2
                      - law_society_of_alberta
                      - law_society_of_alberta_al
                      - law_society_of_alberta_bar
                      - law_society_of_alberta_tl
                      - law_society_of_alberta_tt
                      - matter
                      - matter_balance_summary
                      - matter_ledger_full
                      - matter_productivity_by_user
                      - matters_by_responsible_attorney
                      - originating_attorney_revenue
                      - other_revenue
                      - potential_trust_to_office
                      - productivity_by_client
                      - productivity_by_user
                      - revenue
                      - task_productivity_by_user
                      - task_progress_by_user
                      - trust_ledger
                      - trust_ledger_nsw
                      - trust_listing
                      - trust_management
                      - work_in_progress
                      description: What kind of report will be generated.
                    name:
                      type: string
                      description: Name of the ReportPreset.
                    options:
                      type: string
                      description: What the report generation parameters are. See [Creating a Report Preset](#section/Creating-a-Report-Preset) for a sample request.
                  required:
                  - name
                  - format
                  - kind
                  - options
          multipart/form-data:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    format:
                      type: string
                      enum:
                      - csv
                      - html
                      - json
                      - pdf
                      - xlsx
                      - zip
                      description: What format the report will be generated in.
                    kind:
                      type: string
                      enum:
                      - accounts_receivable
                      - accounts_receivable_aging
                      - bank_account_activity
                      - billing_history
                      - billing_rate
                      - client_activity
                      - client_ledger
                      - clio_payments_deposit
                      - clio_payments_ledger
                      - clio_payments_monthly_statement
                      - clio_payments_sales_tax
                      - clio_payments_transaction
                      - contact_information
                      - currency_conversion_gain_loss
                      - disbursement_payment
                      - fee_allocation
                      - general_ledger
                      - grant_matters
                      - invoice_payments_v2
                      - law_society_of_alberta
                      - law_society_of_alberta_al
                      - law_society_of_alberta_bar
                      - law_society_of_alberta_tl
                      - law_society_of_alberta_tt
                      - matter
                      - matter_balance_summary
                      - matter_ledger_full
                      - matter_productivity_by_user
                      - matters_by_responsible_attorney
                      - originating_attorney_revenue
                      - other_revenue
                      - potential_trust_to_office
                      - productivity_by_client
                      - productivity_by_user
                      - revenue
                      - task_productivity_by_user
                      - task_progress_by_user
                      - trust_ledger
                      - trust_ledger_nsw
                      - trust_listing
                      - trust_management
                      - work_in_progress
                      description: What kind of report will be generated.
                    name:
                      type: string
                      description: Name of the ReportPreset.
                    options:
                      type: string
                      description: What the report generation parameters are. See [Creating a Report Preset](#section/Creating-a-Report-Preset) for a sample request.
                  required:
                  - name
                  - format
                  - kind
                  - options
        required: false
  /report_presets/{id}.json:
    get:
      tags:
      - Report Presets
      summary: Return the data for a single ReportPreset
      operationId: ReportPreset#show
      description: Outlines the parameters, optional and required, used when requesting the data for a single ReportPreset
      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 ReportPreset.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ReportPreset_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:
      - Report Presets
      summary: Update a single ReportPreset
      operationId: ReportPreset#update
      description: Outlines the parameters and data fields used when updating a single ReportPreset
      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 ReportPreset.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ReportPreset_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 Report Presets
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    format:
                      type: string
                      enum:
                      - csv
                      - html
                      - json
                      - pdf
                      - xlsx
                      - zip
                      description: What format the report will be generated in.
                    kind:
                      type: string
                      enum:
                      - accounts_receivable
                      - accounts_receivable_aging
                      - bank_account_activity
                      - billing_history
                      - billing_rate
                      - client_activity
                      - client_ledger
                      - clio_payments_deposit
                      - clio_payments_ledger
                      - clio_payments_monthly_statement
                      - clio_payments_sales_tax
                      - clio_payments_transaction
                      - contact_information
                      - currency_conversion_gain_loss
                      - disbursement_payment
                      - fee_allocation
                      - general_ledger
                      - grant_matters
                      - invoice_payments_v2
                      - law_society_of_alberta
                      - law_society_of_alberta_al
                      - law_society_of_alberta_bar
                      - law_society_of_alberta_tl
                      - law_society_of_alberta_tt
                      - matter
                      - matter_balance_summary
                      - matter_ledger_full
                      - matter_productivity_by_user
                      - matters_by_responsible_attorney
                      - originating_attorney_revenue
                      - other_revenue
                      - potential_trust_to_office
                      - productivity_by_client
                      - productivity_by_user
                      - revenue
                      - task_productivity_by_user
                      - task_progress_by_user
                      - trust_ledger
                      - trust_ledger_nsw
                      - trust_listing
                      - trust_management
                      - work_in_progress
                      description: What kind of report will be generated.
                    name:
                      type: string
                      description: Name of the ReportPreset.
                    options:
      

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-report-presets-api-openapi.yml