---
title: "Filter out invoices"
method: POST
path: "/v1/workspaces/{workspaceId}/invoices/info"
tags: ["Invoice"]
---

# Filter out invoices

`POST /v1/workspaces/{workspaceId}/invoices/info`

## Path parameters

- `workspaceId` string, required — Represents a workspace identifier across the system.

## Request body

- InvoiceFilterRequestV1
  - `clients` ContainsArchivedFilterRequest — Represents a project filter for imported items.
    - `contains` 'CONTAINS' | 'DOES_NOT_CONTAIN' | 'CONTAINS_ONLY' — Filter type.
    - `ids` string[] — Represents a list of filter identifiers.
    - `status` 'ACTIVE' | 'ARCHIVED' | 'ALL' — Filters entities by status.
  - `companies` BaseFilterRequest — Represents a company filter object. If provided, you'll get a filtered list of invoices that matches the specified company filter.
    - `contains` 'CONTAINS' | 'DOES_NOT_CONTAIN' | 'CONTAINS_ONLY' — Filter type.
    - `ids` string[] — Represents a list of filter identifiers.
  - `exactAmount` integer — Represents an invoice amount. If provided, you'll get a filtered list of invoices that has the equal amount as specified.
  - `exactBalance` integer — Represents an invoice balance. If provided, you'll get a filtered list of invoices that has the equal balance as specified.
  - `greaterThanAmount` integer — Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount greater than specified.
  - `greaterThanBalance` integer — Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance greater than specified.
  - `invoiceNumber` string — If provided, you'll get a filtered list of invoices that contain the provided string in their invoice number.
  - `issueDate` TimeRangeRequestDtoV1 — Represents a time range object. If provided, you'll get a filtered list of invoices that has issue date within the time range specified.
    - `issue-date-end` string — Represents a date in yyyy-MM-dd format. This is the lower bound of the time range.
    - `issue-date-start` string — Represents a date in yyyy-MM-dd format. This is the lower bound of the time range.
  - `lessThanAmount` integer — Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount less than specified.
  - `lessThanBalance` integer — Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance less than specified.
  - `page` integer — Page number.
  - `pageSize` integer — Page size.
  - `sortColumn` 'ID' | 'CLIENT' | 'DUE_ON' | 'ISSUE_DATE' | 'AMOUNT' | 'BALANCE' — Represents the column name to be used as sorting criteria.
  - `sortOrder` 'ASCENDING' | 'DESCENDING' — Represents the sorting order.
  - `statuses` string[] — Represents a list of invoice statuses. If provided, you'll get a filtered list of invoices that matches any of the invoice status provided.
  - `strictSearch` boolean — 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.

## Response `200`

OK

- InvoiceInfoResponseDtoV1
  - `invoices` InvoiceInfoV1[] — Represents a list of invoice info. — unresolved $ref
  - `total` integer — Represents the total invoice count.

---

[API](https://skmtc.dev/clockify/apis/clockify-api.md) · [All operations](https://skmtc.dev/clockify/apis/clockify-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/clockify/clockify-api/revisions/a5b636acbcd8/schema)