Freshbooks API Integration

These are the list of integration use cases supported by Knit for Freshbooks API as part of the ACCOUNTING category

Create Account

ID: create_general_ledger_account
Operation: write
Entities:
Summary: The Create Accounts API creates ledger accounts for a specified business UUID. The request requires an Authorization header with a Bearer token and a path parameter for the account ID. The response includes a data object created.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single Expense Category

ID: create_single_expense_category
Operation: write
Entities: expense
Summary: The API does not support creating single expense categories. Therefore, there are no request parameters or response details available for this operation.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single Gateway

ID: create_single_gateway
Operation: No Operation
Entities:
Summary: The API does not support creating gateways. Therefore, there are no request parameters or response details available for this operation.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single System

ID: create_single_system
Operation: write
Entities: system
Summary: The 'Create Single System' API is not available as part of our API offerings. Therefore, there are no request parameters or response details to provide.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Single Project

ID: delete_a_single_project
Operation: write
Entities: business, project
Summary: The 'Delete a Single Project' API allows users to delete a specific project associated with a business. The request requires the business ID and the project ID as path parameters. The response returns an empty object upon successful deletion, indicating that the project has been removed.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Time Entry

ID: delete_a_time_entry
Operation: write
Entities: business, time entry
Summary: The 'Delete a Time Entry' API allows users to delete a specific time entry associated with a business in FreshBooks. The request requires the business ID and the time entry ID as path parameters. Upon successful deletion, the API returns a 204 NO CONTENT status, indicating that the time entry has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a webhook callback

ID: delete_a_webhook_callback
Operation: write
Entities: webhook callback, account
Summary: The 'Delete a webhook callback' API allows users to delete a specific webhook callback associated with a FreshBooks account. The request requires the account ID and the callback ID as path parameters. The response is an empty object indicating that the deletion was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Other Income Entry

ID: delete_other_income_entry
Operation: write
Entities: account, other income
Summary: The 'Delete Other Income Entry' API allows users to delete a specific other income entry from their FreshBooks account. The request requires the account ID and the ID of the other income entry to be deleted as path parameters. An authorization token must be provided in the headers. Upon successful deletion, the API returns an empty response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Single Expense Category

ID: delete_single_expense_category
Operation: No Operation
Entities: expense category
Summary: The API does not support deleting single expense categories. Therefore, there are no request parameters or response details available for this operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Single Gateway

ID: delete_single_gateway
Operation: write
Entities: gateway, account, system
Summary: The 'Delete Single Gateway' API allows users to delete a specific gateway associated with a FreshBooks account. The request is made using the DELETE method to the endpoint 'https://api.freshbooks.com/accounting/account//systems/gateways/', where '' is the account ID and '' is the gateway ID. Once a gateway is deleted, it can only be re-enabled through the FreshBooks UI. The response returns an empty object indicating successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Single System

ID: delete_single_system
Operation: read
Entities: system
Summary: The 'Delete Single System' API is not available. Deleting systems is not supported as part of the API offerings.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Single Tax

ID: delete_single_tax
Operation: write
Entities: tax
Summary: The 'Delete Single Tax' API allows users to delete a specific tax from a FreshBooks account. The request requires the account ID and the tax ID as path parameters, and an authorization token in the headers. Upon successful deletion, the API returns an empty response body.
Input Fields: Input Fields
Output Fields: Output Fields

Get A Bill Payment

ID: get_a_bill_payment
Operation: read
Entities: account, bill payment, bill
Summary: The 'Get A Bill Payment' API retrieves details of a specific bill payment using the account ID and bill payment ID. The request requires an Authorization header with a Bearer token for authentication. The response includes details such as the amount, currency code, bill ID, payment ID, whether the payment is matched with an expense, any associated note, the date the bill was paid, the type of payment, and the visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Single Invoice Profile

ID: get_a_single_invoice_profile
Operation: read
Entities: customer, account, invoice profile
Summary: The 'Get a Single Invoice Profile' API retrieves the details of a specific invoice profile using the provided account ID and profile ID. The request requires authorization and specifies the API version and content type in the headers. The response includes detailed information about the invoice profile, such as creation date, owner ID, customer ID, organization, currency code, and more. The response body contains a nested structure with various attributes of the invoice profile, including billing details, address, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Single Project

ID: get_a_single_project
Operation: read
Entities: group, project, service
Summary: The 'Get a Single Project' API retrieves detailed information about a specific project within a business. The request requires the business ID and project ID as path parameters. The response includes comprehensive details about the project, such as its due date, links, fixed price, group information, description, completion status, title, project type, budget, update timestamp, sample status, services, rate, internal status, client ID, active status, creation timestamp, logged duration, project ID, and billing method.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Single Task

ID: get_a_single_task
Operation: read
Entities: account, project, task
Summary: The 'Get a Single Task' API retrieves details of a specific task using the provided account ID and task ID. The request is made using the GET method to the endpoint 'https://api.freshbooks.com/accounting/account/<account_id>/projects/tasks/<task_id>'. The path parameters 'account_id' and 'task_id' are required to identify the account and task respectively. The response includes details about the task such as its billable status, description, name, rate, tax values, and last updated timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Get A Single Time Entry

ID: get_a_single_time_entry
Operation: read
Entities: project, client, time entry
Summary: The 'Get A Single Time Entry' API retrieves a specific time entry for a given business. The request requires the business ID as a path parameter. The response includes details about the time entry such as the note, duration, project ID, client ID, whether it is logged, the start time, its active status, and timer details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Accounts

ID: get_accounts
Operation: read
Entities: sub account, account, journal entry account
Summary: The Get Accounts API retrieves a list of journal entry accounts for a specified account ID. The request requires an Authorization header with a Bearer token and a path parameter for the account ID. The response includes a list of accounts with details such as account name, number, type, balance, currency code, and sub-accounts. The response also includes pagination information with page, pages, per_page, and total fields.
Input Fields: Input Fields
Output Fields: Output Fields

Get Bills

ID: get_bills
Operation: read
Entities: amount, bill, category
Summary: The Get Bills API retrieves a list of bills for a specified account. The request requires an Authorization header with a Bearer token and a path parameter for the accountId. The response includes detailed information about each bill, such as the amount, currency, bill number, creation date, due date, and status. Each bill may contain multiple line items, each with its own amount, category, description, and unit cost. The response also provides pagination details, including the current page, total pages, items per page, and total number of bills.
Input Fields: Input Fields
Output Fields: Output Fields

Check Online Payment Gateways Available

ID: get_check_online_payment_gateways_available
Operation: read
Entities: gateway, payment option, invoice
Summary: The 'Check Online Payment Gateways Available' API allows users to retrieve the available payment gateways for a specific account and entity type, such as an invoice. The request requires the account ID as a path parameter and the entity type as a query parameter. The response provides details about the available payment options, including the gateway name, supported payment methods (credit card, ACH transfer, etc.), and whether partial payments are allowed.
Input Fields: Input Fields
Output Fields: Output Fields

Get Client Profile and Associated Secondary Contacts

ID: get_client_profile_and_associated_secondary_contacts
Operation: read
Entities: contact, client
Summary: This API endpoint retrieves the client profiles and their associated secondary contacts for a specified account in FreshBooks. The request is made using the GET method to the endpoint 'https://api.freshbooks.com/accounting/account//users/clients/?include[]=recent_contacts'. The request requires an Authorization header with a Bearer token for authentication and a path parameter 'accountId' to specify the account. Optionally, query parameters can include additional data such as 'recent_contacts'. The response includes a list of clients with detailed information such as their ID, name, organization, contact details, and preferences.
Input Fields: Input Fields
Output Fields: Output Fields

Get Companies Information

ID: get_companies_info
Operation:
Entities:
Summary: The Get Companies Information API retrieves detailed information about the authenticated user and their associated business entities. It requires a GET request to the endpoint 'https://api.freshbooks.com/auth/api/v1/users/me' with headers for Authorization, Api-Version, and Content-Type. The response includes user details such as ID, profile information, email, confirmation and creation timestamps, phone numbers, addresses, professions, links, permissions, groups, subscription statuses, integrations, business memberships, and roles. Each of these fields provides comprehensive data about the user's identity and associated business entities.
Input Fields: Input Fields
Output Fields: Output Fields

Get the Default Invoice Payment Options

ID: get_default_invoice_payment_options
Operation: read
Entities: gateway, payment option, invoice
Summary: The 'Get the Default Invoice Payment Options' API retrieves the default payment options available for invoices in a specified account. The request requires the account ID as a path parameter and the entity type as a query parameter, which should be 'invoice'. The response includes details about the payment gateway, such as whether credit card, ACH transfer, BACS debit, SEPA debit, and PayPal Smart Checkout are enabled, as well as whether partial payments are allowed. It also provides the entity type and ID for which these options are applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Example Identity Info Call

ID: get_example_identity_info_call
Operation: read
Entities: business, profile, user
Summary: The Example Identity Info Call API retrieves detailed information about the authenticated user. It requires a GET request to the endpoint 'https://api.freshbooks.com/auth/api/v1/users/me' with headers for Authorization, Api-Version, and Content-Type. The response includes user details such as ID, profile information, email, confirmation and creation timestamps, phone numbers, addresses, professions, links, permissions, groups, subscription statuses, integrations, business memberships, and roles. Each of these fields provides comprehensive data about the user's identity and associated business entities.
Input Fields: Input Fields
Output Fields: Output Fields

Example Includes

ID: get_example_includes
Operation: read
Entities: gateway, payment, invoice
Summary: The Example Includes API allows users to retrieve invoices and payments with optional additional data included in the response. Users can specify which additional data to include using the 'include' query parameter, such as 'lines' for invoice lines, 'allowed_gateways' for payment gateways, or 'invoice' for invoice details on payments. The API requires an account ID as a path parameter and authentication via a Bearer token in the headers.
Input Fields: Input Fields
Output Fields: Output Fields

Example Paging for Invoices

ID: get_example_paging_for_invoices
Operation: read
Entities: invoice
Summary: The Example Paging for Invoices API allows users to retrieve a paginated list of invoices for a specific account. Users can specify the page number and the number of invoices per page using the 'page' and 'per_page' query parameters, respectively. The API returns a list of invoices, each with details such as invoice ID, amount, and status. The response also includes metadata about the total number of invoices, the current page, and the number of invoices per page. Invalid page numbers may result in an error.
Input Fields: Input Fields
Output Fields: Output Fields

Example Searches for Accounting Endpoint

ID: get_example_searches_for_accounting_endpoint
Operation: read
Entities: tax, invoice, client
Summary: The Example Searches for Accounting Endpoint API allows users to perform searches on invoices, clients, and taxes within a specified account. Users can filter invoices by ID, date range, and multiple IDs. They can also search for clients with outstanding amounts and compound taxes. The API requires an account ID as a path parameter and supports various search parameters as query parameters. The response includes lists of invoices, clients, and taxes that match the search criteria.
Input Fields: Input Fields
Output Fields: Output Fields

Example Searches for Timetracking Endpoint

ID: get_example_searches_timetracking_endpoint
Operation: read
Entities: project, time entry
Summary: The Example Searches for Timetracking Endpoint API allows users to search for projects and time entries based on various criteria. Users can filter projects by completion status, update date, and active status. Time entries can be filtered by billing status and start date range. The API requires an Authorization header with a Bearer token for authentication and a business ID as a path parameter. The response includes details of the projects and time entries that match the search criteria.
Input Fields: Input Fields
Output Fields: Output Fields

Example Sort (accounting endpoint)

ID: get_example_sort_accounting_endpoint
Operation: read
Entities: field, invoice
Summary: The Example Sort (accounting endpoint) API allows users to sort invoices by a specified field and order. The endpoint requires the account ID as a path parameter and a sort query parameter that specifies the field and order (ascending or descending) to sort by. The response includes a list of invoices sorted according to the specified criteria, with each invoice containing its unique ID and date.
Input Fields: Input Fields
Output Fields: Output Fields

Example Sort (project endpoint)

ID: get_example_sort_project_endpoint
Operation: read
Entities: business, project, date
Summary: The Example Sort (project endpoint) API allows users to retrieve a list of projects for a specific business, sorted by their due dates. The API endpoint requires a business ID as a path parameter and supports an optional query parameter 'sort' to specify the order of sorting. The 'sort' parameter can be set to 'due_date' for ascending order or '-due_date' for descending order. The request must include an Authorization header with a Bearer token. The response includes a list of projects with their IDs, names, and due dates.
Input Fields: Input Fields
Output Fields: Output Fields

Including the next issue date

ID: get_including_the_next_issue_date
Operation: read
Entities: issue date, account, invoice profile
Summary: This API endpoint retrieves invoice profiles for a specified account, including the next issue date if requested. The request requires an account ID as a path parameter and an authorization token in the headers. The 'include' query parameter can be used to specify additional fields to include in the response, such as 'next_issue_date'. The response includes a list of invoice profiles with their IDs and next issue dates.
Input Fields: Input Fields
Output Fields: Output Fields

Get Journal Entry Details

ID: get_journal_entry_details
Operation: read
Entities: journal entry, account, sub account
Summary: The 'Get Journal Entry Details' API retrieves detailed information about journal entries for a specified account. The request requires an Authorization header with a Bearer token and a path parameter for the account ID. The response includes a list of journal entry details, each containing information about the account, balance, credit, debit, description, detail type, entry, and sub-account. The response also includes pagination details such as the current page, total pages, items per page, and total items.
Input Fields: Input Fields
Output Fields: Output Fields

List all Credits

ID: get_list_all_credits
Operation: read
Entities: payment, client, credit note
Summary: The 'List all Credits' API retrieves all credit notes associated with a specific account. It requires an account ID as a path parameter and an authorization bearer token in the headers. The response includes a list of credit notes with details such as the credit note ID, amount, client information, creation date, status, and more. Each credit note contains information about the client, the amount credited, the currency, and the status of the credit note.
Input Fields: Input Fields
Output Fields: Output Fields

List all webhook callbacks

ID: get_list_all_webhook_callbacks
Operation: read
Entities: event, callback, webhook
Summary: The 'List all webhook callbacks' API retrieves a list of all webhook callbacks associated with a specific account. The request requires the account ID as a path parameter. The response includes pagination details such as the number of callbacks per page, total pages, total callbacks, and the current page number. Each callback includes details such as callback ID, verification status, URI, and the event it is associated with.
Input Fields: Input Fields
Output Fields: Output Fields

List Bill Payments

ID: get_list_bill_payments
Operation: read
Entities: account, bill payment, bill
Summary: The 'List Bill Payments' API retrieves a list of bill payments for a specified account. The request requires an Authorization header with a Bearer token and a path parameter 'accountId' to specify the account. The response includes details of each bill payment such as the amount, bill ID, payment ID, whether it is matched with an expense, any associated notes, the date of payment, the type of payment, and the visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

List Clients

ID: get_list_clients
Operation: read
Entities: account, client, user
Summary: The List Clients API retrieves a list of clients associated with a specific account in FreshBooks. The request requires a path parameter for the accountId and optional query parameters for pagination, including page and per_page. The response includes detailed information about each client, such as their contact details, organization, preferences, and account status. The response is paginated, providing metadata about the current page, total pages, and total number of clients.
Input Fields: Input Fields
Output Fields: Output Fields

List Estimates

ID: get_list_estimates
Operation: read
Entities: account, estimate
Summary: The List Estimates API retrieves a list of estimates for a specified account. The request requires an account ID as a path parameter and an authorization bearer token in the headers. The response includes a list of estimates, the number of estimates per page, the total number of estimates, the current page number, and the total number of pages.
Input Fields: Input Fields
Output Fields: Output Fields

List Expense Categories

ID: get_list_expense_categories
Operation: read
Entities: account, expense, category
Summary: The 'List Expense Categories' API retrieves a list of expense categories for a specified account. The request requires the account ID as a path parameter. The response includes pagination details such as the number of categories per page, total number of categories, current page number, and total number of pages. The categories are returned in an array format.
Input Fields: Input Fields
Output Fields: Output Fields

List Expenses

ID: get_list_expenses
Operation: read
Entities: account, expense
Summary: The List Expenses API retrieves a list of expenses for a specified account. The request requires the account ID as a path parameter. The response includes pagination details such as the number of expenses per page, total number of pages, total number of expenses, and the current page number. The expenses are returned in an array, each in the same format as a single expense.
Input Fields: Input Fields
Output Fields: Output Fields

List Gateways

ID: get_list_gateways
Operation: read
Entities: gateway, account, system
Summary: The 'List Gateways' API retrieves a list of payment gateways associated with a specific account. The request requires an account ID as a path parameter and an authorization token in the headers. The response includes details about the gateways such as SGID, connection ID, gateway name, and ID, along with pagination information like the number of gateways per page, total pages, and the current page number.
Input Fields: Input Fields
Output Fields: Output Fields

List Invoices

ID: get_list_invoices
Operation: read
Entities: customer, invoice, account
Summary: The List Invoices API retrieves a list of invoices for a specified account. The request requires a path parameter for the accountId. Optional query parameters include 'page' for the page number and 'per_page' to specify the number of invoices per page, defaulting to 100. The response includes detailed information about each invoice, such as the invoice number, amount, currency, status, and customer details. The response also provides pagination information, including the current page, total pages, and total number of invoices.
Input Fields: Input Fields
Output Fields: Output Fields

List Items

ID: get_list_items
Operation: read
Entities: account, item, page
Summary: The List Items API retrieves a list of items for a specified account ID. The request requires the account ID as a path parameter. The response includes a list of items, the total number of pages, the total number of items, the current page number, and the number of items per page.
Input Fields: Input Fields
Output Fields: Output Fields

List Other Income Entries

ID: get_list_other_income_entries
Operation: read
Entities: amount, tax, other income
Summary: The 'List Other Income Entries' API retrieves a list of other income entries for a specified account. The request requires an account ID as a path parameter and authentication via a Bearer token in the headers. The response includes details of each income entry such as amount, category, date, payment type, source, and associated taxes. The response is structured in a JSON format with each income entry containing fields like 'amount', 'category_name', 'created_at', 'date', 'incomeid', 'note', 'payment_type', 'source', 'sourceid', 'taxes', 'updated_at', 'userid', and 'vis_state'.
Input Fields: Input Fields
Output Fields: Output Fields

List Payments

ID: get_list_payments
Operation: read
Entities: payment, account
Summary: The List Payments API retrieves a list of payments for a specified account. The request requires the account ID as a path parameter. The response includes pagination details such as the number of payments per page, total pages, total payments, and the current page number. The payments are returned in an array, each containing details such as accounting system ID, amount, client ID, date, payment type, and more. Each payment object provides comprehensive information about the transaction.
Input Fields: Input Fields
Output Fields: Output Fields

List Projects

ID: get_list_projects
Operation: read
Entities: business, project
Summary: The List Projects API retrieves a list of projects for a specified business. The request requires a valid business ID as a path parameter and an authorization token in the headers. The response includes metadata about pagination and a list of projects in the specified business. The metadata contains information such as the number of projects per page, total projects, current page, and total pages.
Input Fields: Input Fields
Output Fields: Output Fields

List Services

ID: get_list_services
Operation: read
Entities: business, service
Summary: The List Services API retrieves a list of services associated with a specific business. The request requires the business ID as a path parameter. The response includes an array of services, each with details such as business ID, service ID, name, billable status, and visibility state. Additionally, metadata about the total number of services, number of services per page, current page, and total pages is provided.
Input Fields: Input Fields
Output Fields: Output Fields

List Staff

ID: get_list_staff
Operation: read
Entities: user, account, staff
Summary: The List Staff API retrieves a list of staff members for a specified account. The request requires the account ID as a path parameter. The response includes pagination details such as the number of staff members per page, total pages, total staff members, and the current page number. The staff members are returned in an array format.
Input Fields: Input Fields
Output Fields: Output Fields

List Taxes

ID: get_list_taxes
Operation: read
Entities: tax
Summary: The 'List Taxes' API endpoint retrieves a list of taxes associated with a specific account. The request requires the account ID as a path parameter. The response includes pagination details such as the number of taxes per page, total number of taxes, current page number, and total number of pages. The 'taxes' field contains an array of tax objects, each with details such as accounting system ID, amount, compound status, tax ID, name, number, and the last updated timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

List Team Members

ID: get_list_team_members
Operation: read
Entities: team member, business, role
Summary: The 'List Team Members' API endpoint retrieves a list of team members associated with a specific business. The request requires a valid Bearer token for authentication and the business ID as a path parameter. The response includes details of each team member such as their UUID, name, email, job title, address, phone number, business role, and timestamps for creation and last update. The response also includes pagination metadata indicating the current page, number of items per page, and total number of items.
Input Fields: Input Fields
Output Fields: Output Fields

List Time Entries

ID: get_list_time_entries
Operation: read
Entities: project, client, time entry
Summary: The 'List Time Entries' API retrieves a list of time entries for a specified business. The request requires an Authorization header with a Bearer token and a path parameter for the business ID. The response includes an array of time entries, each with details such as note, duration, project ID, client ID, and timer status. The response also includes metadata about pagination and total logged and unbilled time.
Input Fields: Input Fields
Output Fields: Output Fields

List Time Entries From A Specific Day

ID: get_list_time_entries_from_a_specific_day
Operation: read
Entities: project, client, time entry
Summary: The 'List Time Entries From A Specific Day' API retrieves time entries for a specific business within a specified date range. The request requires the business ID as a path parameter and the start and end date-time as query parameters in ISO 8601 format. The response includes a list of time entries with details such as note, duration, project ID, client ID, and timer status, along with metadata about pagination and total logged/unbilled time.
Input Fields: Input Fields
Output Fields: Output Fields

List Time Entries Update From A Particular Time

ID: get_list_time_entries_update_from_a_particular_time
Operation: read
Entities: meta, timer, time entry
Summary: The 'List Time Entries Update From A Particular Time' API allows users to retrieve a list of time entries that have been updated since a specified timestamp for a particular business. The request requires the 'business_id' as a path parameter and 'updated_since' as a query parameter to specify the timestamp. An optional 'include_deleted' query parameter can be used to include deleted time entries in the response. The response includes a list of time entries with details such as note, duration, project ID, client ID, start time, and timer status, along with metadata about the pagination and total time logged and unbilled.
Input Fields: Input Fields
Output Fields: Output Fields

Listing Invoice Profiles

ID: get_listing_invoice_profiles
Operation: read
Entities: account, invoice profile
Summary: The 'Listing Invoice Profiles' API retrieves a list of invoice profiles for a specified account. It requires an authorization token, API version, and content type in the headers. The account ID is specified as a path parameter. The response includes the total number of invoice profiles, the number of profiles per page, the list of invoice profiles, the current page number, and the total number of pages.
Input Fields: Input Fields
Output Fields: Output Fields

Listing Tasks

ID: get_listing_tasks
Operation: read
Entities: account, project, task
Summary: The 'Listing Tasks' API endpoint allows users to retrieve a list of tasks associated with a specific account. The request is made using the GET method to the URL 'https://api.freshbooks.com/accounting/account/<account_id>/projects/tasks', where '<account_id>' is a path parameter representing the unique identifier for the account. The response includes details such as the total number of tasks, the number of tasks per page, the current page number, and the total number of pages. The tasks are returned as an array within the response body.
Input Fields: Input Fields
Output Fields: Output Fields

See Payment Options on an Invoice

ID: get_payment_options_on_an_invoice
Operation: read
Entities: invoice, payment option, gateway info
Summary: The 'See Payment Options on an Invoice' API allows users to retrieve the available payment options for a specific invoice. The API requires the account ID and invoice ID as path parameters. It returns a JSON object containing details about the payment gateway, available payment methods (such as credit card, ACH transfer, BACS debit, SEPA debit, and PayPal Smart Checkout), and whether partial payments are allowed. The response also includes the entity type and ID, along with additional gateway information.
Input Fields: Input Fields
Output Fields: Output Fields

Search example with clientid

ID: get_search_example_with_clientid
Operation: read
Entities: account, client, invoice profile
Summary: The 'Search example with clientid' API allows users to search for invoice profiles associated with a specific client ID within a given account. The request requires an account ID as a path parameter and a client ID as a query parameter. The response returns a list of invoice profiles that match the specified client ID, including details such as the profile ID, client ID, and profile name.
Input Fields: Input Fields
Output Fields: Output Fields

Search example with currency code

ID: get_search_example_with_currency_code
Operation: read
Entities: account, currency code, invoice profile
Summary: The 'Search example with currency code' API allows users to retrieve invoice profiles for a specific account, filtered by a specified currency code. The request requires an account ID as a path parameter and a currency code as a query parameter. The response includes a list of invoice profiles that match the specified currency code, each with details such as ID, currency code, and name.
Input Fields: Input Fields
Output Fields: Output Fields

Search Examples for Tasks

ID: get_search_examples_for_tasks
Operation: read
Entities: project, task
Summary: The Search Examples for Tasks API allows users to query tasks within a specific account based on various search criteria. Users can filter tasks by their billable status or by specifying a rate range using the query parameters 'search[billable]', 'search[rate_min]', and 'search[rate_max]'. The API requires an account ID as a path parameter and an authorization token in the headers. The response includes a list of tasks that match the search criteria, with details such as task ID, name, billable status, and rate.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Bill

ID: get_single_bill
Operation: read
Entities: amount, bill, category
Summary: The 'Get Single Bill' API retrieves detailed information about a specific bill from the FreshBooks accounting system. The request requires the account ID and bill ID as path parameters, and an authorization bearer token in the headers. The response includes comprehensive details about the bill, such as the amount, currency, bill number, creation and update timestamps, due date, issue date, language, line items with their respective details, outstanding amount, overall category and description, paid amount, status, tax amount, and total amount.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Client

ID: get_single_client
Operation: read
Entities: account, client, user
Summary: The 'Get Single Client' API retrieves detailed information about a specific client associated with a FreshBooks account. The request requires the account ID and customer ID as path parameters, and an authorization bearer token in the headers. The response includes comprehensive details about the client, such as their contact information, preferences, and account settings.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Estimate

ID: get_single_estimate
Operation: read
Entities: customer, account, estimate
Summary: The 'Get Single Estimate' API retrieves a specific estimate from the FreshBooks accounting system using the provided account ID and estimate ID. The request is made using the GET method to the endpoint 'https://api.freshbooks.com/accounting/account//estimates/estimates/'. The response includes detailed information about the estimate, such as its status, creation date, owner ID, VAT details, organization, and financial amounts. The response is structured in a nested JSON format, providing comprehensive details about the estimate.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Expense

ID: get_single_expense
Operation: read
Entities: tax, account, expense
Summary: The 'Get Single Expense' API retrieves details of a specific expense from the FreshBooks accounting system. It requires the account ID and expense ID as path parameters. The response includes detailed information about the expense, such as category ID, markup percentage, project ID, client ID, tax details, vendor, amount, and more. The response is structured in a nested JSON format under the 'response' and 'result' keys, with the 'expense' object containing all the relevant details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Expense Category

ID: get_single_expense_category
Operation: read
Entities: expense, category
Summary: The 'Get Single Expense Category' API retrieves details of a specific expense category by its ID for a given account. The request is made using the GET method to the endpoint 'https://api.freshbooks.com/accounting/account//expenses/categories/'. The path parameters 'accountid' and 'id' are required to specify the account and the expense category respectively. The response includes details such as the category name, category ID, editability, cost of goods sold status, parent ID, and visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Gateway

ID: get_single_gateway
Operation: read
Entities: gateway
Summary: The 'Get Single Gateway' API is not supported. This means that there is no functionality available to retrieve a single gateway using this API.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Invoice

ID: get_single_invoice
Operation: read
Entities: customer, invoice, account
Summary: The 'Get Single Invoice' API retrieves detailed information about a specific invoice using the provided account ID and invoice ID. The request requires an Authorization header with a Bearer token. The response includes comprehensive details about the invoice, such as its status, creation date, outstanding amount, payment status, owner information, and more. The invoice details are returned in a structured JSON format, providing insights into various attributes like the invoice number, customer ID, organization, due date, and total amount.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Item

ID: get_single_item
Operation: read
Entities: unit cost, account, item
Summary: The 'Get Single Item' API retrieves details of a specific item from the FreshBooks accounting system. It requires the account ID and the item ID as path parameters. The response includes detailed information about the item such as its name, quantity, SKU, unit cost, taxes, and description.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Other Income

ID: get_single_other_income
Operation: read
Entities: tax, account, other income
Summary: The 'Get Single Other Income' API retrieves details of a specific other income entry for a given account. It requires the account ID and income ID as path parameters and an authorization token in the headers. The response includes details such as the amount, currency code, category name, creation and update timestamps, payment type, source, and any applicable taxes.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Payment

ID: get_single_payment
Operation: read
Entities: invoice, client, payment
Summary: The Get Single Payment API retrieves the details of a specific payment using the payment ID and account ID. The path parameters include the account ID and the payment ID. The request body includes the payment amount and a note indicating the updated invoice amount. The response includes detailed information about the payment, such as the amount, currency code, client ID, date, and type of payment, among other details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Service

ID: get_single_service
Operation: read
Entities: business, service
Summary: The 'Get Single Service' API retrieves details of a specific service for a given business. The request requires the business ID and service ID as path parameters. The response includes the service details such as business ID, service ID, name, billable status, and visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Service Rate

ID: get_single_service_rate
Operation: read
Entities: business, service rate, service
Summary: The 'Get Single Service Rate' API retrieves the rate for a specific service associated with a business. It requires the business ID and service ID as path parameters. The response includes the service rate, business ID, and service ID.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Staff

ID: get_single_staff
Operation: read
Entities: user, account, staff
Summary: The 'Get Single Staff' API retrieves details of a specific staff member in a FreshBooks account. It requires the account ID and staff ID as path parameters and an authorization token in the headers. The response includes detailed information about the staff member, such as their contact information, login details, and organizational role.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Tax

ID: get_single_tax
Operation: read
Entities: result, account, tax
Summary: The 'Get Single Tax' API retrieves details of a specific tax using the provided account ID and tax ID. The request is made using the GET method to the endpoint 'https://api.freshbooks.com/accounting/account//taxes/taxes/'. The path parameters include 'accountid' which is the ID of the account, and 'id' which is the ID of the tax. The response includes details of the tax such as 'accounting_systemid', 'updated' timestamp, 'name', 'number', 'taxid', 'amount', 'compound' status, and 'id'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Team Member

ID: get_single_team_member
Operation: read
Entities: team member, business
Summary: The 'Get Single Team Member' API retrieves details of a specific team member within a business. It requires the business ID and the team member's UUID as path parameters. The response includes detailed information about the team member, such as their name, email, job title, address, and role within the business. The API does not require any specific headers, query parameters, or request body.
Input Fields: Input Fields
Output Fields: Output Fields

Get System

ID: get_system
Operation: read
Entities: user, account, system
Summary: The Get System API retrieves detailed information about a specific system associated with a given account. The request requires the account ID and the system ID as path parameters. The response includes comprehensive details about the system, such as its code, payment frequency, address, timezone, email, business type, and billing status, among other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Test Call

ID: get_test_call
Operation: read
Entities: version, user
Summary: The Test Call API is a GET request to the endpoint 'https://api.freshbooks.com/test'. It requires two headers: 'Authorization' with a Bearer token for authorization, and 'Api-Version' specifying the version of the API. The response includes the API version and user details such as first name, last name, and email.
Input Fields: Input Fields
Output Fields: Output Fields

List Expense Categories

ID: get_tracking_categories
Operation: read
Entities:
Summary: The 'List Expense Categories' API retrieves a list of expense categories for a specified account. The request requires the account ID as a path parameter. The response includes pagination details such as the number of categories per page, total number of categories, current page number, and total number of pages. The categories are returned in an array format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Vendors

ID: get_vendors
Operation: read
Entities: contact, balance, vendor
Summary: The Get Vendors API retrieves a list of vendors associated with a specific account in FreshBooks. The API requires an account ID as a path parameter. Optional query parameters include 'page' for the page number and 'per_page' for the number of items per page, with a default of 100 items per page. The response includes detailed information about each vendor, such as account number, contact details, outstanding and overdue balances, tax defaults, and more. The response is paginated, providing metadata like the current page, total pages, items per page, and total number of vendors.
Input Fields: Input Fields
Output Fields: Output Fields

Get Bills

ID: list_accounts_payable_invoices
Operation: read
Entities:
Summary: The Get Bills API retrieves a list of bills for a specified account. The request requires an Authorization header with a Bearer token and a path parameter for the accountId. The response includes detailed information about each bill, such as the amount, currency, bill number, creation date, due date, and status. Each bill may contain multiple line items, each with its own amount, category, description, and unit cost. The response also provides pagination details, including the current page, total pages, items per page, and total number of bills.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Account

ID: list_general_ledger_accounts
Operation: read
Entities:
Summary: The Get Accounts API retrieves a list of ledger accounts for a specified account ID. The request requires an Authorization header with a Bearer token and a path parameter for the account ID. The response includes a list of accounts with details such as account name, number, type, balance, currency code, and sub-accounts.
Input Fields: Input Fields
Output Fields: Output Fields

Get Journal Entry Details

ID: list_journal_entries
Operation: read
Entities:
Summary: The 'Get Journal Entry Details' API retrieves detailed information about journal entries for a specified account. The request requires an Authorization header with a Bearer token and a path parameter for the account ID. The response includes a list of journal entry details, each containing information about the account, balance, credit, debit, description, detail type, entry, and sub-account. The response also includes pagination details such as the current page, total pages, items per page, and total items.
Input Fields: Input Fields
Output Fields: Output Fields

List Systems

ID: list_systems
Operation: read
Entities: system
Summary: The 'List Systems' API is mentioned in the documentation, but there is no defined System List call available in the API. Therefore, there are no details regarding the URL, method, input parameters, or output for this API.
Input Fields: Input Fields
Output Fields: Output Fields

List Bill Payments

ID: list_vendor_payments
Operation: read
Entities:
Summary: The 'List Bill Payments' API retrieves a list of bill payments for a specified account. The request requires an Authorization header with a Bearer token and a path parameter 'accountId' to specify the account. The response includes details of each bill payment such as the amount, bill ID, payment ID, whether it is matched with an expense, any associated notes, the date of payment, the type of payment, and the visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Add a Service Rate

ID: post_add_a_service_rate
Operation: write
Entities: business, service rate, service
Summary: The 'Add a Service Rate' API allows users to set a rate for a specific service within a business. The request is made to the endpoint 'https://api.freshbooks.com/comments/business//service//rate' using the POST method. The path parameters include 'businessid' and 'serviceid', which are required to identify the business and the service respectively. The request body must include 'service_rate' with a 'rate' field specifying the rate for the service. The response does not specify any particular headers or body content.
Input Fields: Input Fields
Output Fields: Output Fields

Add Journal Entry

ID: post_add_journal_entry
Operation: write
Entities: sub account, detail, journal entry
Summary: The 'Add Journal Entry' API allows users to create a new journal entry in the FreshBooks accounting system. The API requires a POST request to the specified URL with the account ID as a path parameter. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' bearer token. The request body must contain a 'journal_entry' object with details such as 'details' (an array of sub-account IDs with debit or credit amounts), 'currency_code', 'description', 'name', and 'user_entered_date'. The response returns the created journal entry details, including 'currency_code', 'description', 'details' (with credit, debit, and sub-account IDs), 'entryid', 'id', 'name', and 'user_entered_date'.
Input Fields: Input Fields
Output Fields: Output Fields

Add payment gateway to the invoice

ID: post_add_payment_gateway_to_the_invoice
Operation: write
Entities: payment option, invoice, gateway info
Summary: This API endpoint allows you to add a payment gateway to a specific invoice in FreshBooks. The request requires the account ID and invoice ID as path parameters. The body of the request must include 'has_credit_card' to indicate if credit card payments are enabled and 'gateway_name' to specify the payment gateway. The response returns the payment options associated with the invoice, including details about the gateway such as supported currencies and whether various payment methods are enabled.
Input Fields: Input Fields
Output Fields: Output Fields

Add a Payment Option to an Invoice

ID: post_add_payment_option_to_invoice
Operation: write
Entities: gateway, payment option, invoice
Summary: This API endpoint allows you to add a payment option to a specific invoice in FreshBooks. You need to provide the account ID and invoice ID as path parameters. The request body requires the gateway name, entity ID, entity type, and a boolean indicating if credit card payments are enabled. The response includes the payment options configured for the invoice, such as the gateway name, payment methods enabled, and additional gateway information.
Input Fields: Input Fields
Output Fields: Output Fields

Add Payment to Bill

ID: post_add_payment_to_bill
Operation: write
Entities: bill payment, bill, payment
Summary: The 'Add Payment to Bill' API allows users to add a payment to a specific bill in their FreshBooks account. The API requires an account ID as a path parameter and a bearer token for authentication. The request body must include details of the bill payment such as the bill ID, payment amount, currency code, payment type, payment date, and an optional note. The response returns the details of the added bill payment, including the payment amount, bill ID, payment ID, whether the payment is matched with an expense, the note, payment date, payment type, and visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Add Vendor

ID: post_add_vendor
Operation: write
Entities: vendor, bill, contact
Summary: The Add Vendor API allows users to add a new vendor to their FreshBooks account. The API requires a POST request to the specified URL with the account ID as a path parameter. The request must include a Content-Type header set to application/json. The body of the request should contain the vendor details such as vendor name, primary contact information, address, account number, phone, website, currency code, language, and tax defaults. The response returns the details of the newly created vendor, including the vendor ID, creation and update timestamps, and visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Get Bearer token via authorization code

ID: post_bearer_token_via_authorization_code
Operation: read
Entities: authorization code, client, token
Summary: This API endpoint is used to obtain a Bearer token using an authorization code. The request must include the grant type 'authorization_code', the client ID, the authorization code, the client secret, and the redirect URI. The response includes the access token, token type, expiration time, and a refresh token.
Input Fields: Input Fields
Output Fields: Output Fields

Get Bearer token via refresh code

ID: post_bearer_token_via_refresh_code
Operation: write
Entities: client, token, redirect URI
Summary: This API endpoint is used to obtain a new Bearer token using a refresh token. It requires a POST request to 'https://api.freshbooks.com/auth/oauth/token' with a JSON body containing 'grant_type', 'client_id', 'refresh_token', 'client_secret', and 'redirect_uri'. The response includes a new 'access_token', 'token_type', 'expires_in', and 'refresh_token'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Bill

ID: post_create_a_bill
Operation: write
Entities: category, vendor, bill
Summary: The 'Create a Bill' API allows users to create a new bill in the FreshBooks accounting system. The API requires an account ID as a path parameter and a bearer token for authentication. The request body must include details of the bill such as vendor ID, issue date, due offset days, currency code, language, and line items. Each line item can include details like unit cost, description, quantity, and category ID. The response returns the created bill's details, including the total amount, line items, and status.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Service

ID: post_create_a_service
Operation: write
Entities: business, service
Summary: The 'Create a Service' API allows users to create a new service for a specified business. The request requires the business ID as a path parameter and the service name in the request body. The response returns the details of the created service, including its ID, name, business association, billable status, and visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Single Project

ID: post_create_a_single_project
Operation: write
Entities: project, client, group
Summary: The 'Create a Single Project' API allows users to create a new project for a specified business. The API requires the business ID as a path parameter and a request body containing the project details such as title, client ID, project type, and fixed price. The response includes detailed information about the created project, including its ID, title, client ID, project type, fixed price, and other metadata such as creation and update timestamps, group details, and links to the project and its threads.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Time Entry

ID: post_create_a_time_entry
Operation: write
Entities: time entry, project, client
Summary: The 'Create a Time Entry' API allows users to create a new time entry for a specified business. The request requires a business ID as a path parameter and a JSON body containing details of the time entry such as 'is_logged', 'duration', 'note', 'started_at', 'client_id', 'identity_id', and 'project_id'. The response returns the created time entry details including 'note', 'duration', 'project_id', 'client_id', 'is_logged', 'started_at', 'active', 'id', and 'timer'.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Invoice Profile

ID: post_create_an_invoice_profile
Operation: write
Entities: invoice_profile, line, customer
Summary: The 'Create an Invoice Profile' API allows users to create a new invoice profile for a specified account. The request requires an authorization token, API version, and content type in the headers. The account ID must be specified in the path parameters. The body of the request includes the invoice profile details such as customer ID, creation date, frequency, number of recurring invoices, and line items with their names, quantities, and unit costs. The response returns the created invoice profile details including the profile ID, customer ID, organization, currency code, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Create Client

ID: post_create_client
Operation: write
Entities: client, contact
Summary: The Create Client API allows you to create a new client in the FreshBooks accounting system. You need to provide the account ID in the path parameters and include a bearer token for authorization in the headers. The request body should contain the client's details such as first name, last name, email, organization, address, currency code, language, and optional contacts. The response returns the created client's details including their ID, email, organization, address, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Create Credit Note

ID: post_create_credit_note
Operation: write
Entities: credit note, client, payment
Summary: The 'Create Credit Note' API allows users to create a credit note for a specified account. The request requires the account ID as a path parameter and a JSON body containing details of the credit note such as client ID, credit number, currency code, creation date, notes, credit type, and terms. The response returns a detailed object of the created credit note, including information like accounting system ID, amount, client ID, country, creation date, credit number, credit type, credit ID, organization, payment status, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Create Expense

ID: post_create_expense
Operation: write
Entities: categoryid, expense, amount
Summary: The Create Expense API allows users to create a new expense entry in the FreshBooks accounting system. The API requires the account ID as a path parameter and accepts a JSON body containing the expense details such as amount, category ID, staff ID, and date. The response returns detailed information about the created expense, including its ID, amount, category, and other related metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Create Expense With Attachment

ID: post_create_expense_with_attachment
Operation: write
Entities: expense, amount, attachment
Summary: The 'Create Expense With Attachment' API allows users to create a new expense entry in the FreshBooks accounting system, including an attachment. The API requires the account ID as a path parameter and optionally includes the attachment in the query parameters. The request body must contain the expense details, including the amount, attachment JWT, media type, category ID, staff ID, and date. The response returns the created expense details, including the accounting system ID, amount, attachment details, category ID, client ID, date, expense ID, and other related information.
Input Fields: Input Fields
Output Fields: Output Fields

Create Invoice

ID: post_create_invoice
Operation: write
Entities: line, client, invoice
Summary: The Create Invoice API allows users to create a new invoice in the FreshBooks accounting system. The API requires a POST request to the specified URL with the account ID as a path parameter. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' bearer token. The request body must contain an 'invoice' object with various properties such as 'due_offset_days', 'language', 'country', 'create_date', 'currency_code', 'fname', 'lname', 'notes', 'invoice_number', 'status', 'organization', 'template', 'terms', and 'customerid'. Optional fields include 'allowed_gateway_name', 'deposit_percentage', 'estimateid', 'highlight_string', 'sender_name', 'invoiceid', 'invoice_client_id', 'last_order_status', 'city', 'code', 'po_number', 'province', 'street', 'street2', 'payment_details', 'vat_name', 'vat_number', 'allowed_gateway_info', 'attachments', 'contacts', 'direct_links', 'async_invoice_profile', 'late_fee', 'late_reminders', 'lines', 'owner', 'presentation', 'transactioninvoiceid', and 'payment_schedule'. The response includes the created invoice details such as 'accountid', 'amount', 'country', 'create_date', 'currency_code', 'customerid', 'invoice_number', 'status', 'organization', 'terms', and 'uuid'.
Input Fields: Input Fields
Output Fields: Output Fields

Create Invoice With An Unbilled Expense

ID: post_create_invoice_with_an_unbilled_expense
Operation: write
Entities: invoice, expense, contact
Summary: The 'Create Invoice With An Unbilled Expense' API allows users to create an invoice with unbilled expenses in the FreshBooks accounting system. The API requires a POST request to the specified URL with the account ID as a path parameter. The request headers must include 'Content-Type' as 'application/json' and an 'Authorization' bearer token. The request body should contain detailed invoice information, including client details, line items, and any applicable taxes or discounts. The response returns the created invoice details, including the invoice ID, amount, status, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Create Invoice with Attachment

ID: post_create_invoice_with_attachment
Operation: write
Entities: invoice, account, attachment
Summary: The 'Create Invoice with Attachment' API allows users to create a new invoice in the FreshBooks system with optional attachments. The API requires the account ID as a path parameter and a valid Bearer token for authorization. The request body must include an 'invoice' object, which can contain an array of 'attachments'. Each attachment must have a JWT token and specify its media type. The response returns the details of the created invoice, including its ID and invoice number.
Input Fields: Input Fields
Output Fields: Output Fields

Create Invoice With Discount Value

ID: post_create_invoice_with_discount_value
Operation: write
Entities: late fee, line, invoice
Summary: The 'Create Invoice With Discount Value' API allows users to create an invoice with a specified discount value. The API endpoint is 'https://api.freshbooks.com/accounting/account//invoices/invoices' and requires a POST request. The request headers must include 'Content-Type' as 'application/json' and an 'Authorization' bearer token. The path parameter 'accountId' is required to specify the account for which the invoice is being created. The request body includes detailed information about the invoice such as client details, discount value, line items, and terms. The response returns the created invoice details including the invoice ID, amount, discount applied, and status.
Input Fields: Input Fields
Output Fields: Output Fields

Create Invoice with no Presentation

ID: post_create_invoice_with_no_presentation
Operation: write
Entities: invoice
Summary: The 'Create Invoice with no Presentation' API allows users to create an invoice in the FreshBooks system without using the default presentation. The API requires a POST request to the specified URL with the account ID as a path parameter. The request must include headers for 'Content-Type' as 'application/json' and an 'Authorization' bearer token. The body of the request should contain an 'invoice' object with the 'use_default_presentation' flag set to false. The response includes the details of the created invoice, such as its ID and invoice number.
Input Fields: Input Fields
Output Fields: Output Fields

Create Invoice with Presentation

ID: post_create_invoice_with_presentation
Operation: write
Entities: presentation, invoice
Summary: The 'Create Invoice with Presentation' API allows users to create an invoice with specific presentation details such as date format, logo image source, theme layout, font name, and primary color. The API requires an account ID as a path parameter and a bearer token for authorization. The request body must include the invoice details, particularly the presentation settings. Upon successful creation, the API returns the invoice details including its ID, number, and presentation settings.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single Client

ID: post_create_single_client
Operation: write
Entities: user, client, contact
Summary: The 'Create Single Client' API allows users to create a new client in the FreshBooks accounting system. The API requires an account ID as a path parameter and a bearer token for authorization. The request body must include client details such as first name, last name, email, organization, address, currency code, and language. Optional fields include VAT information, phone numbers, and additional contacts. The response returns the created client's details, including their ID, email, organization, and address, along with metadata such as signup date and user ID.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single Estimate

ID: post_create_single_estimate
Operation: write
Entities: customer, account, estimate
Summary: The 'Create Single Estimate' API allows users to create a new estimate for a specified account. The request requires the account ID as a path parameter and a request body containing the customer's email, customer ID, and the creation date of the estimate. The response returns detailed information about the created estimate, including its status, creation date, code, owner ID, customer details, and financial information such as the amount and currency code.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single Estimate With Estimate Lines (and an unbilled expense)

ID: post_create_single_estimate_with_estimate_lines
Operation: write
Entities: expense, estimate line, estimate
Summary: This API endpoint allows the creation of a single estimate with estimate lines and an unbilled expense for a specified account. The request requires the account ID as a path parameter and a body containing the estimate details, including the customer's email, customer ID, creation date, and line items. Each line item can include details such as type, description, taxes, name, quantity, unit cost, and optionally an expense ID. The response returns the created estimate's details, including status, creation date, code, owner ID, customer information, and financial details.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single Item

ID: post_create_single_item
Operation: write
Entities: item, account, unit cost
Summary: The 'Create Single Item' API allows users to create a new item in the specified account. The request requires the account ID as a path parameter and the item details in the request body. The item details include the name of the item. The response returns the details of the created item, including its unique identifier, accounting system ID, name, quantity, unit cost, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single Other Income

ID: post_create_single_other_income
Operation: write
Entities: amount, tax, other income
Summary: The 'Create Single Other Income' API allows users to create a new entry for other income in their FreshBooks account. The API requires the account ID and the other income ID as path parameters. The request body must include details such as the amount, currency code, category name, date, note, payment type, source, source ID, and any applicable taxes. The response returns the created other income entry with additional metadata such as creation and update timestamps, income ID, and visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single Payment

ID: post_create_single_payment
Operation: write
Entities: invoice, account, payment
Summary: The 'Create Single Payment' API allows users to create a payment for a specific invoice in the FreshBooks accounting system. The request requires the account ID as a path parameter and a JSON body containing the payment details, including the invoice ID, payment amount, date, and type. The response returns the details of the created payment, including the payment ID, invoice ID, client ID, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Create Single Tax

ID: post_create_single_tax
Operation: write
Entities: tax
Summary: The 'Create Single Tax' API allows users to create a new tax entry for a specified account. The request requires the account ID as a path parameter and a JSON body containing the name of the tax to be created. The response returns the details of the created tax, including its unique ID, name, amount, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Register for webhook callback

ID: post_register_for_webhook_callback
Operation: write
Entities: event, account, callback
Summary: This API registers a webhook callback for a specified event on a FreshBooks account. The request requires the account ID as a path parameter and a JSON body specifying the event and the URI where the webhook callback will be sent. The response includes details of the registered callback, such as the callback ID, verification status, URI, and event.
Input Fields: Input Fields
Output Fields: Output Fields

Revoking a Bearer/Refresh Token

ID: post_revoking_a_bearer_refresh_token
Operation: write
Entities: client, token
Summary: This API endpoint is used to revoke a Bearer or Refresh Token. It requires the client ID and client secret of your application, along with the token that needs to be revoked. The request is made via a POST method to the specified URL. Upon successful revocation, the API returns a response indicating the success status and a message.
Input Fields: Input Fields
Output Fields: Output Fields

Upload Attachment

ID: post_upload_attachment
Operation: write
Entities: account, attachment
Summary: The 'Upload Attachment' API allows users to upload a file as an attachment to a specified account in FreshBooks. The API requires a POST request to the endpoint 'https://api.freshbooks.com/uploads/account//attachments' with a Bearer token for authorization. The file to be uploaded is specified in the request body as 'content'. Upon successful upload, the API returns details of the uploaded file, including its filename, public ID, JWT token, media type, and UUID.
Input Fields: Input Fields
Output Fields: Output Fields

Upload Invoice Attachment

ID: post_upload_invoice_attachment
Operation: write
Entities: invoice, account, attachment
Summary: The 'Upload Invoice Attachment' API allows users to upload a file as an attachment to a specified account in FreshBooks. The API requires a POST request to the endpoint 'https://api.freshbooks.com/uploads/account/<account_id>/attachments' with an Authorization header containing a Bearer token. The account_id is a path parameter that specifies the account for which the attachment is being uploaded. The request body must include the file to be uploaded, specified as 'content'. The response includes details about the uploaded file such as filename, public_id, jwt, media_type, and uuid, along with a link to access the uploaded file.
Input Fields: Input Fields
Output Fields: Output Fields

Upload Logo / Banner

ID: post_upload_logo_banner
Operation: write
Entities: account, image, link
Summary: The 'Upload Logo / Banner' API allows users to upload an image file to a specified FreshBooks account. The request requires an Authorization header with a Bearer token and a path parameter for the account ID. The image file is sent in the request body as a form-data field named 'content'. Upon successful upload, the API returns a JSON response containing details about the uploaded image, including its filename, public ID, JWT, media type, UUID, and a link to access the image.
Input Fields: Input Fields
Output Fields: Output Fields

Archive Bill

ID: put_archive_bill
Operation: write
Entities: category, amount, bill
Summary: The Archive Bill API allows you to archive a bill in the FreshBooks accounting system. It requires the account ID and bill ID as path parameters, and a bearer token for authorization in the headers. The request body must include the 'vis_state' parameter to set the visibility state of the bill. The response includes detailed information about the bill, such as the amount, currency code, bill number, creation date, due date, line items, and status.
Input Fields: Input Fields
Output Fields: Output Fields

Delete A Bill Payment

ID: put_delete_a_bill_payment
Operation: write
Entities: account, bill payment
Summary: The 'Delete A Bill Payment' API allows users to mark a bill payment as deleted in the FreshBooks accounting system. This is done by sending a PUT request to the specified endpoint with the account ID and bill payment ID as path parameters. The request must include an Authorization header with a Bearer token and a Content-Type header set to 'application/json'. The body of the request should contain a 'bill_payment' object with a 'vis_state' property set to 1, indicating the deletion. The response will include a status and message indicating the success or failure of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Task

ID: put_delete_a_task
Operation: write
Entities: account, project, task
Summary: The 'Delete a Task' API allows users to delete a task by setting its visibility state to 1. The API requires the account ID and task ID as path parameters. The request body must include the 'vis_state' set to 1 to mark the task for deletion. The response includes details of the task such as its billable status, description, ID, name, rate, tax rates, and last updated timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Invoice Profile

ID: put_delete_an_invoice_profile
Operation: write
Entities: customer, account, invoice profile
Summary: The 'Delete an Invoice Profile' API allows users to update the visibility state of an invoice profile in the FreshBooks system. The API requires the account ID and profile ID as path parameters, and the visibility state as part of the request body. The request must include headers for authorization, API version, and content type. The response includes detailed information about the invoice profile, such as creation date, owner ID, currency code, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Bill

ID: put_delete_bill
Operation: write
Entities: amount, bill, category
Summary: The Delete Bill API allows you to delete a bill in the FreshBooks accounting system by setting its visibility state. The API requires the account ID and bill ID as path parameters, and an authorization bearer token in the headers. The request body must include the 'vis_state' parameter to indicate the visibility state of the bill. The response includes detailed information about the bill, such as the amount, currency code, bill number, creation date, due date, line items, and status.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Credit

ID: put_delete_credit
Operation: write
Entities: account, client, credit note
Summary: The Delete Credit API allows you to update the visibility state of a credit note in the FreshBooks accounting system. The API requires the account ID and credit note ID as path parameters. The request body must include the 'vis_state' field to specify the new visibility state. The response includes detailed information about the credit note, such as the accounting system ID, amount, client details, creation date, credit number, type, and status. It also provides payment details and other metadata related to the credit note.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Expense

ID: put_delete_expense
Operation: write
Entities: account, expense
Summary: The 'Delete Expense' API allows users to delete an expense by setting its visibility state to 1. The request is made using the PUT method to the specified URL, which includes the account ID and expense ID as path parameters. The request body must include the 'expense' object with 'vis_state' set to 1. The response is an empty object indicating successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Invoice

ID: put_delete_invoice
Operation: write
Entities: customer, invoice, account
Summary: The Delete Invoice API allows users to mark an invoice as deleted by setting its visibility state to 1. This API requires the account ID and invoice ID as path parameters, and a bearer token for authorization in the headers. The request body must include the 'invoice' object with 'vis_state' set to 1. The response returns detailed information about the invoice, including its account ID, amount, currency, customer ID, due date, and other relevant details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Single Client

ID: put_delete_single_client
Operation: write
Entities: account, client, user
Summary: The 'Delete Single Client' API is used to delete a client from the FreshBooks account. This is done by sending a PUT request to the specified URL with the account ID and customer ID as path parameters. The request must include an Authorization header with a Bearer token and a Content-Type header set to 'application/json'. The body of the request should contain a 'client' object with 'vis_state' set to 1, indicating the client should be deleted. The response is an empty object, indicating the operation was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Single Estimate

ID: put_delete_single_estimate
Operation: write
Entities: customer, account, estimate
Summary: The 'Delete Single Estimate' API allows users to delete a specific estimate by providing the account ID and estimate ID in the URL path parameters. The request body must include the customer ID and the creation date of the estimate. Upon successful deletion, the API returns a detailed response containing the status, creation date, code, owner ID, and other relevant information about the estimate, including customer details, organization, and financial amounts.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Single Item

ID: put_delete_single_item
Operation: write
Entities: account, item
Summary: The 'Delete Single Item' API allows users to delete a specific item from their FreshBooks account. The request is made using the PUT method to the endpoint 'https://api.freshbooks.com/accounting/account//items/items/', where '' is the account ID and '' is the item ID. The request body must include an 'item' object with a 'vis_state' property set to 1, indicating the item should be deleted. The response is an empty object, confirming the deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Single Payment

ID: put_delete_single_payment
Operation: write
Entities: invoice, account, payment
Summary: The 'Delete Single Payment' API allows users to delete a specific payment in the FreshBooks accounting system. The request requires the account ID and payment ID as path parameters. The request body must include the 'vis_state' set to 1 to mark the payment for deletion. The response returns the details of the payment, including the accounting system ID, invoice ID, client ID, amount, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Vendor

ID: put_delete_vendor
Operation: write
Entities: account, vendor, bill
Summary: The Delete Vendor API is used to update the visibility state of a vendor in the FreshBooks accounting system. It requires the account ID and vendor ID as path parameters, and a bearer token for authorization. The request body must include the 'vis_state' field to specify the new visibility state. The response includes detailed information about the vendor, such as account number, contact details, and address.
Input Fields: Input Fields
Output Fields: Output Fields

Edit Payment to Bill

ID: put_edit_payment_to_bill
Operation: write
Entities: account, bill payment, bill
Summary: The 'Edit Payment to Bill' API allows users to update the details of a payment made to a bill in the FreshBooks accounting system. The API requires the account ID and bill payment ID as path parameters. The request must specify the content type as JSON. The request body should contain the bill ID, payment amount, currency code, payment type, paid date, and an optional note. The response returns the updated bill payment details, including the amount, bill ID, payment ID, payment type, paid date, and visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Edit Vendor Details

ID: put_edit_vendor_details
Operation: write
Entities: address, contact, vendor
Summary: The Edit Vendor Details API allows users to update the details of a vendor in the FreshBooks accounting system. The API requires a PUT request to the specified URL with the account ID and vendor ID as path parameters. The request must include a Content-Type header set to application/json. The request body should contain the vendor details to be updated, such as vendor name, primary contact information, address, account number, phone, website, currency code, language, and 1099 status. The response includes the updated vendor details, including timestamps for creation and update, and other vendor information.
Input Fields: Input Fields
Output Fields: Output Fields

Mark Invoice As Sent

ID: put_mark_invoice_as_sent
Operation: write
Entities: amount, invoice, account
Summary: The 'Mark Invoice As Sent' API allows users to mark a specific invoice as sent in the FreshBooks accounting system. This API requires a PUT request to the endpoint with the account ID and invoice ID as path parameters. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' with a Bearer token. The body of the request should contain an 'invoice' object with 'action_mark_as_sent' set to true. Upon successful execution, the API returns a detailed response of the invoice, including its status, amount, customer details, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Remove all Secondary Contacts

ID: put_remove_all_secondary_contacts
Operation: write
Entities: contact, client
Summary: The 'Remove all Secondary Contacts' API allows users to remove all secondary contacts for a specific client in a FreshBooks account. The request is made using the PUT method to the specified URL, which includes the account ID and client ID as path parameters. The request body must contain a 'client' object with an empty 'contacts' array to indicate the removal of all secondary contacts. The response will indicate whether the operation was successful and provide a message detailing the result.
Input Fields: Input Fields
Output Fields: Output Fields

Resend verification code

ID: put_resend_verification_code
Operation: write
Entities: event, account, callback
Summary: The 'Resend verification code' API allows users to resend a verification code for a specific callback associated with an account. The request is made using the PUT method to the endpoint 'https://api.freshbooks.com/events/account/<account_id>/events/callbacks/<callback_id>'. The request body must include a 'callback' object with a 'resend' boolean flag set to true. The response contains the callback details, including the callback ID, verification status, URI, and associated event.
Input Fields: Input Fields
Output Fields: Output Fields

Send Invoice By Email

ID: put_send_invoice_by_email
Operation: write
Entities: invoice, account, email recipient
Summary: The 'Send Invoice By Email' API allows users to send an invoice via email to specified recipients. The API requires the account ID and invoice ID as path parameters. The request must include headers for 'Content-Type' set to 'application/json' and 'Authorization' with a bearer token. The request body should contain an 'invoice' object with 'action_email' set to true, a list of 'email_recipients', and optional fields like 'email_include_pdf' and 'invoice_customized_email' for customizing the email subject and body. The response returns detailed information about the invoice, including its status, amount, currency, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Project

