Clio Billing Settings API

openapi: 3.2.0
info:
  title: Clio API Documentation Billing Settings API
  contact:
    name: Clio API Support
    email: api@clio.com
  description: '# Developer Support and Feedback

    * 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.'
  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: Billing Settings
  description: ''
paths:
  /settings/billing.json:
    get:
      tags:
      - Billing Settings
      summary: Return the billing settings
      operationId: BillingSetting#show
      description: Outlines the parameters, optional and required, used when requesting the data for a single BillingSetting
      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: duration
        in: query
        description: 'Duration string for time rounding, conforming to the Chronic date parser. For example: ''3h'' or ''2:15''.'
        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/BillingSetting_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
components:
  schemas:
    ErrorDetail:
      type: object
      required:
      - type
      - message
      properties:
        type:
          type: string
          description: Unique name for this error
        message:
          type: string
          description: Detailed message about the error
    BillingSetting_Show:
      type: object
      required:
      - data
      properties:
        data:
          $ref: '#/components/schemas/BillingSetting'
    TaxSetting_base:
      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
        tax_rate_configuration_name:
          type: string
          description: The name of the tax rate configuration
        tax_rate_configuration_rate:
          type: number
          format: decimal
          description: The rate of the tax rate configuration
        tax_rate_configuration_formatted_rate:
          type: string
          description: The formatted rate of the tax rate configuration as a percentage
        order:
          type: integer
          format: int32
          description: The order in which this tax setting should be applied
        rule:
          type: string
          description: The rule that the tax setting should be applied in
    BillingSetting:
      allOf:
      - $ref: '#/components/schemas/BillingSetting_base'
      - type: object
        properties:
          tax_settings:
            type: array
            items:
              $ref: '#/components/schemas/TaxSetting_base'
            description: TaxSetting
    BillingSetting_base:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier for the *BillingSetting*
        etag:
          type: string
          description: ETag for the *BillingSetting*
        rounded_duration:
          type: number
          format: float
          description: Rounded equivalent of duration submitted
        rounding:
          type: integer
          format: int32
          description: Minute increment for time rounding
        use_decimal_rounding:
          type: boolean
          description: Round time to two decimal places
        currency:
          type: string
          description: Current user setting of currency
        currency_sign:
          type: string
          description: The sign of the current currency
        tax_rate:
          type: number
          format: double
          description: Rate applied for primary tax on invoices using this BillingSetting
        tax_name:
          type: string
          description: Name shown for primary tax on invoices using this BillingSetting
        apply_tax_by_default:
          type: boolean
          description: Used to determine if primary tax should be applied to invoices by default
        apply_secondary_tax_by_default:
          type: boolean
          description: Used to determine if secondary tax should be applied to invoices by default
        time_on_flat_rate_contingency_matters_is_non_billable:
          type: boolean
          description: Used to determine if hourly time entries on flat rate or contingency fee matters should be non-billable by default
        use_secondary_tax:
          type: boolean
          description: Used to determine if secondary tax applies to invoices using this BillingSetting
        secondary_tax_rate:
          type: number
          format: double
          description: Rate applied for secondary tax on invoices using this BillingSetting
        secondary_tax_rule:
          type: string
          enum:
          - Pre
          - Post
          description: Used to determine if secondary tax should be applied separately or additionally to primary tax
        secondary_tax_name:
          type: string
          description: Name shown for secondary tax on invoices using this BillingSetting
        notify_after_bill_created:
          type: boolean
          description: Flag to indicate if users should have the option to notify other users when generating a bill
        use_utbms_codes:
          type: boolean
          description: Controls usage of UTBMS codes, allowing creation of coded time entries and expenses
        created_at:
          type: string
          format: date-time
          description: The time the *BillingSetting* was created (as a ISO-8601 timestamp)
        updated_at:
          type: string
          format: date-time
          description: The time the *BillingSetting* was last updated (as a ISO-8601 timestamp)
        multi_currency_billing:
          type: boolean
          description: Whether multi-currency billing is enabled
        billing_currencies:
          type: array
          items:
            type: object
          description: The currencies that an account has available for billing, if multi-currency billing is enabled
        tax_settings:
          type: array
          items:
            type: object
          description: Array of objects representing invoice tax defaults, with each object containing 'tax_rate_configuration_id', 'order', and 'rule'
    Error:
      type: object
      required:
      - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
x-tagGroups:
- name: Api
  tags:
  - Custom Actions
  - Webhooks
- name: Activities
  tags:
  - Activities
  - Activity Descriptions
  - Activity Rates
  - Expense Categories
  - Timers
  - Utbms Codes
  - Utbms Sets
- name: Accounting
  tags:
  - Bank Accounts
  - Bank Transactions
  - Bank Transfers
- name: Billing
  tags:
  - Bills
  - Billable Clients
  - Billable Matters
  - Bill Themes
  - Interest Charges
  - Line Items
  - Outstanding Client Balances
- name: Calendars
  tags:
  - Calendars
  - Calendar Entries
  - Calendar Entry Event Types
  - Calendar Visibilities
  - Reminders
- name: Clio Payments
  tags:
  - Clio Payments Links
  - Clio Payments Payments
- name: Communications
  tags:
  - Communications
  - Conversations
  - Conversation Messages
- name: Contacts
  tags:
  - Contacts
  - Email Addresses
  - Phone Numbers
  - Notes
  - Log Entries
- name: Court Rules
  tags:
  - Jurisdictions To Triggers
  - Jurisdictions
  - Matter Dockets
  - Service Types
- name: Custom Fields
  tags:
  - Custom Fields
  - Custom Field Sets
- name: Documents
  tags:
  - Documents
  - Document Versions
  - Folders
  - Document Archives
  - Document Automations
  - Document Categories
  - Document Templates
  - Comments
- name: In-app Notifications
  tags:
  - My Events
  - Event Metrics
- name: Matters
  tags:
  - Matters
  - Relationships
  - Clients
  - Related Contacts
  - Matter Contacts
  - Notes
  - Practice Areas
  - Log Entries
  - Matter Stages
  - Medical Records Details
  - Medical Records
  - Medical Bills
  - Damages
- name: Payments
  tags:
  - Allocations
  - Credit Memos
- name: Reporting
  tags:
  - Reports
  - Report Presets
  - Report Schedules
- name: Settings
  tags:
  - Text Snippets
  - Billing Settings
  - Currencies
  - Tax Rate Configurations
- name: Tasks
  tags:
  - Tasks
  - Task Templates
  - Task Template Lists
  - Task Types
- name: Trust
  tags:
  - Trust Line Items
  - Trust Requests
- name: Users
  tags:
  - Users
  - Groups
- name: Legal Aid US
  tags:
  - Grants
  - Grant Funding Sources
- name: Legal Aid England & Wales
  tags:
  - Civil Controlled Rates
  - Civil Certificated Rates
  - Criminal Controlled Rates
  - Expense Categories