/clockify-finance | Type: Application | PCID required: Yes
Tools
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. |
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. |
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. |
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. |
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 |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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 |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |

