FreshBooks integration: operations for AI agents
FreshBooks connects to Type.com as an integration. This page lists the 213 operations documented for Claude and Codex in Type.com: 91 read, 43 write, 79 destructive.
About FreshBooks
FreshBooks is a cloud-based accounting software service designed for small and medium-sized businesses, offering features like invoicing, expense tracking, and time management.
Categories: Finance & Accounting
How to connect FreshBooks to Type.com
- Connect
- Managed OAuth through Pipedream when enabled for your workspace
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
213 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
213 operations listed.
Authorization
- Read
Identity Info Call
This is an important endpoint and likely the first authenticated request you'll want to make to the FreshBooks API. Since you will need to tell us which account you're referring to and other identifiers, you can use this /me endpoint to get your accountId, businessId, identityId and a plethora of information about your FreshBooks account(s).
GET /auth/api/v1/users/me - Read
List User
List User
GET /auth/api/v1/users/me - Write
Register as a new user
Register as a new user
POST /auth/api/v1/smux/registrations - Destructive
Revoke Refresh Token
Revoke Refresh Token
POST /auth/oauth/revoke
Clients
- Read
List Credits
List Credits
GET /accounting/account/%7B%7BaccountId%7D%7D/credit_notes/credit_notes - Read
List Clients
list all clients
GET /accounting/account/%7B%7BaccountId%7D%7D/users/clients - Read
Single Client
Get a single client with the parameter associated with clientId
GET /accounting/account/%7B%7BaccountId%7D%7D/users/clients/%7B%7BcustomerId%7D%7D - Write
Create Credit Note
Create Credit Note
POST /accounting/account/%7B%7Baccountid%7D%7D/credit_notes/credit_notes - Write
New Client
Note: If you do not add an organization to your Client object, organization will automatically be added as the client's first and last name.
POST /accounting/account/MJx3p/users/clients - Destructive
Create Prepayment Credit
Create Prepayment Credit
POST /accounting/account/%7B%7Baccountid%7D%7D/credit_notes/credit_notes - Destructive
Update Prepayment Credit
Update Prepayment Credit
PUT /accounting/account/%7B%7Baccountid%7D%7D/credit_notes/credit_notes/%7B%7Bcreditnote%7D%7D - Destructive
Update Credit Note
Update Credit Note
PUT /accounting/account/%7B%7Baccountid%7D%7D/credit_notes/credit_notes/%7B%7Bcreditnote%7D%7D - Destructive
Delete Credit
Delete Credit
PUT /accounting/account/%7B%7BaccountId%7D%7D/credit_notes/credit_notes/%7B%7BcreditId%7D%7D - Destructive
Update Client
Update Client
PUT /accounting/account/%7B%7BaccountId%7D%7D/users/clients/%7B%7BcustomerId%7D%7D - Destructive
Delete Secondary Contact ID
Deletes the specified secondary contactid
DELETE /accounting/account/%7B%7Baccountid%7D%7D/users/contacts/%7B%7Bcontactid%7D%7D - Destructive
Edit Secondary Contact ID
Allows you to edit a specific secondary contact
PUT /accounting/account/%7B%7Baccountid%7D%7D/users/contacts/%7B%7Bcontactid%7D%7D - Destructive
Remove All Secondary Contacts
Will remove all secondary contacts for a single Client Profile
PUT /accounting/account/%7B%7Baccountid%7D%7D/users/clients/%7B%7Bcustomerid%7D%7D
Invoices
- Read
Single Item
Single Item
GET /accounting/account/%7B%7BaccountId%7D%7D/items/items/%7B%7BitemId%7D%7D - Read
List Items
List Items
GET /accounting/account/%7B%7BaccountId%7D%7D/items/items - Read
List Items Filtered by SKU
Returns an exact match of the searched SKU
GET /accounting/account/%7B%7BaccountId%7D%7D/items/items - Read
List Invoice Profiles
List Invoice Profiles
GET /accounting/account/%7B%7BaccountId%7D%7D/invoice_profiles/invoice_profiles - Read
Get Single Invoice Profile
Get Single Invoice Profile
GET /accounting/account/%7B%7BaccountId%7D%7D/invoice_profiles/invoice_profiles/%7B%7BinvoiceProfileId%7D%7D - Read
Download Invoice PDF
Download Invoice PDF
GET /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices/%7B%7BinvoiceId%7D%7D/pdf - Read
Single Retainer
Single Retainer
GET /comments/business/%7B%7BbusinessId%7D%7D/retainer/%7B%7BretainerId%7D%7D - Read
Get all retainers
Get all retainers
GET /comments/business/%7B%7BbusinessId%7D%7D/retainers - Read
List Other Income
List all available other income instances.
GET /accounting/account/%7B%7BaccountId%7D%7D/other_incomes/other_incomes - Read
Single Payment
Single Payment
GET /accounting/account/%7B%7BaccountId%7D%7D/payments/payments/%7B%7BpaymentId%7D%7D - Read
List Payments
List Payments
GET /accounting/account/%7B%7BaccountId%7D%7D/payments/payments - Read
List Invoices
List Invoices
GET /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices - Read
Single Invoice
Single Invoice
GET /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices/%7B%7BinvoiceId%7D%7D - Read
Single Invoice w/ Logo
Single Invoice w/ Logo
GET /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices/%7B%7BinvoiceId%7D%7D - Read
Get default invoice presentation styles
Get default invoice presentation styles
GET /accounting/account/%7B%7BaccountId%7D%7D/invoices/presentations - Write
Create Item
If you add an inventory to an item, FreshBooks will decrement that inventory value each time you add that item to an invoice and save (or send) it. However, qty is seen as the amount of items associated with that sale. Therefore, it will remain unchanged with anytime it is added to an invoice. For example: You may have 5 boxes of nails. Each box of nails will have 99 nails in it. Therefore, your inventory will equal 5 and your qty will equal 99 .
POST /accounting/account/%7B%7BaccountId%7D%7D/items/items - Write
Create Single Invoice Profile
Creates a monthly recurring invoice that sends 3 invoices in total.
POST /accounting/account/%7B%7BaccountId%7D%7D/invoice_profiles/invoice_profiles - Write
Create Single Invoice Profile w/ Time Entry Holder
This will create an invoice profile that will pull unbilled time entries for your client on to the invoice that is generated
POST /accounting/account/%7B%7Baccountid%7D%7D/invoice_profiles/invoice_profiles - Write
Upload Logo
Upload Logo
POST /uploads/account/%7B%7BaccountId%7D%7D/images - Write
Create Retainer
Create Retainer
POST /comments/business/%7B%7BbusinessId%7D%7D/retainers - Write
Create Single Other Income
This allows you to create a single entry for other income you collected (or will collect) through other means outside of FreshBooks.
POST /accounting/account/%7B%7BaccountId%7D%7D/other_incomes/other_incomes - Write
Single Checkout Link
Single Checkout Link
POST /payments/account/%7B%7Baccountid%7D%7D/checkout-links - Write
Single Invoice w/ Logo and styles
Define invoice logo and styles by passing in presentation object with the fields below: Field name Acceptable values imagelogosrc Relative URL of a logo uploaded to FreshBooks - See Upload Logo themeprimarycolor Valid color code themelayout "simple" or "modern" themefontname "modern" or "classic" By default, if no presentation specified in new invoice request payload, it will be assigned a default presentation. To override this default behaviour, specify "usedefaultpresentation": false
POST /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices - Write
Single Invoice w/ Line Items
If the invoice line items have inventory tracking enabled (See Items and Services > Create Item), the relevant inventory amount will be adjusted accordingly when the invoice is created: item new inventory = item current inventory - invoice line item quantity
POST /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices - Write
Create Invoice with Expense
Creating invoice with expense. First you will need to create an expense. Once that is created, save the expenseId and add it to the invoice. When adding an expense, make sure you add to the markuppercent parameter the amount you want to markup by and set cogs to true if it is an item you have paid for.
POST /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices - Destructive
Update Item
Changing the name, description and the inventory level of the current item.
PUT /accounting/account/%7B%7BaccountId%7D%7D/items/items/%7B%7BitemId%7D%7D - Destructive
Delete Item
Delete Item
PUT /accounting/account/%7B%7BaccountId%7D%7D/items/items/%7B%7BitemId%7D%7D - Destructive
Delete Invoice Profile
Delete Invoice Profile
PUT /accounting/account/%7B%7BaccountId%7D%7D/invoice_profiles/invoice_profiles/%7B%7BinvoiceProfileId%7D%7D - Destructive
Update Invoice Profile
Update invoice profile to two weeks and increase the number of remaining invoices to 10.
PUT /accounting/account/%7B%7BaccountId%7D%7D/invoice_profiles/invoice_profiles/%7B%7BinvoiceProfileId%7D%7D - Destructive
Enable Payment Options On Invoice Profile
Enable Payment Options On Invoice Profile
POST /payments/account/%7B%7Baccountid%7D%7D/invoice_profile/%7B%7Bprofileid%7D%7D/payment_options - Destructive
Update Retainer
Update Retainer
PUT /comments/business/%7B%7BbusinessId%7D%7D/retainer/%7B%7BretainerId%7D%7D - Destructive
Delete Retainer
A retainer is deleted by changing the active status to "false". It can be undeleted by changing active status back to true.
PUT /comments/business/%7B%7BbusinessId%7D%7D/retainer/%7B%7BretainerId%7D%7D - Destructive
Undelete Retainer
A retainer is deleted by changing the active status to "false". It can be undeleted by changing active status back to true.
PUT /comments/business/%7B%7BbusinessId%7D%7D/retainer/%7B%7BretainerId%7D%7D - Destructive
Update Single Other Income
Edit the source of this other income, the amount and the date.
PUT /accounting/account/%7B%7BaccountId%7D%7D/other_incomes/other_incomes/%7B%7BincomeId%7D%7D - Destructive
Delete Single Other Income
Delete Single Other Income
PUT /accounting/account/%7B%7BaccountId%7D%7D/other_incomes/other_incomes/%7B%7BincomeId%7D%7D - Destructive
Make Payment
Add a payment to a specific invoice
POST /accounting/account/%7B%7BaccountId%7D%7D/payments/payments - Destructive
Update Checkout Link Payment Gateway
Update Checkout Link Payment Gateway
POST /payments/account/%7B%7Baccountid%7D%7D/checkout_link/%7B%7Bcheckoutlinkid%7D%7D/payment_options - Destructive
Delete Payment
Delete Payment
PUT /accounting/account/%7B%7BaccountId%7D%7D/payments/payments/%7B%7BpaymentId%7D%7D - Destructive
Update Payment
Update Payment
PUT /accounting/account/%7B%7BaccountId%7D%7D/payments/payments/%7B%7BpaymentId%7D%7D - Destructive
Update Checkout Link
Update Checkout Link
PUT /payments/account/%7B%7Baccountid%7D%7D/checkout-links/%7B%7Bcheckoutlinkid%7D%7D - Destructive
Delete Checkout Link
Delete Checkout Link
DELETE /payments/account/%7B%7Baccountid%7D%7D/checkout-links/%7B%7Bcheckoutlinkid%7D%7D - Destructive
Single Invoice w/ Payment Gateway
Call an invoice and display the enabled gateway on that invoice. Stripe = id: 26 | FBpay = id: 30 | PayPal = id: 7
POST /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices/%7B%7Binvoiceid%7D%7D - Destructive
Enable Payment Options On Invoice
Enable Payment Options On Invoice
POST /payments/account/%7B%7Baccountid%7D%7D/invoice/%7B%7Binvoiceid%7D%7D/payment_options - Destructive
Delete Invoice
Note: In order to delete an invoice, you will first need to delete all payments associated with that invoice or turn them to credits. If the invoice line items have inventory tracking enabled (See Items and Services > Create Item), the relevant inventory amount will be adjusted accordingly when the invoice is deleted: item new inventory = item current inventory + item quantity from deleted invoice Similarly, if the deleted invoice gets undeleted, the corresponding inventory wil be updated: item new inventory = item current inventory - item quantity from undeleted invoice
PUT /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices/%7B%7BinvoiceId%7D%7D - Destructive
Update Invoice
If the invoice line items have inventory tracking enabled (See Items and Services > Create Item), the relevant inventory amount will be adjusted accordingly when the invoice is updated: item new inventory = item current inventory + delta of invoice line item old quantity and new quantity
PUT /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices/%7B%7BinvoiceId%7D%7D - Destructive
Update Invoice w/ Expense
If the invoice line items have inventory tracking enabled (See Items and Services > Create Item), the relevant inventory amount will be adjusted accordingly when the invoice is updated: item new inventory = item current inventory + delta of invoice line item old quantity and new quantity
PUT /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices/%7B%7BinvoiceId%7D%7D - Destructive
Send Invoice by Email
Send Invoice by Email
PUT /accounting/account/%7B%7Baccountid%7D%7D/invoices/invoices/%7B%7Binvoiceid%7D%7D - Destructive
Toggle Online Payments on Invoice
26 for Stripe , 30 for FBPayments
PUT /accounting/account/%7B%7BaccountId%7D%7D/invoices/invoices/%7B%7BinvoiceId%7D%7D
Expenses
- Read
Get Bills
Get Bills
GET /accounting/account/%7B%7BaccountId%7D%7D/bills/bills - Read
Get Vendors
Get Vendors
GET /accounting/account/%7B%7Baccountid%7D%7D/bill_vendors/bill_vendors - Read
List Expenses
Get all expenses
GET /accounting/account/%7B%7BaccountId%7D%7D/expenses/expenses - Read
Single Expense
Single Expense
GET /accounting/account/%7B%7BaccountId%7D%7D/expenses/expenses/%7B%7BexpenseId%7D%7D - Read
Expense Summaries
This endpoint will return summaries of the total amounts of expenses by active, archived, and grand total. Active means not archived or deleted. Archived is simply reorganizing the experience on FreshBooks so they're tucked away nicely. They will still show up on your reports and count towards active clients. Deleted clients will be removed from your active clients list, however, any activity related to those accounts will not show up on your reports.
GET /accounting/account/%7B%7BaccountId%7D%7D/expenses/summaries - Read
Expense Vendors
Get a list of expense vendors
GET /accounting/account/%7B%7BaccountId%7D%7D/expenses/vendors - Read
Single Expense Category
Single Expense Category
GET /accounting/account/%7B%7BaccountId%7D%7D/expenses/categories/%7B%7BcategoryId%7D%7D - Read
List Expense Categories
List Expense Categories
GET /accounting/account/%7B%7BaccountId%7D%7D/expenses/categories - Read
List Taxes
List Taxes
GET /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes - Read
Single Tax
Single Tax
GET /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes/%7B%7Btaxid%7D%7D - Write
Upload Receipt Image
Upload Receipt Image
POST /uploads/account/%7B%7BaccountId%7D%7D/images - Write
Add Bill from Vendor
Add Bill from Vendor
POST /accounting/account/%7B%7BaccountId%7D%7D/bills/bills - Write
Add Vendor
Add Vendor
POST /accounting/account/%7B%7BaccountId%7D%7D/bill_vendors/bill_vendors - Write
Create Expense
Category can be passed as categoryid or categoryname, both as string values.
POST /accounting/account/%7B%7BaccountId%7D%7D/expenses/expenses - Write
Create Expense with Receipt
In order to create an expense with a receipt, you will first need to upload your image via the uploader endpoint. Once you receive a response, you can apply that jwt token to your expense under the nested attachment object. Look at the example on the right.
POST /accounting/account/%7B%7BaccountId%7D%7D/expenses/expenses - Write
Create Recurring Expense
Create Recurring Expense
POST /accounting/account/%7B%7Baccountid%7D%7D/expense_profiles/expense_profiles - Write
Create Custom Expense Category
Custome expense categories require a parent category ID. Please make a call to list expense categories to find the parent ID you'd like.
POST /accounting/account/%7B%7BaccountId%7D%7D/expenses/categories - Write
Create Single Tax
Create Single Tax
POST /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes - Destructive
Add Payment to Bill
Add Payment to Bill
POST /accounting/account/%7B%7BaccountId%7D%7D/bill_payments/bill_payments - Destructive
Edit Payment to Bill
Edit Payment to Bill
PUT /accounting/account/%7B%7BaccountId%7D%7D/bill_payments/bill_payments/%7B%7BbillPaymentId%7D%7D - Destructive
Delete Bill
Delete Bill
PUT /accounting/account/%7B%7BaccountId%7D%7D/bills/bills/%7B%7BbillId%7D%7D - Destructive
Archive Bill
Archive Bill
PUT /accounting/account/%7B%7BaccountId%7D%7D/bills/bills/%7B%7BbillId%7D%7D - Destructive
Edit Vendor Details
Edit Vendor Details
PUT /accounting/account/%7B%7BaccountId%7D%7D/bill_vendors/bill_vendors/%7B%7BvendorId%7D%7D - Destructive
Delete Vendor
Delete Vendor
PUT /accounting/account/%7B%7BaccountId%7D%7D/bill_vendors/bill_vendors/%7B%7BvendorId%7D%7D - Destructive
Update Expense
Update Expense
PUT /accounting/account/%7B%7BaccountId%7D%7D/expenses/expenses/%7B%7BexpenseId%7D%7D - Destructive
Update Expense with Receipt
Update Expense with Receipt
PUT /accounting/account/%7B%7BaccountId%7D%7D/expenses/expenses/%7B%7BexpenseId%7D%7D - Destructive
Delete Expense
Delete Expense
PUT /accounting/account/%7B%7BaccountId%7D%7D/expenses/expenses/%7B%7BexpenseId%7D%7D - Destructive
Update Tax
Update Tax
PUT /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes/%7B%7Btaxid%7D%7D - Destructive
Single Tax
Single Tax
DELETE /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes/%7B%7Btaxid%7D%7D
Estimates
- Read
List Estimates
Get an entire list of estimates that exist within your account.
GET /accounting/account/%7B%7BaccountId%7D%7D/estimates/estimates - Read
Single Estimate
Single Estimate
GET /accounting/account/%7B%7BaccountId%7D%7D/estimates/estimates/%7B%7BestimateId%7D%7D - Write
Single Estimate With Estimate Lines
Creates a single estimate with multiple estimate lines and a logo and colourway.
POST /accounting/account/%7B%7BaccountId%7D%7D/estimates/estimates - Write
Create Single Proposal w/ Sections, Logos, and E-signature
Create a single proposal that has sections, logos, and requires an e-signature from the customer
POST /accounting/account/%7B%7Baccountid%7D%7D/estimates/estimates - Destructive
Update Estimate
Updating an estimate with a 30% discount.
PUT - Destructive
Delete Estimate
Delete Estimate
PUT /accounting/account/%7B%7BaccountId%7D%7D/estimates/estimates/%7B%7BestimateId%7D%7D - Destructive
Send Estimate by Email
Send Estimate by Email
PUT /accounting/account/%7B%7Baccountid%7D%7D/estimates/estimates/%7B%7Bestimateid%7D%7D - Destructive
Accept Estimate
Accept Estimate
PUT
Time Tracking
- Read
List Entries
List Entries
GET /timetracking/business/%7B%7BbusinessId%7D%7D/time_entries - Read
Time Entries for a Given Day
Time Entries for a Given Day
GET /timetracking/business/%7B%7BbusinessId%7D%7D/time_entries - Read
Time Entries Updated Since Precise Time
Time entries that have been updated since a precise time.
GET /timetracking/business/%7B%7BbusinessId%7D%7D/time_entries - Read
Time Entries For Employee on Specific Project
Currently you have to search for employee using their employee name and not an ID.
GET /timetracking/business/%7B%7BbusinessId%7D%7D/time_entries/search - Write
Create a Time Entry
Create a Time Entry
POST /timetracking/business/%7B%7BbusinessId%7D%7D/time_entries - Destructive
Update a Time Entry
Update a Time Entry
PUT /timetracking/business/%7B%7BbusinessId%7D%7D/time_entries/%7B%7BtimeEntryId%7D%7D - Destructive
Delete a Time Entry
Delete a Time Entry
DELETE /timetracking/business/%7B%7BbusinessId%7D%7D/time_entries/%7B%7BtimeEntryId%7D%7D
Projects
- Read
List Tasks
List Tasks
GET /accounting/account/%7B%7BaccountId%7D%7D/projects/tasks - Read
Single Task
Single Task
GET /accounting/account/%7B%7BaccountId%7D%7D/projects/tasks/%7B%7BtaskId%7D%7D - Read
Single Project
Single Project
GET /projects/business/%7B%7BbusinessId%7D%7D/projects/%7B%7BprojectId%7D%7D - Read
List Projects
Remember to remove Content-Type headers when making a GET call on projects and time-tracking.
GET /projects/business/%7B%7BbusinessId%7D%7D/projects - Read
Service Rates
Get all service rates associated with this project
GET /comments/business/%7B%7BbusinessId%7D%7D/service_rates - Read
Team Member Rates
Team Member Rates
GET /comments/business/%7B%7BbusinessId%7D%7D/team_member_rates - Read
Invitation Rates
Invitation Rates
GET /comments/business/%7B%7BbusinessId%7D%7D/invitation_rates - Read
List All Messages in Project Discussion
Lists all messages in a specific Project's discussion page
GET /comments/business/%7B%7Bbusinessid%7D%7D/project/%7B%7Bprojectid%7D%7D/threads - Write
Create Task
Create Task
POST /accounting/account/%7B%7BaccountId%7D%7D/projects/tasks - Write
Create Single Project
Create Single Project
POST /projects/business/%7B%7BbusinessId%7D%7D/project - Write
Invite Team Member to Project(s)
Invite Team Member to Project(s)
POST /auth/api/v1/users/invitation - Write
Create New Message in Project Discussion
Create New Message in Project Discussion
POST /comments/business/%7B%7Bbusinessid%7D%7D/project/%7B%7Bprojectid%7D%7D/threads - Write
Add Comment to Project Discussion Message
Adds a comment to a project discussion message
POST /comments/business/%7B%7Bbusinessid%7D%7D/threads/%7B%7Bthreadid%7D%7D/comments - Destructive
Update Task
Update Task
PUT /accounting/account/%7B%7BaccountId%7D%7D/projects/tasks/%7B%7BtaskId%7D%7D - Destructive
Delete Task
Delete Task
PUT /accounting/account/%7B%7BaccountId%7D%7D/projects/tasks/%7B%7BtaskId%7D%7D - Destructive
Update Project
Update project with project title. clientid in this case is customerId
PUT /projects/business/%7B%7BbusinessId%7D%7D/project/%7B%7BprojectId%7D%7D - Destructive
Delete Project
Delete Project
DELETE /service/api/comments/business/%7B%7BbusinessId%7D%7D/project/%7B%7BprojectId%7D%7D - Destructive
Update Service Rates
You will need to update each project service independently with this endpoint
PUT /comments/business/%7B%7BbusinessId%7D%7D/project/%7B%7BprojectId%7D%7D/service/%7B%7BserviceId%7D%7D/rate - Destructive
Update Team Member Rate
You will need to update each project service independently with this endpoint
PUT /comments/business/%7B%7BbusinessId%7D%7D/team_member_rate/%7B%7BidentityId%7D%7D
My Team
- Read
List Team Members
List Team Members
GET /auth/api/v1/businesses/%7B%7BbusinessId%7D%7D/team_members - Read
Single Team Member
Single Team Member
GET /auth/api/v1/businesses/%7B%7BbusinessId%7D%7D/team_members/%7B%7Bteam_member_uuid%7D%7D - Read
Single Staff
Single Staff
GET /accounting/account/%7B%7BaccountId%7D%7D/users/staffs/%7B%7BstaffId%7D%7D - Read
List Staff
List Staff
GET /auth/api/v1/users/business/%7B%7BbusinessId%7D%7D - Destructive
Update Staff
Update Staff
PUT /accounting/account/%7B%7BaccountId%7D%7D/users/staffs/%7B%7BstaffId%7D%7D - Destructive
Update Staff Rates
Update Staff Rates
PUT /comments/business/%7B%7BbusinessId%7D%7D/team_member_rate/%7B%7BidentityId%7D%7D - Destructive
Delete Staff
Delete Staff
PUT /accounting/account/%7B%7BaccountId%7D%7D/users/staffs/%7B%7BstaffId%7D%7D
Reports
- Read
Invoice Details
Invoice Details The Invoice Details Report shows all the information involving your invoices
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/invoice_details - Read
Expense Details
Expense Details
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/expense_details - Read
Bank Reconciliation Summary
Bank Reconciliation Summary
GET /accounting/account/%7B%7Baccountid%7D%7D/reports/accounting/bank_reconciliation_summary - Read
Profit/Loss Report
The Profit/Loss Report shows all the information involving both your profits and losses
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/profitloss_entity - Read
Sales Tax Summary
Sales Tax Summary
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/taxsummary - Read
Accounts Aging
Accounts Aging
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/accounts_aging - Read
Payments Collected
Payments Collected
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/payments_collected - Read
Item Sales
See how much money you're making from each item to sell.
GET /accounting/account/wkMd2g/reports/accounting/item_sales - Read
Revenue By Client
A breakdown of how much each of your clients is bringing in.
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/revenue_by_client - Read
Balance Sheet
A snapshot of your company's assets, liabilities and equity at any given point in time.
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/balance_sheet - Read
Trial Balance
A quick gut check to make sure your books are balanced.
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/trial_balance - Read
General Ledger
A complete record of your transactions to help you prepare financial statements.
GET /accounting/account/%7B%7BaccountId%7D%7D/journal_entry_accounts/journal_entry_accounts - Read
Time Entry Details
A detailed summary of how much time you and/or your team tracked over a period of time. Reminder to not use Content-Type when calling for time-entry details
GET /comments/business/%7B%7BbusinessId%7D%7D/time_entries/search - Read
Download CSV Report
Download CSV Report
GET /accounting/account/%7B%7BaccountId%7D%7D/links/reports/%7B%7BdownloadToken%7D%7D/invoice_details.csv - Read
Client Account Statement
Client Account Statement
GET /accounting/account/%7B%7BaccountId%7D%7D/reports/accounting/account_statement
Accounting
- Read
List Accounts
List Accounts
GET /accounting/businesses/%7B%7Bbusiness_uuid%7D%7D/ledger_accounts/accounts - Read
Single Account
Single Account
GET /accounting/businesses/%7B%7Bbusiness_uuid%7D%7D/ledger_accounts/accounts/%7B%7Baccount_uuid%7D%7D - Read
List Account types
List Account types
GET /accounting/ledger_accounts/types - Read
List Sub types
List Sub types
GET /accounting/ledger_accounts/sub_types - Read
Single Sub type
Single Sub type
GET /accounting/ledger_accounts/sub_types/%7B%7BsubTypeId%7D%7D - Read
Journal Entry Details
Journal Entry Details
GET /accounting/account/%7B%7BaccountId%7D%7D/journal_entries/journal_entry_details - Read
Accounts
Accounts
GET /accounting/account/%7B%7BaccountId%7D%7D/journal_entry_accounts/journal_entry_accounts - Read
List Other Income
List all available other income instances.
GET /accounting/account/%7B%7BaccountId%7D%7D/other_incomes/other_incomes - Read
List Taxes
List Taxes
GET /accounting/account/%7B%7BaccountId%7D%7D/taxes/taxes - Read
Get Single Tax
Get Single Tax
GET /accounting/account/%7B%7BaccountId%7D%7D/taxes/taxes/%7B%7BtaxId%7D%7D - Write
Create Account
Create Account
POST /accounting/businesses/%7B%7Bbusiness_uuid%7D%7D/ledger_accounts/accounts - Write
Add Journal Entry
Add Journal Entry
POST /service/api/accounting/account/%7B%7BaccountId%7D%7D/journal_entries/journal_entries - Write
Create Single Other Income
This allows you to create a single entry for other income you collected (or will collect) through other means outside of FreshBooks.
POST /accounting/account/%7B%7BaccountId%7D%7D/other_incomes/other_incomes - Write
Create Single Tax
Create Single Tax
POST /accounting/account/%7B%7BaccountId%7D%7D/taxes/taxes - Destructive
Update Account
Update Account
PUT /accounting/businesses/%7B%7Bbusiness_uuid%7D%7D/ledger_accounts/accounts/%7B%7Baccount_uuid%7D%7D - Destructive
Update Single Other Income
Edit the source of this other income, the amount and the date.
PUT /accounting/account/%7B%7BaccountId%7D%7D/other_incomes/other_incomes/%7B%7BincomeId%7D%7D - Destructive
Delete Single Other Income
Delete Single Other Income
PUT /accounting/account/%7B%7BaccountId%7D%7D/other_incomes/other_incomes/%7B%7BincomeId%7D%7D - Destructive
Update Single Tax
Update Single Tax
PUT /accounting/account/%7B%7BaccountId%7D%7D/taxes/taxes/%7B%7BtaxId%7D%7D - Destructive
Delete Single Tax
Delete Single Tax
DELETE /accounting/account/%7B%7BaccountId%7D%7D/taxes/taxes/%7B%7BtaxId%7D%7D
Uploader
- Write
Upload Logo or Proposal Image
Upload Logo or Proposal Image
POST /uploads/account/%7B%7BaccountId%7D%7D/images - Write
Upload Expense Receipt
Upload Expense Receipt
POST /uploads/account/%7B%7BaccountId%7D%7D/attachments - Write
Upload Image Without AccountId
Upload Image Without AccountId
POST /uploads/images
Webhooks
- Read
List Webhook Callbacks
List Webhook Callbacks
GET /events/account/%7B%7BaccountId%7D%7D/events/callbacks - Write
Register for Callback
Events
POST /events/account/%7B%7BaccountId%7D%7D/events/callbacks - Destructive
Verify Webhook Callback
Verifying Webhooks Each Webhook sent by FreshBooks includes a header, X-FreshBooks-Hmac-SHA256, with a base64-encoded signature generated using with the data sent in the request and token originally sent in the web hook verification process as a secret. When you receive the webhook, you can verify that it came from FreshBooks by computing the signature and comparing it against the header. When generating your cryptographic hash function, you will have two inputs. Your string input will be the response parameters which you will need to enter as a JSON String. i.e. message = '{"name": "client.update", "objectid": "177864", "userid": "1", "accountid": "K1pdgJ"}' Your verifier (or 'secret') is sent as a response from your initial webhook registration. It is also important that you maintain spaces between all colons and commas. You will also need to make sure that your verifier is a base64 encoded string. Here is an example script in Python: import base64 import hmac import hashlib verifier = "UWQfd9zCzxmVwFZWKqqKwLxqz8gvzGdAn" message = '{"name": "client.update", "objectid": "177864", "userid": "1", "accountid": "FrEsHb"}' dig = hmac.new( verifier, msg=message, digestmod=hashlib.sha256 ).digest() print(base64.b64encode(dig).decode()) and an example in Node.js: const crypto = require('crypto') const utf8 = require('utf8'); const hmac = hmac256(utf8.encode('{"name": "client.update", "objectid": "177864", "userid": "1", "accountid": "FrEsHb"}'), Buffer.from(utf8.encode('UWQfd9zCzxmVwFZWKqqKwLxqz8gvzGdAn')), 'base64') console.log(hmac) function hmac256(data, authKey, encoding) { const x = crypto.createHmac('sha256', authKey) x.update(data) return x.digest(encoding) }
PUT /events/account/%7B%7BaccountId%7D%7D/events/callbacks/%7B%7BcallbackId%7D%7D - Destructive
Resend Verification Code
Resend Verification Code
PUT /events/account/%7B%7BaccountId%7D%7D/events/callbacks/%7B%7BcallbackId%7D%7D - Destructive
Delete Webhook Callback
Delete Webhook Callback
DELETE /events/account/%7B%7BaccountId%7D%7D/events/callbacks/%7B%7BcallbackId%7D%7D
Settings
- Read
Abilities
Abilities
GET /projects/business/%7B%7BbusinessId%7D%7D/abilities - Read
Gateway Details
Gateway Details
GET /payments/account/%7B%7BaccountId%7D%7D/gateway - Read
List Gateways
List Gateways
GET /payments/account/%7B%7BaccountId%7D%7D/gateway - Read
Get System
The value of <id> here is only meaningful if a user has access to multiple systems. See the Identity Model for more information.
GET /accounting/account/%7B%7BaccountId%7D%7D/systems/systems/%7B%7BbusinessId%7D%7D - Read
Single Item
Single Item
GET /accounting/account/%7B%7BaccountId%7D%7D/items/items/%7B%7BitemId%7D%7D - Read
List Items
List Items
GET /accounting/account/%7B%7BaccountId%7D%7D/items/items - Read
List Items Filtered by SKU
List Items Filtered by SKU
GET /accounting/account/%7B%7BaccountId%7D%7D/items/items - Read
List Taxes
List Taxes
GET /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes - Read
Single Tax
Single Tax
GET /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes/%7B%7Btaxid%7D%7D - Read
List Services
List Services
GET /comments/business/%7B%7Bbusinessid%7D%7D/services - Read
Single Service
Single Service
GET /accounting/account/%7B%7BaccountId%7D%7D/billable_items/%7B%7Bid%7D%7D - Read
Get a Single Service
Retrieves information for a single service ID
GET /comments/business/%7B%7Bbusinessid%7D%7D/service/%7B%7Bserviceid%7D%7D - Read
Get a Single Service Rate
Retrieves information for a single service ID
GET /comments/business/%7B%7Bbusinessid%7D%7D/service/%7B%7Bserviceid%7D%7D/rate - Read
Get all applications
Get all applications
GET /auth/api/v1/partners/applications - Write
Add Business
Add Business
POST /auth/api/v1/users/business - Write
Create Item
Create Item
POST /accounting/account/%7B%7BaccountId%7D%7D/items/items - Write
Create Single Tax
Create Single Tax
POST /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes - Write
Create Service
Create Service
POST /accounting/account/%7B%7BaccountId%7D%7D/billable_items/billable_items - Write
Create new application
This can help you create a new application on FreshBooks
POST /auth/api/v1/partners/applications - Write
Upload App Logo
Upload App Logo
POST /uploads/images - Destructive
Delete Business - Subscription
Delete Business - Subscription
DELETE /service/api/auth/api/v1/billing/account/0XaOw/subscription - Destructive
Delete Business
Delete Business
DELETE /auth/api/v1/users/business/685582 - Destructive
Provision FreshBooks Payments
This endpoint is used to provision the ability to use FreshBooks Payments on your invoices. This is typically called at the beginning of new account setup. if you create a new account via the API and don't call this endpoint you will have to manually provision your payment processing account from the settings under "Accept Online Payments".
POST /payments/account/%7B%7BaccountId%7D%7D/gateway/fbpay - Destructive
Update Item
Changing the name, description and the inventory level of the current item.
PUT /accounting/account/%7B%7BaccountId%7D%7D/items/items/%7B%7BitemId%7D%7D - Destructive
Delete Item
Delete Item
PUT /accounting/account/%7B%7BaccountId%7D%7D/items/items/%7B%7BitemId%7D%7D - Destructive
Single Tax
Single Tax
DELETE /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes/%7B%7Btaxid%7D%7D - Destructive
Update Tax
Update Tax
PUT /accounting/account/%7B%7Baccountid%7D%7D/taxes/taxes/%7B%7Btaxid%7D%7D - Destructive
Modify existing application
Modify existing application
PUT /auth/api/v1/partners/applications/%3Capp_client_id%3E
Tokenization
- Read
1a. [STRIPE] - Get Publishable Key
1a. [STRIPE] - Get Publishable Key
GET /payments/account/E86Qp/gateway - Destructive
1. [STRIPE] - Create Payment Method
1. [STRIPE] - Create Payment Method
POST /gateway/stripe/payment-method - Destructive
2. [STRIPE] - Create Setup Intent Using Payment Method Key
Once you obtain the PM key from Step 1, you will use this to inform Stripe that you will be using this card for future use and it is a "Mail Order Telephone Order" (MOTO) card.
POST /payments/account/E86Qp/gateway/stripe/credit-card/token - Destructive
3. [STRIPE] - Save Payment Method to Recurring Profile
You will then pass the pmid from Step 1 to a specific invoice profile. The invoice profile can be found in the UI or as a response when created.
POST /payments/account/E86Qp/credit-card - Destructive
1. [FBPAY] - Create Payment Method
1. [FBPAY] - Create Payment Method
POST /gateway/fbpay/tokenize - Destructive
2. [FBPAY] - Create Setup Intent Using Payment Method Key
2. [FBPAY] - Create Setup Intent Using Payment Method Key
POST /payments/account/%7B%7Baccountid%7D%7D/credit-card
No operations match.
Get started
- Open Space settings → Connections and search for FreshBooks.
- Connect your account and add the connection to the Space.
- Ask for what you need in any thread in that Space.
See How connections work for access and permissions, or browse all integrations.