> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # clockify-finance > Clockify Finance - invoices and expenses **Server path:** `/clockify-finance` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | | [`clockify_finance_add_invoice_item`](#clockify_finance_add_invoice_item) | Add item to an invoice | | [`clockify_finance_change_invoice_status`](#clockify_finance_change_invoice_status) | Change an invoice status | | [`clockify_finance_create_expense`](#clockify_finance_create_expense) | Create an expense | | [`clockify_finance_create_expense_category`](#clockify_finance_create_expense_category) | Add an expense category | | [`clockify_finance_create_invoice`](#clockify_finance_create_invoice) | Add an invoice | | [`clockify_finance_create_invoice_payment`](#clockify_finance_create_invoice_payment) | Add payment to an invoice | | [`clockify_finance_delete_category`](#clockify_finance_delete_category) | Delete an expense category | | [`clockify_finance_delete_expense`](#clockify_finance_delete_expense) | Delete an expense | | [`clockify_finance_delete_invoice`](#clockify_finance_delete_invoice) | Delete an invoice | | [`clockify_finance_delete_payment_by_id`](#clockify_finance_delete_payment_by_id) | Delete payment from an invoice | | [`clockify_finance_download_file`](#clockify_finance_download_file) | Download a receipt | | [`clockify_finance_duplicate_invoice`](#clockify_finance_duplicate_invoice) | Duplicate an invoice | | [`clockify_finance_export_invoice`](#clockify_finance_export_invoice) | Export an invoice | | [`clockify_finance_get_categories`](#clockify_finance_get_categories) | Get all expense categories | | [`clockify_finance_get_expense`](#clockify_finance_get_expense) | Get an expense by ID | | [`clockify_finance_get_expenses`](#clockify_finance_get_expenses) | Get all expenses on a workspace | | [`clockify_finance_get_invoice`](#clockify_finance_get_invoice) | Get an invoice by ID | | [`clockify_finance_get_invoice_settings`](#clockify_finance_get_invoice_settings) | Get an invoice in another language | | [`clockify_finance_get_invoices`](#clockify_finance_get_invoices) | Get all invoices on a workspace | | [`clockify_finance_get_invoices_info`](#clockify_finance_get_invoices_info) | Filter out invoices | | [`clockify_finance_get_payments_for_invoice`](#clockify_finance_get_payments_for_invoice) | Get payments for an invoice | | [`clockify_finance_import_time_entries_and_expenses`](#clockify_finance_import_time_entries_and_expenses) | Import time entries and expenses to an invoice | | [`clockify_finance_remove_invoice_item`](#clockify_finance_remove_invoice_item) | Delete item from an invoice | | [`clockify_finance_update_category`](#clockify_finance_update_category) | Update an expense category | | [`clockify_finance_update_expense`](#clockify_finance_update_expense) | Update an expense | | [`clockify_finance_update_expense_category_status`](#clockify_finance_update_expense_category_status) | Archive an expense category | | [`clockify_finance_update_invoice`](#clockify_finance_update_invoice) | Update an invoice | | [`clockify_finance_update_invoice_settings`](#clockify_finance_update_invoice_settings) | Change an invoice language | *** ## clockify\_finance\_add\_invoice\_item Add item to an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `applyTaxes` | string | Yes | — | Represents taxes applied to the invoice item. Applies only when the specified taxes are active on the invoice. | | `description` | string | Yes | — | Represents an invoice item description. | | `itemType` | string | Yes | — | Represents an item type. | | `quantity` | integer | Yes | — | Represents an item quantity. | | `unitPrice` | integer | Yes | — | Represents an item unit price. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "applyTaxes": { "type": "string", "description": "Represents taxes applied to the invoice item. Applies only when the specified taxes are active on the invoice.", "enum": [ "TAX1", "TAX2", "TAX1TAX2", "NONE" ] }, "description": { "type": "string", "description": "Represents an invoice item description." }, "itemType": { "type": "string", "description": "Represents an item type." }, "quantity": { "type": "integer", "description": "Represents an item quantity." }, "unitPrice": { "type": "integer", "description": "Represents an item unit price." } }, "required": [ "PCID", "workspaceId", "invoiceId", "applyTaxes", "description", "itemType", "quantity", "unitPrice" ] } ``` *** ## clockify\_finance\_change\_invoice\_status Change an invoice status **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `invoiceStatus` | string | Yes | — | Represents the invoice status to be set. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "invoiceStatus": { "type": "string", "description": "Represents the invoice status to be set.", "enum": [ "UNSENT", "SENT", "PAID", "PARTIALLY_PAID", "VOID", "OVERDUE" ] } }, "required": [ "PCID", "workspaceId", "invoiceId", "invoiceStatus" ] } ``` *** ## clockify\_finance\_create\_expense Create an expense **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ----------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `amount` | number | Yes | — | Represents an expense amount as the double data type. | | `billable` | boolean | No | — | Indicates whether expense is billable or not. | | `categoryId` | string | Yes | — | Represents a category identifier across the system. | | `date` | string | Yes | — | Provides a valid yyyy-MM-ddThh:mm:ssZ format date. | | `file` | string | Yes | — | The file value | | `notes` | string | No | — | Represents notes for an expense. | | `projectId` | string | Yes | — | Represents a project identifier across the system. | | `taskId` | string | No | — | Represents a task identifier across the system. | | `userId` | string | Yes | — | Represents a user identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "amount": { "type": "number", "description": "Represents an expense amount as the double data type." }, "billable": { "type": "boolean", "description": "Indicates whether expense is billable or not." }, "categoryId": { "type": "string", "description": "Represents a category identifier across the system." }, "date": { "type": "string", "description": "Provides a valid yyyy-MM-ddThh:mm:ssZ format date." }, "file": { "type": "string", "description": "The file value" }, "notes": { "type": "string", "description": "Represents notes for an expense." }, "projectId": { "type": "string", "description": "Represents a project identifier across the system." }, "taskId": { "type": "string", "description": "Represents a task identifier across the system." }, "userId": { "type": "string", "description": "Represents a user identifier across the system." } }, "required": [ "PCID", "workspaceId", "amount", "categoryId", "date", "file", "projectId", "userId" ] } ``` *** ## clockify\_finance\_create\_expense\_category Add an expense category **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ----------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `hasUnitPrice` | boolean | No | — | Flag whether expense category has unit price or none. | | `name` | string | Yes | — | Represents a valid expense category name. | | `priceInCents` | integer | No | — | Represents price in cents as integer. | | `unit` | string | No | — | Represents a valid expense category unit. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "hasUnitPrice": { "type": "boolean", "description": "Flag whether expense category has unit price or none." }, "name": { "type": "string", "description": "Represents a valid expense category name." }, "priceInCents": { "type": "integer", "description": "Represents price in cents as integer." }, "unit": { "type": "string", "description": "Represents a valid expense category unit." } }, "required": [ "PCID", "workspaceId", "name" ] } ``` *** ## clockify\_finance\_create\_invoice Add an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ----------------------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `clientId` | string | Yes | — | Represents a client identifier across the system. | | `currency` | string | Yes | — | Represents the currency used by the invoice. | | `dueDate` | string | Yes | — | Represents an invoice due date in yyyy-MM-ddThh:mm:ssZ format. | | `issuedDate` | string | Yes | — | Represents an invoice issued date in yyyy-MM-ddThh:mm:ssZ format. | | `number` | string | Yes | — | Represents an invoice number. | | `timeViewMode` | string | No | — | Time View Mode | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "clientId": { "type": "string", "description": "Represents a client identifier across the system." }, "currency": { "type": "string", "description": "Represents the currency used by the invoice." }, "dueDate": { "type": "string", "description": "Represents an invoice due date in yyyy-MM-ddThh:mm:ssZ format." }, "issuedDate": { "type": "string", "description": "Represents an invoice issued date in yyyy-MM-ddThh:mm:ssZ format." }, "number": { "type": "string", "description": "Represents an invoice number." }, "timeViewMode": { "type": "string", "description": "Time View Mode", "enum": [ "TIME_SENSITIVE_VIEW", "AGGREGATED_TIME_VIEW" ] } }, "required": [ "PCID", "workspaceId", "clientId", "currency", "dueDate", "issuedDate", "number" ] } ``` *** ## clockify\_finance\_create\_invoice\_payment Add payment to an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------ | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `amount` | integer | No | — | Represents an invoice payment amount as long. | | `note` | string | No | — | Represents an invoice payment note. | | `paymentDate` | string | No | — | Represents an invoice payment date in yyyy-MM-ddThh:mm:ssZ format. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "amount": { "type": "integer", "description": "Represents an invoice payment amount as long." }, "note": { "type": "string", "description": "Represents an invoice payment note." }, "paymentDate": { "type": "string", "description": "Represents an invoice payment date in yyyy-MM-ddThh:mm:ssZ format." } }, "required": [ "PCID", "workspaceId", "invoiceId" ] } ``` *** ## clockify\_finance\_delete\_category Delete an expense category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `categoryId` | string | Yes | — | Represents a category identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "categoryId": { "type": "string", "description": "Represents a category identifier across the system." } }, "required": [ "PCID", "workspaceId", "categoryId" ] } ``` *** ## clockify\_finance\_delete\_expense Delete an expense **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `expenseId` | string | Yes | — | Represents an expense identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "expenseId": { "type": "string", "description": "Represents an expense identifier across the system." } }, "required": [ "PCID", "workspaceId", "expenseId" ] } ``` *** ## clockify\_finance\_delete\_invoice Delete an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." } }, "required": [ "PCID", "workspaceId", "invoiceId" ] } ``` *** ## clockify\_finance\_delete\_payment\_by\_id Delete payment from an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `paymentId` | string | Yes | — | Represents a payment identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "paymentId": { "type": "string", "description": "Represents a payment identifier across the system." } }, "required": [ "PCID", "invoiceId", "workspaceId", "paymentId" ] } ``` *** ## clockify\_finance\_download\_file Download a receipt **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `fileId` | string | Yes | — | Represents a file identifier across the system. | | `expenseId` | string | Yes | — | Represents an expense identifier across the system. | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fileId": { "type": "string", "description": "Represents a file identifier across the system." }, "expenseId": { "type": "string", "description": "Represents an expense identifier across the system." }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." } }, "required": [ "PCID", "fileId", "expenseId", "workspaceId" ] } ``` *** ## clockify\_finance\_duplicate\_invoice Duplicate an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." } }, "required": [ "PCID", "invoiceId", "workspaceId" ] } ``` *** ## clockify\_finance\_export\_invoice Export an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `userLocale` | string | Yes | — | Represents a locale. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "userLocale": { "type": "string", "description": "Represents a locale." } }, "required": [ "PCID", "invoiceId", "workspaceId", "userLocale" ] } ``` *** ## clockify\_finance\_get\_categories Get all expense categories **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `sort-column` | string | No | — | Represents the column name to be used as sorting criteria. | | `sort-order` | string | No | — | Represents the sorting order. | | `page` | integer | No | — | Page number. | | `page-size` | integer | No | — | Page size. | | `archived` | boolean | No | — | Flag to filter results based on whether category is archived or not. | | `name` | string | No | — | If provided, you'll get a filtered list of expense categories that matches the provided string in their name. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "sort-column": { "type": "string", "description": "Represents the column name to be used as sorting criteria.", "enum": [ "NAME" ] }, "sort-order": { "type": "string", "description": "Represents the sorting order.", "enum": [ "ASCENDING", "DESCENDING" ] }, "page": { "type": "integer", "description": "Page number." }, "page-size": { "type": "integer", "description": "Page size." }, "archived": { "type": "boolean", "description": "Flag to filter results based on whether category is archived or not." }, "name": { "type": "string", "description": "If provided, you'll get a filtered list of expense categories that matches the provided string in their name." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## clockify\_finance\_get\_expense Get an expense by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `expenseId` | string | Yes | — | Represents an expense identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "expenseId": { "type": "string", "description": "Represents an expense identifier across the system." } }, "required": [ "PCID", "workspaceId", "expenseId" ] } ``` *** ## clockify\_finance\_get\_expenses Get all expenses on a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `page` | integer | No | — | Page number. | | `page-size` | integer | No | — | Page size. | | `user-id` | string | No | — | If provided, you'll get a filtered list of expenses which match the provided string in the user ID linked to the expense. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "page": { "type": "integer", "description": "Page number." }, "page-size": { "type": "integer", "description": "Page size." }, "user-id": { "type": "string", "description": "If provided, you'll get a filtered list of expenses which match the provided string in the user ID linked to the expense." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## clockify\_finance\_get\_invoice Get an invoice by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." } }, "required": [ "PCID", "workspaceId", "invoiceId" ] } ``` *** ## clockify\_finance\_get\_invoice\_settings Get an invoice in another language **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## clockify\_finance\_get\_invoices Get all invoices on a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `page` | integer | No | — | Page number. | | `page-size` | integer | No | — | Page size. | | `statuses` | string | No | — | If provided, you'll get a filtered result of invoices that matches the provided string in the user ID linked to the expense. | | `sort-column` | string | No | — | Valid column name as sorting criteria. Default: ID | | `sort-order` | string | No | — | Sort order. Default: ASCENDING | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "page": { "type": "integer", "description": "Page number." }, "page-size": { "type": "integer", "description": "Page size." }, "statuses": { "type": "string", "description": "If provided, you'll get a filtered result of invoices that matches the provided string in the user ID linked to the expense.", "enum": [ "UNSENT", "SENT", "PAID", "PARTIALLY_PAID", "VOID", "OVERDUE" ] }, "sort-column": { "type": "string", "description": "Valid column name as sorting criteria. Default: ID", "enum": [ "ID", "CLIENT", "DUE_ON", "ISSUE_DATE", "AMOUNT", "BALANCE" ] }, "sort-order": { "type": "string", "description": "Sort order. Default: ASCENDING", "enum": [ "ASCENDING", "DESCENDING" ] } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## clockify\_finance\_get\_invoices\_info Filter out invoices **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `clients` | object | No | — | Represents a project filter for imported items. | | `companies` | object | No | — | Represents a company filter object. If provided, you'll get a filtered list of invoices that matches the specified company filter. | | `exactAmount` | integer | No | — | Represents an invoice amount. If provided, you'll get a filtered list of invoices that has the equal amount as specified. | | `exactBalance` | integer | No | — | Represents an invoice balance. If provided, you'll get a filtered list of invoices that has the equal balance as specified. | | `greaterThanAmount` | integer | No | — | Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount greater than specified. | | `greaterThanBalance` | integer | No | — | Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance greater than specified. | | `invoiceNumber` | string | No | — | If provided, you'll get a filtered list of invoices that contain the provided string in their invoice number. | | `issueDate` | object | No | — | Represents a time range object. If provided, you'll get a filtered list of invoices that has issue date within the time range specified. | | `lessThanAmount` | integer | No | — | Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount less than specified. | | `lessThanBalance` | integer | No | — | Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance less than specified. | | `page` | integer | No | — | Page number. | | `pageSize` | integer | No | — | Page size. | | `sortColumn` | string | No | — | Represents the column name to be used as sorting criteria. | | `sortOrder` | string | No | — | Represents the sorting order. | | `statuses` | string\[] | No | — | 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 | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "clients": { "type": "object", "description": "Represents a project filter for imported items.", "properties": { "contains": { "type": "string", "description": "Filter type.", "enum": [ "CONTAINS", "DOES_NOT_CONTAIN", "CONTAINS_ONLY" ] }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Represents a list of filter identifiers." }, "status": { "type": "string", "description": "Filters entities by status.", "enum": [ "ACTIVE", "ARCHIVED", "ALL" ] } } }, "companies": { "type": "object", "description": "Represents a company filter object. If provided, you'll get a filtered list of invoices that matches the specified company filter.", "properties": { "contains": { "type": "string", "description": "Filter type.", "enum": [ "CONTAINS", "DOES_NOT_CONTAIN", "CONTAINS_ONLY" ] }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Represents a list of filter identifiers." } } }, "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." }, "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." }, "greaterThanAmount": { "type": "integer", "description": "Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount greater than specified." }, "greaterThanBalance": { "type": "integer", "description": "Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance greater than specified." }, "invoiceNumber": { "type": "string", "description": "If provided, you'll get a filtered list of invoices that contain the provided string in their invoice number." }, "issueDate": { "type": "object", "description": "Represents a time range object. If provided, you'll get a filtered list of invoices that has issue date within the time range specified.", "properties": { "issue-date-end": { "type": "string", "description": "Represents a date in yyyy-MM-dd format. This is the lower bound of the time range." }, "issue-date-start": { "type": "string", "description": "Represents a date in yyyy-MM-dd format. This is the lower bound of the time range." } } }, "lessThanAmount": { "type": "integer", "description": "Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount less than specified." }, "lessThanBalance": { "type": "integer", "description": "Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance less than specified." }, "page": { "type": "integer", "description": "Page number." }, "pageSize": { "type": "integer", "description": "Page size." }, "sortColumn": { "type": "string", "description": "Represents the column name to be used as sorting criteria.", "enum": [ "ID", "CLIENT", "DUE_ON", "ISSUE_DATE", "AMOUNT", "BALANCE" ] }, "sortOrder": { "type": "string", "description": "Represents the sorting order.", "enum": [ "ASCENDING", "DESCENDING" ] }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "UNSENT", "SENT", "PAID", "PARTIALLY_PAID", "VOID", "OVERDUE" ] }, "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." }, "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." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## clockify\_finance\_get\_payments\_for\_invoice Get payments for an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `page` | integer | No | — | Page number. | | `page-size` | integer | No | — | Page size. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "page": { "type": "integer", "description": "Page number." }, "page-size": { "type": "integer", "description": "Page size." } }, "required": [ "PCID", "workspaceId", "invoiceId" ] } ``` *** ## clockify\_finance\_import\_time\_entries\_and\_expenses Import time entries and expenses to an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `expenseFieldsForDetailedGroup` | string\[] | No | — | Represents a set of expense fields to include when using the DETAILED expense grouping type. | | `expensesGroupBy` | string | No | — | Represents a group field when using the GROUPED expense group type. | | `expensesGroupType` | string | No | — | Represents an expense group type. | | `from` | string | Yes | — | Represents date and time in the yyyy-MM-ddThh:mm:ssZ format. | | `importExpenses` | boolean | Yes | — | Indicates if billable expenses should be imported alongside time entries. | | `projectFilter` | object | Yes | — | Represents a project filter for imported items. | | `roundTimeEntryDuration` | boolean | No | — | Indicates if imported time entry durations should be rounded to the nearest 15 minute interval. | | `timeEntryFieldsForDetailedGroup` | string\[] | No | — | Represents a set of time entry fields to include when using DETAILED time entry grouping type. | | `timeEntryGroupType` | string | Yes | — | Represents a time entry group type. | | `timeEntryPrimaryGroupBy` | string | No | — | Represents a primary group field when using the GROUPED time entry grouping type. | | `timeEntrySecondaryGroupBy` | string | No | — | Represents a secondary group field when using the GROUPED time entry grouping type. Should not have the same grouping type as the primary group field. | | `to` | string | Yes | — | Represents date and time in the yyyy-MM-ddThh:mm:ssZ format. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "expenseFieldsForDetailedGroup": { "type": "array", "items": { "type": "string", "enum": [ "PROJECT", "TASK", "CATEGORY", "NOTE", "DATE", "USER" ] }, "description": "Represents a set of expense fields to include when using the DETAILED expense grouping type." }, "expensesGroupBy": { "type": "string", "description": "Represents a group field when using the GROUPED expense group type.", "enum": [ "CATEGORY", "PROJECT", "USER" ] }, "expensesGroupType": { "type": "string", "description": "Represents an expense group type.", "enum": [ "GROUPED", "DETAILED" ] }, "from": { "type": "string", "description": "Represents date and time in the yyyy-MM-ddThh:mm:ssZ format." }, "importExpenses": { "type": "boolean", "description": "Indicates if billable expenses should be imported alongside time entries." }, "projectFilter": { "type": "object", "description": "Represents a project filter for imported items.", "properties": { "contains": { "type": "string", "description": "Filter type.", "enum": [ "CONTAINS", "DOES_NOT_CONTAIN", "CONTAINS_ONLY" ] }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Represents a list of filter identifiers." }, "status": { "type": "string", "description": "Filters entities by status.", "enum": [ "ACTIVE", "ARCHIVED", "ALL" ] } } }, "roundTimeEntryDuration": { "type": "boolean", "description": "Indicates if imported time entry durations should be rounded to the nearest 15 minute interval." }, "timeEntryFieldsForDetailedGroup": { "type": "array", "items": { "type": "string", "enum": [ "PROJECT", "TASK", "TAGS", "DESCRIPTION", "DATE", "USER" ] }, "description": "Represents a set of time entry fields to include when using DETAILED time entry grouping type." }, "timeEntryGroupType": { "type": "string", "description": "Represents a time entry group type.", "enum": [ "SINGLE_ITEM", "GROUPED", "DETAILED" ] }, "timeEntryPrimaryGroupBy": { "type": "string", "description": "Represents a primary group field when using the GROUPED time entry grouping type.", "enum": [ "USER", "PROJECT", "DATE" ] }, "timeEntrySecondaryGroupBy": { "type": "string", "description": "Represents a secondary group field when using the GROUPED time entry grouping type. Should not have the same grouping type as the primary group field.", "enum": [ "PROJECT", "USER", "TASK", "DATE", "DESCRIPTION", "NONE" ] }, "to": { "type": "string", "description": "Represents date and time in the yyyy-MM-ddThh:mm:ssZ format." } }, "required": [ "PCID", "workspaceId", "invoiceId", "from", "importExpenses", "projectFilter", "timeEntryGroupType", "to" ] } ``` *** ## clockify\_finance\_remove\_invoice\_item Delete item from an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `order` | integer | Yes | — | Represents an invoice item order. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "order": { "type": "integer", "description": "Represents an invoice item order." } }, "required": [ "PCID", "workspaceId", "invoiceId", "order" ] } ``` *** ## clockify\_finance\_update\_category Update an expense category **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ----------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `categoryId` | string | Yes | — | Represents a category identifier across the system. | | `hasUnitPrice` | boolean | No | — | Flag whether expense category has unit price or none. | | `name` | string | Yes | — | Represents a valid expense category name. | | `priceInCents` | integer | No | — | Represents price in cents as integer. | | `unit` | string | No | — | Represents a valid expense category unit. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "categoryId": { "type": "string", "description": "Represents a category identifier across the system." }, "hasUnitPrice": { "type": "boolean", "description": "Flag whether expense category has unit price or none." }, "name": { "type": "string", "description": "Represents a valid expense category name." }, "priceInCents": { "type": "integer", "description": "Represents price in cents as integer." }, "unit": { "type": "string", "description": "Represents a valid expense category unit." } }, "required": [ "PCID", "workspaceId", "categoryId", "name" ] } ``` *** ## clockify\_finance\_update\_expense Update an expense **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ----------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `expenseId` | string | Yes | — | Represents an expense identifier across the system. | | `amount` | number | Yes | — | Represents an expense amount as the double data type. | | `billable` | boolean | No | — | Indicates whether expense is billable or not. | | `categoryId` | string | Yes | — | Represents a category identifier across the system. | | `changeFields` | string\[] | Yes | — | Represents a list of expense change fields. | | `date` | string | Yes | — | Provides a valid yyyy-MM-ddThh:mm:ssZ format date. | | `file` | string | Yes | — | The file value | | `notes` | string | No | — | Represents notes for an expense. | | `projectId` | string | No | — | Represents a project identifier across the system. | | `taskId` | string | No | — | Represents a task identifier across the system. | | `userId` | string | Yes | — | Represents a user identifier across the system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "expenseId": { "type": "string", "description": "Represents an expense identifier across the system." }, "amount": { "type": "number", "description": "Represents an expense amount as the double data type." }, "billable": { "type": "boolean", "description": "Indicates whether expense is billable or not." }, "categoryId": { "type": "string", "description": "Represents a category identifier across the system." }, "changeFields": { "type": "array", "items": { "type": "string", "enum": [ "USER", "DATE", "PROJECT", "TASK", "CATEGORY", "NOTES", "AMOUNT", "BILLABLE", "FILE" ] }, "description": "Represents a list of expense change fields." }, "date": { "type": "string", "description": "Provides a valid yyyy-MM-ddThh:mm:ssZ format date." }, "file": { "type": "string", "description": "The file value" }, "notes": { "type": "string", "description": "Represents notes for an expense." }, "projectId": { "type": "string", "description": "Represents a project identifier across the system." }, "taskId": { "type": "string", "description": "Represents a task identifier across the system." }, "userId": { "type": "string", "description": "Represents a user identifier across the system." } }, "required": [ "PCID", "workspaceId", "expenseId", "amount", "categoryId", "changeFields", "date", "file", "userId" ] } ``` *** ## clockify\_finance\_update\_expense\_category\_status Archive an expense category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `categoryId` | string | Yes | — | Represents a category identifier across the system. | | `archived` | boolean | No | — | Flag whether to archive the expense category or not. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "categoryId": { "type": "string", "description": "Represents a category identifier across the system." }, "archived": { "type": "boolean", "description": "Flag whether to archive the expense category or not." } }, "required": [ "PCID", "workspaceId", "categoryId" ] } ``` *** ## clockify\_finance\_update\_invoice Update an invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | -------------------------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `invoiceId` | string | Yes | — | Represents an invoice identifier across the system. | | `clientId` | string | No | — | Represents client identifier across the system. | | `companyId` | string | No | — | Represents company identifier across the system. | | `currency` | string | Yes | — | Represents the currency used by the invoice. | | `discountPercent` | number | Yes | — | Represents an invoice discount percent as double. | | `dueDate` | string | Yes | — | Represents an invoice due date in yyyy-MM-ddThh:mm:ssZ format. | | `issuedDate` | string | Yes | — | Represents an invoice issued date in yyyy-MM-ddThh:mm:ssZ format. | | `note` | string | No | — | Represents an invoice note. | | `number` | string | Yes | — | Represents an invoice number. | | `subject` | string | No | — | Represents an invoice subject. | | `tax2Percent` | number | Yes | — | Represents an invoice tax 2 percent as double. | | `taxPercent` | number | Yes | — | Represents an invoice tax percent as double. | | `taxType` | string | No | — | Represents an invoice taxation type. | | `visibleZeroFields` | string | No | — | Represents a list of zero value invoice fields that will be visible. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "invoiceId": { "type": "string", "description": "Represents an invoice identifier across the system." }, "clientId": { "type": "string", "description": "Represents client identifier across the system." }, "companyId": { "type": "string", "description": "Represents company identifier across the system." }, "currency": { "type": "string", "description": "Represents the currency used by the invoice." }, "discountPercent": { "type": "number", "description": "Represents an invoice discount percent as double." }, "dueDate": { "type": "string", "description": "Represents an invoice due date in yyyy-MM-ddThh:mm:ssZ format." }, "issuedDate": { "type": "string", "description": "Represents an invoice issued date in yyyy-MM-ddThh:mm:ssZ format." }, "note": { "type": "string", "description": "Represents an invoice note." }, "number": { "type": "string", "description": "Represents an invoice number." }, "subject": { "type": "string", "description": "Represents an invoice subject." }, "tax2Percent": { "type": "number", "description": "Represents an invoice tax 2 percent as double." }, "taxPercent": { "type": "number", "description": "Represents an invoice tax percent as double." }, "taxType": { "type": "string", "description": "Represents an invoice taxation type.", "enum": [ "COMPOUND", "SIMPLE", "NONE" ] }, "visibleZeroFields": { "type": "string", "description": "Represents a list of zero value invoice fields that will be visible.", "enum": [ "TAX", "TAX_2", "DISCOUNT" ] } }, "required": [ "PCID", "workspaceId", "invoiceId", "currency", "discountPercent", "dueDate", "issuedDate", "number", "tax2Percent", "taxPercent" ] } ``` *** ## clockify\_finance\_update\_invoice\_settings Change an invoice language **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `workspaceId` | string | Yes | — | Represents a workspace identifier across the system. | | `defaults` | object | No | — | Represents an invoice default settings object. | | `exportFields` | object | No | — | Represents an invoice export fields object. | | `labels` | object | Yes | — | Represents a label customization object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Represents a workspace identifier across the system." }, "defaults": { "type": "object", "description": "Represents an invoice default settings object.", "properties": { "companyId": { "type": "string", "description": "Represents company identifier across the system." }, "dueDays": { "type": "integer", "description": "Represents an invoice number of due days." }, "itemTypeId": { "type": "string", "description": "Represents item type identifier across the system." }, "notes": { "type": "string", "description": "Represents an invoice note." }, "subject": { "type": "string", "description": "Represents an invoice subject." }, "tax2Percent": { "type": "number", "description": "Represents a tax amount in percentage." }, "taxPercent": { "type": "number", "description": "Represents a tax amount in percentage." }, "taxType": { "type": "string", "description": "Represents a tax type.", "enum": [ "COMPOUND", "SIMPLE", "NONE" ] } }, "required": [ "notes", "subject" ] }, "exportFields": { "type": "object", "description": "Represents an invoice export fields object.", "properties": { "itemType": { "type": "boolean", "description": "Indicates whether to export item type." }, "quantity": { "type": "boolean", "description": "Indicates whether to export quantity." }, "rtl": { "type": "boolean", "description": "Indicates whether to export RTL." }, "tax": { "type": "boolean", "description": "Indicates whether to export tax." }, "tax2": { "type": "boolean", "description": "Indicates whether to export tax2." }, "unitPrice": { "type": "boolean", "description": "Indicates whether to export unit price." } } }, "labels": { "type": "object", "description": "Represents a label customization object.", "properties": { "amount": { "type": "string", "description": "Represents invoice amount label." }, "billFrom": { "type": "string", "description": "Represents invoice bill from label." }, "billTo": { "type": "string", "description": "Represents invoice bill to label." }, "description": { "type": "string", "description": "Represents invoice description label." }, "discount": { "type": "string", "description": "Represents invoice discount amount label." }, "dueDate": { "type": "string", "description": "Represents invoice due date label." }, "issueDate": { "type": "string", "description": "Represents invoice issue date label." }, "itemType": { "type": "string", "description": "Represents invoice item type label." }, "notes": { "type": "string", "description": "Represents invoice notes label." }, "paid": { "type": "string", "description": "Represents invoice paid amount label." }, "quantity": { "type": "string", "description": "Represents invoice quantity label." }, "subtotal": { "type": "string", "description": "Represents invoice subtotal label." }, "tax": { "type": "string", "description": "Represents invoice tax amount label." }, "tax2": { "type": "string", "description": "Represents invoice tax 2 amount label." }, "total": { "type": "string", "description": "Represents invoice total amount label." }, "totalAmountDue": { "type": "string", "description": "Represents invoice total amount due label." }, "unitPrice": { "type": "string", "description": "Represents invoice unit price label." } }, "required": [ "amount", "billFrom", "billTo", "description", "discount", "dueDate", "issueDate", "itemType", "notes", "paid", "quantity", "subtotal", "tax", "tax2", "total", "totalAmountDue", "unitPrice" ] } }, "required": [ "PCID", "workspaceId", "labels" ] } ```