This is the current API V2 documentation. For the legacy API V1 documentation, click here.

Expense Reports

Expense reports show expense totals for each client, project, expense category, or user, where expenses are present for a given timeframe.

If you’re an Administrator, you’ll see all clients, projects, expense categories, and users for the account. Project Managers will see their own expenses, plus those for any projects they manage. Regular Users will only see their own expenses.

The response contains an object with a results property that contains an array of up to per_page results. Each entry in the array is a separate result object. If no more results are available, the resulting array will be empty. Several additional pagination properties are included in the response to simplify paginating your results.

Note: Each expense report request requires both the from and to parameters to be supplied in the URL’s query string. The timeframe supplied cannot exceed 1 year (365 days).

The result object

Attribute

Type

Description

client_id

integer

The ID of the client associated with the reported expenses. Only returned in the Client and Project reports.

client_name

string

The name of the client associated with the reported expenses. Only returned in the Client and Project reports.

project_id

integer

The ID of the project associated with the reported expenses. Only returned in the Client and Project reports.

project_name

string

The name of the project associated with the reported expenses. Only returned in the Client and Project reports.

expense_category_id

integer

The ID of the expense category associated with the reported expenses. Only returned in the Expense Category report.

expense_category_name

string

The name of the expense category associated with the reported expenses. Only returned in the Expense Category report.

user_id

integer

The ID of the user associated with the reported expenses. Only returned in the Team report.

user_name

string

The name of the user associated with the reported expenses. Only returned in the Team report.

is_contractor

boolean

The contractor status of the user associated with the reported expenses. Only returned in the Team report.

total_amount

decimal

The totaled cost for all expenses for the given timeframe, subject (client, project, expense category, or user), and currency.

billable_amount

decimal

The totaled cost for billable expenses for the given timeframe, subject (client, project, expense category, or user), and currency.

currency

string

The currency code associated with the expenses for this result.

Clients Report

GET /v2/reports/expenses/clients

Parameter

Type

Required

Description

from

date

required

Only report on expenses with a spent_date on or after the given date.

to

date

required

Only report on expenses with a spent_date on or before the given date.

page

integer

optional

The page number to use in pagination. For instance, if you make a list request and receive 100 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)

per_page

integer

optional

The number of records to return per page. Can range between 1 and 1000. (Default: 1000)