Skip to content

Reports ​

The Reports section provides aggregated turnover and productivity metrics of your company's fee note services.

Required scope: reports — for grouping by customer, additionally customers

Setting up an API access is described in the Help Center.

Endpoints ​

MethodEndpointDescription
GET/api/oauth/v2/resource/fee-note-services/turnoverAggregated turnover, groupable across multiple dimensions
GET/api/oauth/v2/resource/fee-note-services/productivityAppointment duration, appointment count, turnover, and turnover per treating-user hour

Important — the data basis is fee note services, not invoices. The turnover figures therefore contain no goods, product, or voucher turnover and no cancellations. They deliberately differ from the invoice reports in the Offisy interface. If you need invoice-based turnover including goods, don't use these endpoints — use Invoices instead.

Billing status ​

Recorded is not the same as billed. Every row carries a billing status (billStatus) — the same terms as in Journaling:

ValueMeaning
openOpen — not yet billed
invoicedInvoiced — already included in a fee note
ignoreIgnored — marked as not billable
unknownUnknown

Time range and grouping ​

  • from and until (ISO date) are required on both endpoints.
  • The reported date is the service date. If a fee note service has none set, the report falls back to its creation date instead. The row stays within the requested range, but lands in the bucket matching the creation date.
  • Time span limits: max. 366 days when grouping by day or week, max. 732 days when grouping by month or year. Exceeding this returns 400 validation_error.
  • Calendar weeks follow ISO 8601: the week starts on Monday, week 1 is the first week containing a Thursday of the new year.
  • At most one time token is allowed in groupBy per request (day, week, month, or year).

Terminology: category ​

The "category" dimension in these reports is the cost center of the fee note service. It is not the same as:

If you're looking for the UI category or a service bundle, these reports will give you the wrong numbers.

Further limitations ​

  • Fee note services without an appointment have no duration and appear as their own row. They count toward turnover but not toward duration — factoring them into an hourly rate produces wrong values.
  • Fee note services without a linked insurance service (free text) appear grouped under "Without service assignment". Totals remain complete; only the breakdown by free-text name is missing.
  • An OR is a regular resource — there is no dedicated OR report. You recognize OR rooms by the resource name.

Offisy GmbH