Clockify Invoice API

openapi: 3.2.0
info:
  description: "## Introduction\nBy using this REST API, you can easily integrate Clockify with your own add-ons, push and pull data\nbetween Clockify and other tools, and create custom add-ons on [CAKE.com Marketplace](https://marketplace.cake.com).\nWhether you’re looking to automate time tracking, generate custom reports, or build other custom\nintegrations, our API provides the flexibility and power you need to get the job done. If you\nhave any questions or run into any issues while using our API, don’t hesitate to reach out to us for help.\nYou can also post questions on Stack Overflow with the Clockify tag to get help from the community.\n## Authentication\nTo authenticate your requests to your API, make sure to include either the ‘X-Api-Key’ or the\n‘X-Addon-Token’ in the request header, containing your API or Addon key. If your workspace is\non a subdomain (e.g. subdomain.clockify.me), you’ll need to generate a new API key in your\nProfile Settings that will work specifically for that workspace. This ensures that you’re\naccessing data from the correct workspace and helps maintain the security of your data.\n## Webhooks\nWebhooks can enhance your workflow by keeping your add-on up-to-date with the latest changes in\nClockify. With Clockify’s webhooks you can receive real-time notifications when certain events such as\nstarting a timer or deleting a time entry occur in Clockify.\nDepending on the workspace plan, workspace owners and admins can create:\n\n* Up to 3 webhooks on **FREE** plan\n* Up to 10 webhooks per user, with a total of 100 webhooks per entire workspace\non **BASIC**, **STANDARD** and **PRO** plans\n* Up to 100 webhooks per user, with a total of 300 webhooks per entire workspace on **ENTERPRISE** plan\n\n## Rate limiting\nOur REST API has a specific rate limit of 50 requests per second (by addon on one workspace) when\naccessed using X-Addon-Token. Exceeding this limit will result in an error message with the description\n\"Too many requests\".\n## Pagination\nOur REST API supports pagination for all synchronous GET endpoints that retrieve lists of entities.\nWhen an endpoint accepts the `page` and `pageSize` query parameters, it will return a paginated response.\n\nTo control the data returned in a paginated request, you can use the following optional query parameters.\n\n- **page** (integer): The page number you wish to retrieve. This is 1-indexed. If this parameter is omitted,\nthe API will default to the first page (page=1).\n- **pageSize** (integer): The number of items to include on each page. If this parameter is omitted,\na default page size will be used.\n\nEvery response from an endpoint that supports these parameters will include a custom `Last-Page` header.\nThis header provides a simple way to determine if you have reached the end of the data set.\n\n- **true:** The current page is the final page; no more data is available.\n- **false:** Additional pages can be fetched.\n## API URLs\nRefer to the list on what URL to use base on the subdomain and data region settings of your workspace.\n* Global - can be used by workspaces with or without subdomain.\n    * Regular: https://api.clockify.me/api/v1/file/image\n    * Reports: https://reports.api.clockify.me/v1/workspaces/{workspaceId}/reports/detailed\n* Regional\n    * Non-subdomain\n        * Regular: https://euc1.clockify.me/api/v1/file/image\n        * Reports: https://use2.clockify.me/report/v1/workspaces/{workspaceId}/reports/detailed\n    * Subdomain\n        * Regular: https://euc1.clockify.me/api/v1/file/image\n        * Reports: https://yoursubdomainname.clockify.me/report/v1/workspaces/{workspaceId}/reports/detailed\n* Developer\n    * Regular: https://developer.clockify.me/api/v1/file/image\n    * Reports: https://developer.clockify.me/report/v1/workspaces/{workspaceId}/reports/detailed\n## Regional Server Prefixes\nIf your workspace is in a specific region, you need to change your URL prefix to access v1 API endpoints.\nFor example, this is how **backend** api [v1/file/image](#tag/User/operation/uploadImage) endpoint\nwould look in EU region:\n[https://euc1.clockify.me/api/v1/file/image](https://euc1.clockify.me)\n\nBelow are the available regional server prefixes:\n* **EU (Germany)**: euc1\n* **USA**: use2\n* **UK**: euw2\n* **AU**: apse2\n\n\n## Breaking changes\nBreaking changes in APIs are modifications that disrupt existing integrations,\nrequiring users to update their applications to maintain functionality.\nThese changes can lead to failures or unexpected results if not addressed.\nSee the list of [breaking changes](breaking-changes/).\n\n## Experimental APIs\nThe experimental API has been thoroughly tested and is ready for use in production. However, please note that user feedback may lead to changes in the API’s structure or functionality. If you choose to use the experimental API, be prepared to modify your application code accordingly to accommodate any updates."
  title: Clockify Approval Invoice API
  version: v1
  x-logo:
    altText: Clockify logo
    url: https://clockify.me/downloads/clockify_logo_primary_black_margin.png
