Skip to main content

Expense Reports

Information pertaining to retrieving expense reports.

Link to Documentation

Clients Expense Report

Clients Expense Report shows expense totals for each client where expenses are present for a given timeframe.

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)

Link to Documentation

hrvst reports expense-reports clients-expense-report
OptionDescriptionRequired
--fromOnly report on expenses with a spent_date on or after the given date.true
--toOnly report on expenses with a spent_date on or before the given date.true
--pageThe page number to use in pagination. Use all to retrieve all pages.false
--per_pageThe number of records to return per page. Can range between 1 and 2000.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Projects Expense Report

Projects Expense Report shows expense totals for each project where expenses are present for a given timeframe.

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)

Link to Documentation

hrvst reports expense-reports projects-expense-report
OptionDescriptionRequired
--fromOnly report on expenses with a spent_date on or after the given date.true
--toOnly report on expenses with a spent_date on or before the given date.true
--pageThe page number to use in pagination. Use all to retrieve all pages.false
--per_pageThe number of records to return per page. Can range between 1 and 2000.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Expense Categories Report

Expense Categories Report shows expense totals for each expense category where expenses are present for a given timeframe.

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)

Link to Documentation

hrvst reports expense-reports categories-report
OptionDescriptionRequired
--fromOnly report on expenses with a spent_date on or after the given date.true
--toOnly report on expenses with a spent_date on or before the given date.true
--pageThe page number to use in pagination. Use all to retrieve all pages.false
--per_pageThe number of records to return per page. Can range between 1 and 2000.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Team Expense Report

Team Expense Report shows expense totals for each user where expenses are present for a given timeframe.

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)

Link to Documentation

hrvst reports expense-reports team-expense-report
OptionDescriptionRequired
--fromOnly report on expenses with a spent_date on or after the given date.true
--toOnly report on expenses with a spent_date on or before the given date.true
--pageThe page number to use in pagination. Use all to retrieve all pages.false
--per_pageThe number of records to return per page. Can range between 1 and 2000.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse