Developer documentation

Revenue report

get https://app.iteras.dk/api/revenuereport/

The /api/revenuereport/ endpoint enables you to download the revenue report from Iteras in CSV format.

Parameters

  • calculate string required
    Must be either invoiced, accrued or notyetaccrued.
  • start_date date required
    E.g. 2026-07-30 (inclusive).
  • end_date date required
    E.g. 2026-10-29 (inclusive).
  • columns string required
    A comma separated list of columns to include in the export. Options are invoices, without_vat, vat, with_vat. At least one is required.
  • distribute_on string
    Breaks the report into rows, one per value of the dimension. Up to four dimensions are allowed. E.g. &distribute_on=customer_country&distribute_on=invoice_line_recurring. See dimensions.
  • product string
    Restricts the report to the given products, given by their external_id. Can be repeated. Use the string none for revenue not tied to a product, e.g. fees. You can combine none with one or more product IDs to include both.
  • business_entity string
    The external ID of the business entity to make the report for. It can be left out if the account has only one business entity. Otherwise the request returns an HTTP 400 error.
  • encoding string Defaults to ISO-8859-1
    Character set of returned CSV file, UTF-8 or ISO-8859-1.

Return value

Returns the report data as a CSV file, in the same format as you get if you download the export inside Iteras. Columns are separated by semicolons, and each dimension value gets its own row with a Total row at the end. Distributing on two dimensions gives one row per combination of values. For example:

GET /api/revenuereport/?calculate=invoiced&start_date=2026-07-30&end_date=2026-10-29&columns=invoices,with_vat&distribute_on=customer_country&distribute_on=productCountry;Product;Number of invoices;invoiced w/ VAT;credited w/ VAT;total w/ VAT
Denmark;Print;2;400,00;0,00;400,00
Denmark;Digital;1;200,00;0,00;200,00
Sweden;Print;1;150,00;0,00;150,00
Total;;4;750,00;0,00;750,00

Errors

A missing calculate, start_date or end_date, an invalid calculate, an unknown business_entity, or a product filter that matches no products returns a plain text HTTP 404 error.

A missing business_entity that cannot be derived, a missing or invalid columns, more than four distribute_on choices, an unknown dimension, or an invalid encoding returns a plain text HTTP 400 error.

Example

The endpoint can be used to automatically download a revenue report on a regular basis. For instance, you could monthly fetch last 30 days data with something like:

curl --request GET "https://app.iteras.dk/api/revenuereport/?calculate=invoiced&start_date=2026-09-29&end_date=2026-10-29&columns=invoices,with_vat&product=452&distribute_on=country&distribute_on=field:petowner " \
       --header "Authorization: Bearer <Iteras API key>" \
       -OJ  # output the file to the standard Iteras filename supplied in the HTTP header