> ## 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 an invoice's KPIs

> Returns an invoice's key figures, such as payment applied and amount outstanding.

Fetches the invoice's KPI block under `invoice_kpis`, the same block a retrieved invoice carries as `kpis`. Amounts such as `payment_applied` are strings.

> [!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 /invoices/{invoice_id}/kpis
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:
  /invoices/{invoice_id}/kpis:
    get:
      tags:
        - Invoices
      summary: Retrieve an invoice's KPIs
      description: >-
        Fetches the invoice's KPI block under `invoice_kpis`, the same block a
        retrieved invoice carries as `kpis`. Amounts such as `payment_applied`
        are strings.
      operationId: invoices_get_invoice_kpis
      parameters:
        - name: invoice_id
          in: path
          required: true
          description: The invoice's `id`, such as `INV-0001`. Not its `uuid`.
          schema:
            type: string
      responses:
        '200':
          description: The KPIs, under `invoice_kpis`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceKpisReadResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X GET "$EXSITED_BASE_URL/api/v4/invoices/INV-0001/kpis" \
              -H "Authorization: Bearer $ACCESS_TOKEN"
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.invoices.get_invoice_kpis("INV-0001")
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.invoices.getInvoiceKpis('INV-0001');
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->invoices->getInvoiceKpis('INV-0001');
            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.invoices.invoices_dto.InvoicesDto.InvoiceKpisRead;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<InvoiceKpisRead> response =
            client.invoices().getInvoiceKpis("INV-0001");

            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.Invoices.GetInvoiceKpisAsync("INV-0001");


            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: |
            import 'package:exsited/exsited.dart';

            final client = buildClient();

            final response = await client.invoices.getInvoiceKpis('INV-0001');
            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.Invoices().GetInvoiceKPIs(context.Background(), \"INV-0001\", nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    InvoiceKpisReadResponse:
      type: object
      properties:
        invoice_kpis:
          $ref: '#/components/schemas/InvoiceKpisRead'
    InvoiceKpisRead:
      type: object
      properties:
        credit_applied:
          type: string
        credit_issued:
          type: string
        payment_applied:
          type: string
        last_payment_date:
          type: string
        last_amended_on:
          type: string
        last_cancelled_on:
          type: string
        last_reactivated_on:
          type: string
        deleted_on:
          type: string
        voided_on:
          type: string
        outstanding: {}
        overdue: {}
        object:
          type: string
  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.