Reports
Time report
GEThttps://paysuitett.com/api/v1/reports
Every Staff member's time for a client, project or period, as Time Reports shows it: totals, a summary by group, and every entry. Owners', accountants' and managers' own time is left out, unless a master key sends `scope=everyone`. A personal key reports approved time only, so its per-client reports are final; a master key reports every status.
Access. Any key, read only. Hours only; a master key also gets amounts, at each project's billing rate.
Query parameters
billingstring- Time-report billing filter; defaults to all. Unbilled/billed includes only billable time.Allowed:
allunbilledbilled rangestring- A preset period. Weeks run Monday to Sunday. Or send start and end.Allowed:
todaythis_weeklast_weekthis_monthlast_monththis_year startstring · date- First day, YYYY-MM-DD (instead of range).
endstring · date- Last day, YYYY-MM-DD (instead of range).
clientstring · repeatable- A client's name. Repeat for several.
projectstring · uuid · repeatable- A project's ID. Repeat for several.
personstring · uuid · repeatable- A person's user_id (from GET /people). Repeat for several.
taskstring · repeatable- A task's ID. Repeat for several.
descriptionstring- Entries whose description contains this text.
billablestring- Defaults to all.Allowed:
allbillablenon_billable statusstring- Defaults to all.Allowed:
allapprovedunapproved tabstring- Which report, for CSV and PDF. Defaults to summary.Allowed:
summarydetailedweekly groupstring- Summary grouping. Defaults to project.Allowed:
projectclientpersondatetaskdescription subgroupstring- Summary sub-grouping. Defaults to description.Allowed:
projectclientpersondatetaskdescription formatstring- Defaults to json.Allowed:
jsoncsvpdf scopestring- Master key only: `everyone` includes owners', accountants' and managers' own time, as the owner's Time Reports page does. Defaults to staff.Allowed:
staffeveryone
Response
200 with a JSON body, as in the example. With format=csv, a CSV file (text/csv); with format=pdf, the Time Reports PDF (application/pdf). Both download as attachments.
- Billable hours count approved time only; billable time not yet approved is `awaiting_approval_billable_hours`.
- With a master key, `totals`, `summary` and `entries` also carry `amount` (and `totals.currency`) for projects with a billing rate (set once on the project). When the amounts are in more than one currency, `totals` and that `summary` group leave out `amount` and give `amounts_by_currency` instead.