servers:
- url: https://api.clockify.me/api/v1
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Invoice
  x-displayName: Invoice
paths:
  /v1/workspaces/{workspaceId}/invoices:
    servers:
    - url: https://api.clockify.me/api
    get:
      operationId: getInvoices
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Page number.
        example: 1
        in: query
        name: page
        required: false
        schema:
          type: integer
          description: Page number.
          format: int32
          example: 1
          default: 1
      - description: Page size.
        example: 50
        in: query
        name: page-size
        required: false
        schema:
          minimum: 1
          type: integer
          description: Page size.
          format: int32
          example: 50
          default: 50
      - description: If provided, you'll get a filtered result of invoices that matches the provided string in the user ID linked to the expense.
        example:
        - UNSENT
        - PAID
        in: query
        name: statuses
        required: false
        schema:
          type: string
          enum:
          - UNSENT
          - SENT
          - PAID
          - PARTIALLY_PAID
          - VOID
          - OVERDUE
      - description: 'Valid column name as sorting criteria. Default: ID'
        example: CLIENT
        in: query
        name: sort-column
        required: false
        schema:
          type: string
          enum:
          - ID
          - CLIENT
          - DUE_ON
          - ISSUE_DATE
          - AMOUNT
          - BALANCE
      - description: 'Sort order. Default: ASCENDING'
        example: ASCENDING
        in: query
        name: sort-order
        required: false
        schema:
          type: string
          enum:
          - ASCENDING
          - DESCENDING
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoicesListDtoV1'
          description: OK
      summary: Get all invoices on a workspace
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
    post:
      operationId: createInvoice
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInvoiceRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInvoiceDtoV1'
          description: Created
      summary: Add an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/info:
    servers:
    - url: https://api.clockify.me/api
    post:
      operationId: getInvoicesInfo
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceFilterRequestV1'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceInfoResponseDtoV1'
          description: OK
      summary: Filter out invoices
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/settings:
    servers:
    - url: https://api.clockify.me/api
    get:
      operationId: getInvoiceSettings
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceSettingsDtoV1'
          description: OK
      summary: Get an invoice in another language
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
    put:
      operationId: updateInvoiceSettings
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInvoiceSettingsRequestV1'
        required: true
      responses:
        '200':
          description: OK
      summary: Change an invoice language
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/{invoiceId}:
    servers:
    - url: https://api.clockify.me/api
    delete:
      operationId: deleteInvoice
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents an invoice identifier across the system.
        example: 78a687e29ae1f428e7ebe303
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 78a687e29ae1f428e7ebe303
      responses:
        '200':
          description: OK
      summary: Delete an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
    get:
      operationId: getInvoice
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents an invoice identifier across the system.
        example: 83q687e29ae1f428e7ebe195
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 83q687e29ae1f428e7ebe195
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceOverviewDtoV1'
          description: OK
      summary: Get an invoice by ID
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
    put:
      operationId: updateInvoice
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents an invoice identifier across the system.
        example: 78a687e29ae1f428e7ebe303
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 78a687e29ae1f428e7ebe303
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInvoiceRequestV1'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceOverviewDtoV1'
          description: OK
      summary: Update an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/{invoiceId}/duplicate:
    servers:
    - url: https://api.clockify.me/api
    post:
      operationId: duplicateInvoice
      parameters:
      - description: Represents an invoice identifier across the system.
        example: 78a687e29ae1f428e7ebe303
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 78a687e29ae1f428e7ebe303
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceOverviewDtoV1'
          description: Created
      summary: Duplicate an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/{invoiceId}/export:
    servers:
    - url: https://api.clockify.me/api
    get:
      operationId: exportInvoice
      parameters:
      - description: Represents an invoice identifier across the system.
        example: 78a687e29ae1f428e7ebe303
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 78a687e29ae1f428e7ebe303
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents a locale.
        example: en
        in: query
        name: userLocale
        required: true
        schema:
          type: string
          description: Represents a locale.
          example: en
      responses:
        '200':
          content:
            '*/*':
              schema:
                type: string
                format: byte
          description: OK
      summary: Export an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/{invoiceId}/items:
    servers:
    - url: https://api.clockify.me/api
    post:
      operationId: addInvoiceItem
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents an invoice identifier across the system.
        example: 83q687e29ae1f428e7ebe195
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 83q687e29ae1f428e7ebe195
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInvoiceItemRequestV1'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceOverviewDtoV1'
          description: OK
      summary: Add item to an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/{invoiceId}/items/import:
    servers:
    - url: https://api.clockify.me/api
    post:
      operationId: importTimeEntriesAndExpenses
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents an invoice identifier across the system.
        example: 83q687e29ae1f428e7ebe195
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 83q687e29ae1f428e7ebe195
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportTimeEntriesAndExpensesRequestV1'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceOverviewDtoV1'
          description: OK
      summary: Import time entries and expenses to an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/{invoiceId}/items/{order}:
    servers:
    - url: https://api.clockify.me/api
    delete:
      operationId: removeInvoiceItem
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents an invoice identifier across the system.
        example: 83q687e29ae1f428e7ebe195
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 83q687e29ae1f428e7ebe195
      - description: Represents an invoice item order.
        example: 3
        in: path
        name: order
        required: true
        schema:
          minimum: 1
          type: integer
          description: Represents an invoice item order.
          format: int32
          example: 3
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceOverviewDtoV1'
          description: OK
      summary: Delete item from an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/{invoiceId}/payments:
    servers:
    - url: https://api.clockify.me/api
    get:
      operationId: getPaymentsForInvoice
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents an invoice identifier across the system.
        example: 78a687e29ae1f428e7ebe303
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 78a687e29ae1f428e7ebe303
      - description: Page number.
        example: 1
        in: query
        name: page
        required: false
        schema:
          type: integer
          description: Page number.
          format: int32
          example: 1
          default: 1
      - description: Page size.
        example: 50
        in: query
        name: page-size
        required: false
        schema:
          minimum: 1
          type: integer
          description: Page size.
          format: int32
          example: 50
          default: 50
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvoicePaymentDtoV1'
          description: OK
      summary: Get payments for an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
    post:
      operationId: createInvoicePayment
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents an invoice identifier across the system.
        example: 78a687e29ae1f428e7ebe303
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 78a687e29ae1f428e7ebe303
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInvoicePaymentRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceOverviewDtoV1'
          description: Created
      summary: Add payment to an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/{invoiceId}/payments/{paymentId}:
    servers:
    - url: https://api.clockify.me/api
    delete:
      operationId: deletePaymentById
      parameters:
      - description: Represents an invoice identifier across the system.
        example: 78a687e29ae1f428e7ebe303
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 78a687e29ae1f428e7ebe303
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents a payment identifier across the system.
        example: 56p687e29ae1f428e7ebe456
        in: path
        name: paymentId
        required: true
        schema:
          type: string
          description: Represents a payment identifier across the system.
          example: 56p687e29ae1f428e7ebe456
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceOverviewDtoV1'
          description: OK
      summary: Delete payment from an invoice
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
  /v1/workspaces/{workspaceId}/invoices/{invoiceId}/status:
    servers:
    - url: https://api.clockify.me/api
    patch:
      operationId: changeInvoiceStatus
      parameters:
      - description: Represents a workspace identifier across the system.
        example: 64a687e29ae1f428e7ebe303
        in: path
        name: workspaceId
        required: true
        schema:
          type: string
          description: Represents a workspace identifier across the system.
          example: 64a687e29ae1f428e7ebe303
      - description: Represents an invoice identifier across the system.
        example: 78a687e29ae1f428e7ebe303
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          description: Represents an invoice identifier across the system.
          example: 78a687e29ae1f428e7ebe303
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeInvoiceStatusRequestV1'
        required: true
      responses:
        '200':
          description: OK
      summary: Change an invoice status
      tags:
      - Invoice
      security:
      - ApiKeyAuth: []
      - AddonKeyAuth: []