ID: put_update_a_project
Operation: write
Entities: project, client, service
Summary: The 'Update a Project' API allows users to update the details of a specific project within a business. The API requires the business ID and project ID as path parameters. The request body must include the new project details such as title, due date, and client ID. The response returns the updated project details, including links, group information, services, and other project attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Service Rate

ID: put_update_a_service_rate
Operation: write
Entities: rate, business, service
Summary: The 'Update a Service Rate' API allows users to update the rate of a specific service for a given business. The request is made using the PUT method to the endpoint 'https://api.freshbooks.com/comments/business//service/<service_id>/rate'. The path parameters 'businessid' and 'service_id' are required to specify the business and service whose rate is being updated. The request body must include 'service_rate' with a 'rate' field indicating the new rate. The response does not specify any headers or body content.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Task

ID: put_update_a_task
Operation: write
Entities: task, project, rate
Summary: The Update a Task API allows you to update the details of an existing task in a project. You need to provide the account ID and task ID in the URL path parameters. The request body must include the task name and rate details, including the amount and currency code. The response returns the updated task details, including its billable status, description, ID, name, rate, tax rates, and visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Time Entry

ID: put_update_a_time_entry
Operation: write
Entities: project, client, time entry
Summary: The 'Update a Time Entry' API allows users to update an existing time entry in the FreshBooks system. The request is made using the PUT method to the endpoint 'https://api.freshbooks.com/timetracking/business/<business_id>/time_entries/<time_entry_id>', where '<business_id>' and '<time_entry_id>' are path parameters representing the business and time entry IDs, respectively. The request body must include a 'time_entry' object with details such as 'is_logged', 'duration', 'note', 'started_at', 'timer', 'client_id', and 'project_id'. The response returns the updated time entry details, including 'note', 'duration', 'project_id', 'client_id', 'is_logged', 'started_at', 'active', 'id', and 'timer' information.
Input Fields: Input Fields
Output Fields: Output Fields

Update Credit

ID: put_update_credit
Operation: write
Entities: payment, client, credit note
Summary: The Update Credit API allows you to update an existing credit note in the FreshBooks accounting system. The API requires the account ID and credit note ID as path parameters. The request body must include the 'credit_note' object with 'notes' as a required field. The response returns the updated credit note details, including the accounting system ID, amount, client information, credit number, and status.
Input Fields: Input Fields
Output Fields: Output Fields

Update Existing Client Profile with Secondary Contacts

ID: put_update_existing_client_profile_with_secondary_contacts
Operation: write
Entities: contact, client, user
Summary: This API allows updating an existing client profile with secondary contacts in the FreshBooks system. The request is made using the PUT method to the endpoint 'https://api.freshbooks.com/accounting/account//users/clients/'. The request body must include a 'client' object containing an array of 'contacts', each with 'email', 'fname', 'lname', and 'phone1' fields. The response returns a detailed client object with various attributes such as 'accounting_systemid', 'email', 'fname', 'lname', 'organization', and more, reflecting the updated client profile.
Input Fields: Input Fields
Output Fields: Output Fields

Update Expense

ID: put_update_expense
Operation: write
Entities: account, expense, vendor
Summary: The Update Expense API allows you to update the details of an existing expense in the FreshBooks accounting system. The API requires the account ID and expense ID as path parameters to identify the specific expense to be updated. The request body must include the 'expense' object with the 'vendor' field to specify the vendor's name. The response returns the updated expense details, including various fields such as category ID, markup percentage, project ID, client ID, tax details, vendor name, amount, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Update Invoice

ID: put_update_invoice
Operation: write
Entities: customer, invoice, account
Summary: The Update Invoice API allows you to update the details of an existing invoice in the FreshBooks accounting system. The API requires the account ID and invoice ID as path parameters, and a bearer token for authorization in the headers. The request body must include the 'due_offset_days' field to specify the number of days after which the invoice is due. The response returns the updated invoice details, including the account ID, invoice ID, amount, currency code, due date, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Update an Invoice Profile

ID: put_update_invoice_profile
Operation: write
Entities: customer, account, invoice profile
Summary: The 'Update an Invoice Profile' API allows users to update the frequency of an existing invoice profile. The request requires the account ID and profile ID as path parameters, and the frequency as a body parameter. The request headers must include an authorization token, API version, and content type. The response includes detailed information about the updated invoice profile, such as the profile ID, frequency, owner ID, and other related details.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Client

ID: put_update_single_client
Operation: write
Entities: account, client, user
Summary: The 'Update Single Client' API allows you to update the details of a specific client in the FreshBooks accounting system. You need to provide the account ID and customer ID as path parameters. The request body should contain the client object with updated details such as first name, email, VAT number, business phone, and both billing and shipping addresses. The response returns the updated client details, including various attributes such as accounting system ID, email, organization, and address details.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Estimate

ID: put_update_single_estimate
Operation: write
Entities: customer, account, estimate
Summary: The 'Update Single Estimate' API allows users to update an existing estimate in the FreshBooks accounting system. The API requires the account ID and the estimate ID as path parameters. The request body must include the 'estimate' object with 'customerid' and 'create_date' as required fields. The response returns the updated estimate details, including status, creation date, estimate code, customer information, and financial details such as amount and currency code.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Item

ID: put_update_single_item
Operation: write
Entities: account, item
Summary: The 'Update Single Item' API allows you to update the details of a specific item in a FreshBooks account. The API requires the account ID and the item ID as path parameters. The request body must include the new name for the item. Upon successful update, the API returns the updated item details, including the item ID, accounting system ID, updated timestamp, name, quantity, SKU, unit cost, tax rates, visibility state, and description.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Other Income Entry

ID: put_update_single_other_income_entry
Operation: write
Entities: amount, other income entry, tax
Summary: The 'Update Single Other Income Entry' API allows users to update an existing other income entry in their FreshBooks account. The request requires the account ID and the ID of the other income entry to be updated as path parameters. The request body must include the other income details such as amount, currency code, date, and source. The response returns the updated other income entry details, including the amount, category name, creation and update timestamps, income ID, note, payment type, source, taxes, and visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Payment

ID: put_update_single_payment
Operation: write
Entities: invoice, account, payment
Summary: The 'Update Single Payment' API allows you to update the details of a specific payment in the FreshBooks accounting system. The request requires the account ID and payment ID as path parameters, and the invoice ID in the request body. The response includes detailed information about the updated payment, such as the accounting system ID, updated timestamp, invoice ID, amount, client ID, and other relevant payment details.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Tax

ID: put_update_single_tax
Operation: write
Entities: tax
Summary: The 'Update Single Tax' API allows users to update the details of a specific tax in their accounting system. The API requires the account ID and the tax ID as path parameters. The request body must include the new name for the tax. Upon successful update, the API returns the updated tax details, including the accounting system ID, updated timestamp, tax name, tax ID, amount, and whether the tax is compound.
Input Fields: Input Fields
Output Fields: Output Fields

Verify webhook callback

ID: put_verify_webhook_callback
Operation: write
Entities: invoice, account, callback
Summary: The 'Verify webhook callback' API is used to verify a webhook callback for a specific account in FreshBooks. The API requires the account ID and callback ID as path parameters. The request body must include a verifier string within a 'callback' object. Upon successful verification, the response returns details of the callback, including its ID, verification status, URI, and associated event.
Input Fields: Input Fields
Output Fields: Output Fields

Get Account

ID: retrieve_general_ledger_account_details
Operation: read
Entities:
Summary: The Get Account API retrieves a account details for a specified account ID. The request requires an Authorization header with a Bearer token and a path parameter for the account ID. The response includes a list of accounts with details such as account name, number, type, balance, currency code.
Input Fields: Input Fields
Output Fields: Output Fields

Get A Bill Payment

ID: retrieve_vendor_payment_details
Operation: read
Entities:
Summary: The 'Get A Bill Payment' API retrieves details of a specific bill payment using the account ID and bill payment ID. The request requires an Authorization header with a Bearer token for authentication. The response includes details such as the amount, currency code, bill ID, payment ID, whether the payment is matched with an expense, any associated note, the date the bill was paid, the type of payment, and the visibility state.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Expense Category

ID: update_single_expense_category
Operation: write
Entities: expense category
Summary: Updating Expense Categories is not supported by the API. There are no request parameters or response details available as this functionality is not implemented.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Gateway

ID: update_single_gateway
Operation: No Operation
Entities: gateway
Summary: The API does not support updating gateways. Therefore, there are no request parameters or response details available for this operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single System

ID: update_single_system
Operation: No Operation
Entities: system
Summary: The 'Update Single System' API is not available. There is no functionality provided to update the details of a system through this API.
Input Fields: Input Fields
Output Fields: Output Fields