> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve the invoice overview report

> Returns invoice totals and the amount and count of new, cancelled, reactivated, voided and amended invoices for each dated entry in a period.

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.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). 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](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md).


## OpenAPI

````yaml GET /reports/invoices/invoice_overview
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /reports/invoices/invoice_overview:
    get:
      tags:
        - Reports
      summary: Retrieve the invoice overview report
      description: >-
        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.
      operationId: reports_get_reports_invoices_invoice_overview
      parameters:
        - name: date_range
          in: query
          required: false
          description: >-
            The reporting period. `custom` uses `from` and `to`; an unrecognised
            value returns `400`. Without it, a default period applies.
          schema:
            type: string
            example: custom
        - name: from
          in: query
          required: false
          description: The first day of a `custom` period, as `YYYY-MM-DD`.
          schema:
            type: string
            format: date
            example: '2026-09-01'
        - name: to
          in: query
          required: false
          description: The last day of a `custom` period, as `YYYY-MM-DD`.
          schema:
            type: string
            format: date
            example: '2026-09-07'
      responses:
        '200':
          description: The invoice overview report, under `report`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportInvoiceOverviewResponse'
        '400':
          description: '`date_range` is not a recognised value.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            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"
        - lang: python
          label: Python
          source: |
            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)
        - lang: javascript
          label: JavaScript
          source: >
            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);
        - lang: php
          label: PHP
          source: |
            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);
        - lang: java
          label: Java
          source: >
            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());
        - lang: csharp
          label: .NET
          source: >
            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);
        - lang: dart
          label: Dart
          source: >
            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);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Reports().GetReportsInvoicesInvoiceOverview(context.Background(), map[string]any{\n\t\"date_range\": \"custom\",\n\t\"from\":       \"2026-09-01\",\n\t\"to\":         \"2026-09-07\",\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    ReportInvoiceOverviewResponse:
      type: object
      properties:
        report:
          type: object
          properties:
            invoices:
              type: object
              properties:
                invoice_overview:
                  type: array
                  items:
                    $ref: '#/components/schemas/ReportInvoiceOverviewEntry'
    Error:
      type: object
      description: Every failed call returns this body.
      properties:
        object:
          type: string
          description: Always `error`.
        request_id:
          type: string
          description: Quote this to support.
        status:
          type: integer
          description: The HTTP status.
        code:
          type: string
          description: What went wrong, such as `validation_error`.
        message:
          type: string
          description: A short description of the problem.
        doc_url:
          type: string
          description: A link to more about this error.
        errors:
          type: array
          description: One entry per field that failed.
          items:
            type: object
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
              doc_url:
                type: string
    ReportInvoiceOverviewEntry:
      type: object
      properties:
        date:
          type: string
        invoice_total:
          type: string
        new:
          $ref: '#/components/schemas/ReportAmountCount'
        cancelled:
          $ref: '#/components/schemas/ReportAmountCount'
        reactivated:
          $ref: '#/components/schemas/ReportAmountCount'
        voided:
          $ref: '#/components/schemas/ReportAmountCount'
        amended:
          $ref: '#/components/schemas/ReportAmountCount'
        net_gain:
          $ref: '#/components/schemas/ReportAmountCount'
    ReportAmountCount:
      type: object
      properties:
        amount:
          type: string
        count:
          type: string
      description: An amount and a count, both as strings.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.