components:
  schemas:
    InvoiceFilterRequestV1:
      type: object
      properties:
        clients:
          $ref: '#/components/schemas/ContainsArchivedFilterRequest'
        companies:
          $ref: '#/components/schemas/BaseFilterRequest'
        exactAmount:
          type: integer
          description: Represents an invoice amount. If provided, you'll get a filtered list of invoices that has the equal amount as specified.
          format: int64
          example: 1000
        exactBalance:
          type: integer
          description: Represents an invoice balance. If provided, you'll get a filtered list of invoices that has the equal balance as specified.
          format: int64
          example: 1000
        greaterThanAmount:
          type: integer
          description: Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount greater than specified.
          format: int64
          example: 500
        greaterThanBalance:
          type: integer
          description: Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance greater than specified.
          format: int64
          example: 500
        invoiceNumber:
          type: string
          description: If provided, you'll get a filtered list of invoices that contain the provided string in their invoice number.
          example: Invoice-01
        issueDate:
          $ref: '#/components/schemas/TimeRangeRequestDtoV1'
        lessThanAmount:
          type: integer
          description: Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount less than specified.
          format: int64
          example: 500
        lessThanBalance:
          type: integer
          description: Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance less than specified.
          format: int64
          example: 500
        page:
          type: integer
          description: Page number.
          format: int32
          default: 1
        pageSize:
          type: integer
          description: Page size.
          format: int32
          default: 50
        sortColumn:
          type: string
          description: Represents the column name to be used as sorting criteria.
          example: ID
          enum:
          - ID
          - CLIENT
          - DUE_ON
          - ISSUE_DATE
          - AMOUNT
          - BALANCE
        sortOrder:
          type: string
          description: Represents the sorting order.
          example: ASCENDING
          enum:
          - ASCENDING
          - DESCENDING
        statuses:
          type: array
          description: Represents a list of invoice statuses. If provided, you'll get a filtered list of invoices that matches any of the invoice status provided.
          example:
          - SENT
          - PAID
          - PARTIALLY_PAID
          items:
            type: string
            description: Represents a list of invoice statuses. If provided, you'll get a filtered list of invoices that matches any of the invoice status provided.
            example: '["SENT","PAID","PARTIALLY_PAID"]'
            enum:
            - UNSENT
            - SENT
            - PAID
            - PARTIALLY_PAID
            - VOID
            - OVERDUE
        strictSearch:
          type: boolean
          description: Flag to toggle on/off strict search mode. When set to true, search by invoice number only will return invoices whose number exactly matches the string value given for the 'invoiceNumber' parameter. When set to false, results will also include invoices whose number contain the string value, but could be longer than the string value itself. For example, if there is an invoice with the number '123456', and the search value is '123', setting strict-name-search to true will not return that invoice in the results, whereas setting it to false will.
          default: false
    InvoiceDefaultSettingsDto:
      type: object
      properties:
        companyId:
          type: string
          description: Represents company identifier across the system.
          example: 34a687e29ae1f428e7ebe101
        defaultImportExpenseItemTypeId:
          type: string
          description: Represents item type identifier across the system.
          example: 88a687e29ae1f428e7ebe303
        defaultImportTimeItemTypeId:
          type: string
          description: Represents item type identifier across the system.
          example: 18a687e29ae1f428e7ebe303
        dueDays:
          type: integer
          description: Represents an invoice number of due days.
          format: int32
          example: 2
        itemType:
          type: string
          writeOnly: true
        itemTypeId:
          type: string
          description: Represents item type identifier across the system.
          example: 78a687e29ae1f428e7ebe303
        notes:
          type: string
          description: Represents an invoice note.
          example: This is a sample note for this invoice.
        subject:
          type: string
          description: Represents an invoice subject.
          example: January salary
        tax:
          type: integer
          format: int64
          deprecated: true
        tax2:
          type: integer
          format: int64
          deprecated: true
        tax2Percent:
          type: number
          description: Represents a tax amount in percentage.
          format: double
          

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clockify/refs/heads/main/openapi/clockify-invoice-api-openapi.yml