Skip to main content
Server path: /clockify-finance | Type: Application | PCID required: Yes

Tools

ToolDescription
clockify_finance_add_invoice_itemAdd item to an invoice
clockify_finance_change_invoice_statusChange an invoice status
clockify_finance_create_expenseCreate an expense
clockify_finance_create_expense_categoryAdd an expense category
clockify_finance_create_invoiceAdd an invoice
clockify_finance_create_invoice_paymentAdd payment to an invoice
clockify_finance_delete_categoryDelete an expense category
clockify_finance_delete_expenseDelete an expense
clockify_finance_delete_invoiceDelete an invoice
clockify_finance_delete_payment_by_idDelete payment from an invoice
clockify_finance_download_fileDownload a receipt
clockify_finance_duplicate_invoiceDuplicate an invoice
clockify_finance_export_invoiceExport an invoice
clockify_finance_get_categoriesGet all expense categories
clockify_finance_get_expenseGet an expense by ID
clockify_finance_get_expensesGet all expenses on a workspace
clockify_finance_get_invoiceGet an invoice by ID
clockify_finance_get_invoice_settingsGet an invoice in another language
clockify_finance_get_invoicesGet all invoices on a workspace
clockify_finance_get_invoices_infoFilter out invoices
clockify_finance_get_payments_for_invoiceGet payments for an invoice
clockify_finance_import_time_entries_and_expensesImport time entries and expenses to an invoice
clockify_finance_remove_invoice_itemDelete item from an invoice
clockify_finance_update_categoryUpdate an expense category
clockify_finance_update_expenseUpdate an expense
clockify_finance_update_expense_category_statusArchive an expense category
clockify_finance_update_invoiceUpdate an invoice
clockify_finance_update_invoice_settingsChange an invoice language

clockify_finance_add_invoice_item

Add item to an invoice Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
invoiceIdstringYesRepresents an invoice identifier across the system.
applyTaxesstringYesRepresents taxes applied to the invoice item. Applies only when the specified taxes are active on the invoice.
descriptionstringYesRepresents an invoice item description.
itemTypestringYesRepresents an item type.
quantityintegerYesRepresents an item quantity.
unitPriceintegerYesRepresents an item unit price.

clockify_finance_change_invoice_status

Change an invoice status Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
invoiceIdstringYesRepresents an invoice identifier across the system.
invoiceStatusstringYesRepresents the invoice status to be set.

clockify_finance_create_expense

Create an expense Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
amountnumberYesRepresents an expense amount as the double data type.
billablebooleanNoIndicates whether expense is billable or not.
categoryIdstringYesRepresents a category identifier across the system.
datestringYesProvides a valid yyyy-MM-ddThh:mm:ssZ format date.
filestringYesThe file value
notesstringNoRepresents notes for an expense.
projectIdstringYesRepresents a project identifier across the system.
taskIdstringNoRepresents a task identifier across the system.
userIdstringYesRepresents a user identifier across the system.

clockify_finance_create_expense_category

Add an expense category Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
hasUnitPricebooleanNoFlag whether expense category has unit price or none.
namestringYesRepresents a valid expense category name.
priceInCentsintegerNoRepresents price in cents as integer.
unitstringNoRepresents a valid expense category unit.

clockify_finance_create_invoice

Add an invoice Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
clientIdstringYesRepresents a client identifier across the system.
currencystringYesRepresents the currency used by the invoice.
dueDatestringYesRepresents an invoice due date in yyyy-MM-ddThh:mm:ssZ format.
issuedDatestringYesRepresents an invoice issued date in yyyy-MM-ddThh:mm:ssZ format.
numberstringYesRepresents an invoice number.
timeViewModestringNoTime View Mode

clockify_finance_create_invoice_payment

Add payment to an invoice Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
invoiceIdstringYesRepresents an invoice identifier across the system.
amountintegerNoRepresents an invoice payment amount as long.
notestringNoRepresents an invoice payment note.
paymentDatestringNoRepresents an invoice payment date in yyyy-MM-ddThh:mm:ssZ format.

clockify_finance_delete_category

Delete an expense category Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
categoryIdstringYesRepresents a category identifier across the system.

clockify_finance_delete_expense

Delete an expense Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
expenseIdstringYesRepresents an expense identifier across the system.

clockify_finance_delete_invoice

Delete an invoice Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
invoiceIdstringYesRepresents an invoice identifier across the system.

clockify_finance_delete_payment_by_id

Delete payment from an invoice Parameters:
ParameterTypeRequiredDefaultDescription
invoiceIdstringYesRepresents an invoice identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
paymentIdstringYesRepresents a payment identifier across the system.

clockify_finance_download_file

Download a receipt Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesRepresents a file identifier across the system.
expenseIdstringYesRepresents an expense identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.

clockify_finance_duplicate_invoice

Duplicate an invoice Parameters:
ParameterTypeRequiredDefaultDescription
invoiceIdstringYesRepresents an invoice identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.

clockify_finance_export_invoice

Export an invoice Parameters:
ParameterTypeRequiredDefaultDescription
invoiceIdstringYesRepresents an invoice identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
userLocalestringYesRepresents a locale.

clockify_finance_get_categories

Get all expense categories Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
sort-columnstringNoRepresents the column name to be used as sorting criteria.
sort-orderstringNoRepresents the sorting order.
pageintegerNoPage number.
page-sizeintegerNoPage size.
archivedbooleanNoFlag to filter results based on whether category is archived or not.
namestringNoIf 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
expenseIdstringYesRepresents an expense identifier across the system.

clockify_finance_get_expenses

Get all expenses on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
pageintegerNoPage number.
page-sizeintegerNoPage size.
user-idstringNoIf 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
invoiceIdstringYesRepresents an invoice identifier across the system.

clockify_finance_get_invoice_settings

Get an invoice in another language Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.

clockify_finance_get_invoices

Get all invoices on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
pageintegerNoPage number.
page-sizeintegerNoPage size.
statusesstringNoIf provided, you’ll get a filtered result of invoices that matches the provided string in the user ID linked to the expense.
sort-columnstringNoValid column name as sorting criteria. Default: ID
sort-orderstringNoSort order. Default: ASCENDING

clockify_finance_get_invoices_info

Filter out invoices Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
clientsobjectNoRepresents a project filter for imported items.
companiesobjectNoRepresents a company filter object. If provided, you’ll get a filtered list of invoices that matches the specified company filter.
exactAmountintegerNoRepresents an invoice amount. If provided, you’ll get a filtered list of invoices that has the equal amount as specified.
exactBalanceintegerNoRepresents an invoice balance. If provided, you’ll get a filtered list of invoices that has the equal balance as specified.
greaterThanAmountintegerNoRepresents an invoice amount. If provided, you’ll get a filtered list of invoices that has amount greater than specified.
greaterThanBalanceintegerNoRepresents an invoice balance. If provided, you’ll get a filtered list of invoices that has balance greater than specified.
invoiceNumberstringNoIf provided, you’ll get a filtered list of invoices that contain the provided string in their invoice number.
issueDateobjectNoRepresents a time range object. If provided, you’ll get a filtered list of invoices that has issue date within the time range specified.
lessThanAmountintegerNoRepresents an invoice amount. If provided, you’ll get a filtered list of invoices that has amount less than specified.
lessThanBalanceintegerNoRepresents an invoice balance. If provided, you’ll get a filtered list of invoices that has balance less than specified.
pageintegerNoPage number.
pageSizeintegerNoPage size.
sortColumnstringNoRepresents the column name to be used as sorting criteria.
sortOrderstringNoRepresents the sorting order.
statusesstring[]NoRepresents a list of invoice statuses. If provided, you’ll get a filtered list of invoices that matches any of the invoice status provided.
strictSearchbooleanNoFlag 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
invoiceIdstringYesRepresents an invoice identifier across the system.
pageintegerNoPage number.
page-sizeintegerNoPage size.

clockify_finance_import_time_entries_and_expenses

Import time entries and expenses to an invoice Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
invoiceIdstringYesRepresents an invoice identifier across the system.
expenseFieldsForDetailedGroupstring[]NoRepresents a set of expense fields to include when using the DETAILED expense grouping type.
expensesGroupBystringNoRepresents a group field when using the GROUPED expense group type.
expensesGroupTypestringNoRepresents an expense group type.
fromstringYesRepresents date and time in the yyyy-MM-ddThh:mm:ssZ format.
importExpensesbooleanYesIndicates if billable expenses should be imported alongside time entries.
projectFilterobjectYesRepresents a project filter for imported items.
roundTimeEntryDurationbooleanNoIndicates if imported time entry durations should be rounded to the nearest 15 minute interval.
timeEntryFieldsForDetailedGroupstring[]NoRepresents a set of time entry fields to include when using DETAILED time entry grouping type.
timeEntryGroupTypestringYesRepresents a time entry group type.
timeEntryPrimaryGroupBystringNoRepresents a primary group field when using the GROUPED time entry grouping type.
timeEntrySecondaryGroupBystringNoRepresents a secondary group field when using the GROUPED time entry grouping type. Should not have the same grouping type as the primary group field.
tostringYesRepresents date and time in the yyyy-MM-ddThh:mm:ssZ format.

clockify_finance_remove_invoice_item

Delete item from an invoice Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
invoiceIdstringYesRepresents an invoice identifier across the system.
orderintegerYesRepresents an invoice item order.

clockify_finance_update_category

Update an expense category Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
categoryIdstringYesRepresents a category identifier across the system.
hasUnitPricebooleanNoFlag whether expense category has unit price or none.
namestringYesRepresents a valid expense category name.
priceInCentsintegerNoRepresents price in cents as integer.
unitstringNoRepresents a valid expense category unit.

clockify_finance_update_expense

Update an expense Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
expenseIdstringYesRepresents an expense identifier across the system.
amountnumberYesRepresents an expense amount as the double data type.
billablebooleanNoIndicates whether expense is billable or not.
categoryIdstringYesRepresents a category identifier across the system.
changeFieldsstring[]YesRepresents a list of expense change fields.
datestringYesProvides a valid yyyy-MM-ddThh:mm:ssZ format date.
filestringYesThe file value
notesstringNoRepresents notes for an expense.
projectIdstringNoRepresents a project identifier across the system.
taskIdstringNoRepresents a task identifier across the system.
userIdstringYesRepresents a user identifier across the system.

clockify_finance_update_expense_category_status

Archive an expense category Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
categoryIdstringYesRepresents a category identifier across the system.
archivedbooleanNoFlag whether to archive the expense category or not.

clockify_finance_update_invoice

Update an invoice Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
invoiceIdstringYesRepresents an invoice identifier across the system.
clientIdstringNoRepresents client identifier across the system.
companyIdstringNoRepresents company identifier across the system.
currencystringYesRepresents the currency used by the invoice.
discountPercentnumberYesRepresents an invoice discount percent as double.
dueDatestringYesRepresents an invoice due date in yyyy-MM-ddThh:mm:ssZ format.
issuedDatestringYesRepresents an invoice issued date in yyyy-MM-ddThh:mm:ssZ format.
notestringNoRepresents an invoice note.
numberstringYesRepresents an invoice number.
subjectstringNoRepresents an invoice subject.
tax2PercentnumberYesRepresents an invoice tax 2 percent as double.
taxPercentnumberYesRepresents an invoice tax percent as double.
taxTypestringNoRepresents an invoice taxation type.
visibleZeroFieldsstringNoRepresents a list of zero value invoice fields that will be visible.

clockify_finance_update_invoice_settings

Change an invoice language Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
defaultsobjectNoRepresents an invoice default settings object.
exportFieldsobjectNoRepresents an invoice export fields object.
labelsobjectYesRepresents a label customization object.