FreshbooksModule

Api URL

Authentication Token

Create a new callback for a specific event or a set of events.

Valid events

* all

* category

* category.create

* category.delete

* category.update

* client

* client.create

* client.delete

* client.update

* estimate

* estimate.create

* estimate.delete

* estimate.sendByEmail

* estimate.update

* expense

* expense.create

* expense.delete

* expense.update

* invoice

* invoice.create

* invoice.delete

* invoice.dispute

* invoice.pastdue.1

* invoice.pastdue.2

* invoice.pastdue.3

* invoice.sendByEmail

* invoice.sendBySnailMail

* invoice.update

* item

* item.create

* item.delete

* item.update

* payment

* payment.create

* payment.delete

* payment.update

* project

* project.create

* project.delete

* project.update

* recurring

* recurring.create

* recurring.delete

* recurring.update

* staff

* staff.create

* staff.delete

* staff.update

* task

* task.create

* task.delete

* task.update

* time_entry

* time_entry.create

* time_entry.delete

* time_entry.update

Create a new category. If successful, returns the category id of the newly created item.

Create a new client and return the corresponding client_id. If a password is not supplied, one will be created at random.

Create a new invoice complete with line items. If successful, returns the invoice_id of the newly created invoice.

* If you don't specify an invoice number, it will increment from the last one.
* You may optionally specify a different address on the invoice; otherwise the address will be pulled from your client's details.
* You may optionally specify a return_uri element. If provided, users will be presented with a link to the URI when they pay the invoice.

Create a new item and return the corresponding item_id.

Create a new payment and returns the corresponding payment_id.

This function can have one of three possible effects depending on the presence of invoice_id and client_id:

* If you specify an invoice_id only, the payment will be recorded as an invoice payment.

* If you specify a client_id only, the payment will be recorded as a client credit.

* If you specify both an invoice_id and client_id, the payment will be recorded as an invoice payment, and the amount will be subtracted from the client's credit.

Note that 'currency_code' can only be provided when creating a credit, not a regular payment. Regular payments will default to the currency code of the invoice they are being made against.

Create a session

Create a system user

Create a new tax and returns the corresponding tax_id.

*Tax “name” must be unique. You may not create more than one tax with the same name.

Deletes a callback.

Delete an existing expense category.

Delete the client with the given client_id.

Delete an existing invoice.

Delete an existing item.

Permanently delete a payment. This will modify the status of the associated invoice if required.

Permanently delete a tax.

Return the complete category details associated with the given category_id.

Return the client details associated with the given client_id.

Returns information about the current user

Return the complete invoice details associated with the given invoice_id.

* You can use the links element to provide your customers with direct links to the invoice for editing, viewing by the client and viewing by an administrator.

Get an existing item with the given item_id.

Retrieve payment details according to payment_id.

Retrieve tax details according to tax_id.

Return a list of registered callbacks. You can optionally filter by event or uri.

Returns a list of expense categories.

Returns a list of client summaries in order of descending client_id.

Returns a list of invoice summaries. Results are ordered by descending invoice_id.

Returns a list of items, ordered by descending item_id.

Returns a list of payment summaries. Results are ordered by descending payment_id.

Returns a list of taxs, ordered by descending tax_id.

Filters: Use a “compound” tag to return only compound or non-compound taxes.

Undelete a client

Undelete an invoice

Update an existing expense category with the given category_id. Any category fields left out of the request will remain unchanged.

Update the details of the client with the given client_id. Any fields not referenced in the request will remain unchanged.

Update an existing invoice with the given invoice_id. Any invoice fields left out of the request will remain unchanged.

* If you do not specify a lines element, the existing lines will remain unchanged. If you do specify lines elements the original ones will be replaced by the new ones.

Update an existing item. All fields aside from the item_id are optional; by omitting a field, the existing value will remain unchanged.

Update an existing payment. All fields besides payment_id are optional - unpassed fields will retain their existing value.

Note that 'currency_code' can only be provided when updating a credit, not a regular payment. Regular payments will default to the currency code of the invoice they are being made against.

Update an existing tax. All fields aside from the tax_id are optional; by omitting a field, the existing value will remain unchanged.

Verify a callback.