Retrieve the invoice overview report

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/reports/invoices/invoice_overview?date_range=custom&from=2026-09-01&to=2026-09-07" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.reports.get_reports_invoices_invoice_overview(
    {"date_range": "custom", "from": "2026-09-01", "to": "2026-09-07"}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.reports.getReportsInvoicesInvoiceOverview({
    date_range: 'custom',
    from: '2026-09-01',
    to: '2026-09-07',
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->reports->getReportsInvoicesInvoiceOverview([
    'date_range' => 'custom',
    'from' => '2026-09-01',
    'to' => '2026-09-07',
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.reports.reports_dto.ReportsDto.ReportsInvoicesInvoiceOverview;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ReportsInvoicesInvoiceOverview> response = client.reports().getReportsInvoicesInvoiceOverview(
        Map.of("date_range", "custom", "from", "2026-09-01", "to", "2026-09-07"));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Reports.GetReportsInvoicesInvoiceOverviewAsync(new Dictionary<string, object?>
{
    ["date_range"] = "custom",
    ["from"] = "2026-09-01",
    ["to"] = "2026-09-07",
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.reports.getReportsInvoicesInvoiceOverview(
  queryParams: {
    'date_range': 'custom',
    'from': '2026-09-01',
    'to': '2026-09-07',
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Reports().GetReportsInvoicesInvoiceOverview(context.Background(), map[string]any{
	"date_range": "custom",
	"from":       "2026-09-01",
	"to":         "2026-09-07",
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "report": {
    "invoices": {
      "invoice_overview": [
        {
          "date": "<string>",
          "invoice_total": "<string>",
          "new": {
            "amount": "<string>",
            "count": "<string>"
          },
          "cancelled": {
            "amount": "<string>",
            "count": "<string>"
          },
          "reactivated": {
            "amount": "<string>",
            "count": "<string>"
          },
          "voided": {
            "amount": "<string>",
            "count": "<string>"
          },
          "amended": {
            "amount": "<string>",
            "count": "<string>"
          },
          "net_gain": {
            "amount": "<string>",
            "count": "<string>"
          }
        }
      ]
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

reports

invoices

invoice_overview

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/reports/invoices/invoice_overview?date_range=custom&from=2026-09-01&to=2026-09-07" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.reports.get_reports_invoices_invoice_overview(
    {"date_range": "custom", "from": "2026-09-01", "to": "2026-09-07"}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.reports.getReportsInvoicesInvoiceOverview({
    date_range: 'custom',
    from: '2026-09-01',
    to: '2026-09-07',
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->reports->getReportsInvoicesInvoiceOverview([
    'date_range' => 'custom',
    'from' => '2026-09-01',
    'to' => '2026-09-07',
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.reports.reports_dto.ReportsDto.ReportsInvoicesInvoiceOverview;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ReportsInvoicesInvoiceOverview> response = client.reports().getReportsInvoicesInvoiceOverview(
        Map.of("date_range", "custom", "from", "2026-09-01", "to", "2026-09-07"));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Reports.GetReportsInvoicesInvoiceOverviewAsync(new Dictionary<string, object?>
{
    ["date_range"] = "custom",
    ["from"] = "2026-09-01",
    ["to"] = "2026-09-07",
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.reports.getReportsInvoicesInvoiceOverview(
  queryParams: {
    'date_range': 'custom',
    'from': '2026-09-01',
    'to': '2026-09-07',
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Reports().GetReportsInvoicesInvoiceOverview(context.Background(), map[string]any{
	"date_range": "custom",
	"from":       "2026-09-01",
	"to":         "2026-09-07",
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "report": {
    "invoices": {
      "invoice_overview": [
        {
          "date": "<string>",
          "invoice_total": "<string>",
          "new": {
            "amount": "<string>",
            "count": "<string>"
          },
          "cancelled": {
            "amount": "<string>",
            "count": "<string>"
          },
          "reactivated": {
            "amount": "<string>",
            "count": "<string>"
          },
          "voided": {
            "amount": "<string>",
            "count": "<string>"
          },
          "amended": {
            "amount": "<string>",
            "count": "<string>"
          },
          "net_gain": {
            "amount": "<string>",
            "count": "<string>"
          }
        }
      ]
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

The report is under report.invoices.invoice_overview. Each entry has a date, an invoice_total, and an amount and count for new, cancelled, reactivated, voided, amended and net_gain. Set date_range to custom and pass from and to; with no parameters, the report covers a default period of 7 dated entries.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

date_range

string

The reporting period. custom uses from and to; an unrecognised value returns 400. Without it, a default period applies.

Example:

"custom"

from

string<date>

The first day of a custom period, as YYYY-MM-DD.

Example:

"2026-09-01"

string<date>

The last day of a custom period, as YYYY-MM-DD.

Example:

"2026-09-07"

Response

The invoice overview report, under report.

report

object

Show child attributes

Guides

API reference

Retrieve the invoice overview report

Authorizations

Query Parameters

Response