Invoice KPIs

Monitor billing performance, track revenue trends, and analyse financial metrics across your platform. Invoice KPIs provide comprehensive insights into billing cycles, payment patterns, and revenue distribution.

Available KPIs

Invoice Summary

Returns overall invoice statistics and totals.

Endpoint

GET /backend/kpi/invoices/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "invoice_currency": "GBP",
    "invoice_customer_count": 12500,
    "invoice_count": 13200,
    "invoice_amount": 378000.50,
    "invoice_outstanding": 45000.00
  },
  {
    "invoice_currency": "EUR",
    "invoice_customer_count": 2647,
    "invoice_count": 2647,
    "invoice_amount": 78789.00,
    "invoice_outstanding": 12500.00
  }
]

Invoices by Dealer

Groups invoices by dealer for segmentation and comparison.

Endpoint

GET /backend/kpi/invoices/byDealer/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/byDealer/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "invoice_dealer": "DEALER01",
    "invoice_currency": "GBP",
    "invoice_customer_count": 4200,
    "invoice_count": 4500,
    "invoice_amount": 135000.00,
    "invoice_outstanding": 12000.00
  },
  {
    "invoice_dealer": "DEALER01",
    "invoice_currency": "EUR",
    "invoice_customer_count": 1200,
    "invoice_count": 1230,
    "invoice_amount": 35000.00,
    "invoice_outstanding": 3500.00
  },
  {
    "invoice_dealer": "DEALER02",
    "invoice_currency": "GBP",
    "invoice_customer_count": 3000,
    "invoice_count": 3200,
    "invoice_amount": 96000.00,
    "invoice_outstanding": 8500.00
  },
  {
    "invoice_dealer": "DIRECT",
    "invoice_currency": "GBP",
    "invoice_customer_count": 5300,
    "invoice_count": 5500,
    "invoice_amount": 225789.50,
    "invoice_outstanding": 24500.00
  }
]

Invoices by Month

Tracks billing trends over time.

Endpoint

GET /backend/kpi/invoices/byMonth/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/byMonth/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "invoice_month": "2023-11",
    "invoice_currency": "GBP",
    "invoice_customer_count": 2500,
    "invoice_count": 2650,
    "invoice_amount": 75500.00,
    "invoice_outstanding": 5000.00
  },
  {
    "invoice_month": "2023-11",
    "invoice_currency": "EUR",
    "invoice_customer_count": 720,
    "invoice_count": 720,
    "invoice_amount": 20500.00,
    "invoice_outstanding": 1200.00
  },
  {
    "invoice_month": "2023-12",
    "invoice_currency": "GBP",
    "invoice_customer_count": 2550,
    "invoice_count": 2700,
    "invoice_amount": 77200.00,
    "invoice_outstanding": 3500.00
  },
  {
    "invoice_month": "2024-01",
    "invoice_currency": "GBP",
    "invoice_customer_count": 2600,
    "invoice_count": 2750,
    "invoice_amount": 79300.00,
    "invoice_outstanding": 8900.00
  }
]

Invoices by Dealer by Month

Combines time-based and dealer segmentation analysis.

Endpoint

GET /backend/kpi/invoices/byDealerByMonth/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/byDealerByMonth/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "invoice_month": "2024-01",
    "invoice_dealer": "DEALER01",
    "invoice_currency": "GBP",
    "invoice_customer_count": 350,
    "invoice_count": 375,
    "invoice_amount": 11250.00,
    "invoice_outstanding": 1000.00
  },
  {
    "invoice_month": "2024-01",
    "invoice_dealer": "DEALER01",
    "invoice_currency": "EUR",
    "invoice_customer_count": 100,
    "invoice_count": 105,
    "invoice_amount": 3000.00,
    "invoice_outstanding": 250.00
  },
  {
    "invoice_month": "2024-01",
    "invoice_dealer": "DEALER02",
    "invoice_currency": "GBP",
    "invoice_customer_count": 260,
    "invoice_count": 270,
    "invoice_amount": 8100.00,
    "invoice_outstanding": 700.00
  },
  {
    "invoice_month": "2024-02",
    "invoice_dealer": "DEALER01",
    "invoice_currency": "GBP",
    "invoice_customer_count": 355,
    "invoice_count": 380,
    "invoice_amount": 11400.00,
    "invoice_outstanding": 950.00
  }
]

Invoice Breakdown

Provides detailed breakdown of charges by type.

Endpoint

GET /backend/kpi/invoices/breakdown/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/breakdown/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "invoice_currency": "GBP",
    "invoice_customer_count": 12500,
    "invoice_count": 13200,
    "invoice_amountOneOff": 35000.00,
    "invoice_amountRecurring": 150000.00,
    "invoice_amountCalls": 180000.00,
    "invoice_amountRefunds": -5000.00,
    "invoice_amountLateFees": 2500.00,
    "invoice_amountInterest": 1200.00,
    "invoice_amountCarrierProvided": 8000.00,
    "invoice_amountManualBilling": 4500.00,
    "invoice_amountLowUsage": 1800.00,
    "invoice_amountManual": 0.00
  },
  {
    "invoice_currency": "EUR",
    "invoice_customer_count": 2647,
    "invoice_count": 2647,
    "invoice_amountOneOff": 8000.00,
    "invoice_amountRecurring": 40000.00,
    "invoice_amountCalls": 25000.00,
    "invoice_amountRefunds": -1000.00,
    "invoice_amountLateFees": 500.00,
    "invoice_amountInterest": 200.00,
    "invoice_amountCarrierProvided": 2000.00,
    "invoice_amountManualBilling": 1089.00,
    "invoice_amountLowUsage": 500.00,
    "invoice_amountManual": 2500.00
  }
]

Invoice Breakdown by Month

Shows charge type breakdown over time.

Endpoint

GET /backend/kpi/invoices/breakdownByMonth/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/breakdownByMonth/?minDate=2024-01-01&maxDate=2024-01-31" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "invoice_month": "2024-01",
    "invoice_currency": "GBP",
    "invoice_customer_count": 2600,
    "invoice_count": 2750,
    "invoice_amountOneOff": 5500.00,
    "invoice_amountRecurring": 27000.00,
    "invoice_amountCalls": 42000.00,
    "invoice_amountRefunds": -800.00,
    "invoice_amountLateFees": 400.00,
    "invoice_amountInterest": 200.00,
    "invoice_amountCarrierProvided": 1500.00,
    "invoice_amountManualBilling": 800.00,
    "invoice_amountLowUsage": 300.00,
    "invoice_amountManual": 2400.00
  },
  {
    "invoice_month": "2024-01",
    "invoice_currency": "EUR",
    "invoice_customer_count": 750,
    "invoice_count": 750,
    "invoice_amountOneOff": 1500.00,
    "invoice_amountRecurring": 7000.00,
    "invoice_amountCalls": 11000.00,
    "invoice_amountRefunds": -200.00,
    "invoice_amountLateFees": 100.00,
    "invoice_amountInterest": 50.00,
    "invoice_amountCarrierProvided": 400.00,
    "invoice_amountManualBilling": 200.00,
    "invoice_amountLowUsage": 100.00,
    "invoice_amountManual": 350.00
  }
]

Invoice Breakdown by Dealer by Month

Comprehensive breakdown by time period and dealer segmentation.

Endpoint

GET /backend/kpi/invoices/breakdownByDealerByMonth/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/breakdownByDealerByMonth/?dealerCode=DEALER01" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "invoice_month": "2024-01",
    "invoice_dealer": "DEALER01",
    "invoice_currency": "GBP",
    "invoice_customer_count": 350,
    "invoice_count": 375,
    "invoice_amountOneOff": 800.00,
    "invoice_amountRecurring": 3700.00,
    "invoice_amountCalls": 6000.00,
    "invoice_amountRefunds": -150.00,
    "invoice_amountLateFees": 60.00,
    "invoice_amountInterest": 30.00,
    "invoice_amountCarrierProvided": 200.00,
    "invoice_amountManualBilling": 110.00,
    "invoice_amountLowUsage": 50.00,
    "invoice_amountManual": 450.00
  },
  {
    "invoice_month": "2024-01",
    "invoice_dealer": "DEALER01",
    "invoice_currency": "EUR",
    "invoice_customer_count": 100,
    "invoice_count": 105,
    "invoice_amountOneOff": 200.00,
    "invoice_amountRecurring": 1000.00,
    "invoice_amountCalls": 1500.00,
    "invoice_amountRefunds": -50.00,
    "invoice_amountLateFees": 20.00,
    "invoice_amountInterest": 10.00,
    "invoice_amountCarrierProvided": 50.00,
    "invoice_amountManualBilling": 30.00,
    "invoice_amountLowUsage": 15.00,
    "invoice_amountManual": 225.00
  },
  {
    "invoice_month": "2024-01",
    "invoice_dealer": "DEALER02",
    "invoice_currency": "GBP",
    "invoice_customer_count": 260,
    "invoice_count": 270,
    "invoice_amountOneOff": 600.00,
    "invoice_amountRecurring": 2700.00,
    "invoice_amountCalls": 4300.00,
    "invoice_amountRefunds": -100.00,
    "invoice_amountLateFees": 40.00,
    "invoice_amountInterest": 20.00,
    "invoice_amountCarrierProvided": 150.00,
    "invoice_amountManualBilling": 80.00,
    "invoice_amountLowUsage": 35.00,
    "invoice_amountManual": 275.00
  }
]

Filtering Options

Refine your results using these filter parameters:

Parameter	Type	Description	Example
unsent	boolean	Include only unsent invoices	`unsent=true`
includeUnsent	boolean	Include unsent invoices with sent ones	`includeUnsent=true`
dealerCode	string	Filter by specific dealer code	`dealerCode=DEALER01`
minDate	date	Invoices dated on or after	`minDate=2024-01-01`
maxDate	date	Invoices dated on or before	`maxDate=2024-01-31`
minDueDate	date	Invoices due on or after	`minDueDate=2024-02-01`
maxDueDate	date	Invoices due on or before	`maxDueDate=2024-02-28`

Filter Examples

Current Month Invoices

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/?minDate=2024-01-01&maxDate=2024-01-31" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Overdue Invoices

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/?maxDueDate=2024-01-14" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Unsent Invoices by Dealer

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/byDealer/?unsent=true" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Revenue Breakdown for Date Range

curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/breakdown/?minDate=2024-01-01&maxDate=2024-01-31" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Use Cases

Revenue Tracking

Monitor overall revenue performance:

# Current month revenue
curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/?minDate=2024-01-01&maxDate=2024-01-31" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

# Revenue trend by month
curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/byMonth/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Segmentation Analysis

Compare performance across different segments:

# Revenue by dealer segments
curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/byDealer/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

# Monthly trends by segment
curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/byDealerByMonth/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Revenue Composition Analysis

Understand revenue sources:

# Overall charge type breakdown
curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/breakdown/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

# Monthly charge evolution
curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/breakdownByMonth/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Cash Flow Management

Monitor payment status and timing:

# Unsent invoices requiring attention
curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/?unsent=true" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

# Invoices due this week
curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/?minDueDate=2024-01-15&maxDueDate=2024-01-21" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Best Practices

Daily Monitoring - Check unsent invoices daily to ensure timely billing
Revenue Tracking - Monitor charge type breakdowns to identify revenue shifts
Segmentation Analysis - Compare performance across different customer segments
Trend Analysis - Track monthly trends to forecast revenue and identify seasonality
Payment Monitoring - Use due date filters to manage cash flow effectively

Understanding Charge Types

The breakdown KPIs provide detailed charge categorisation:

amountOneOff - One-time charges including setup fees and installations
amountRecurring - Monthly recurring charges for services and rentals
amountCalls - Usage charges for calls, SMS, and data consumption
amountRefunds - Credit adjustments and refunds (negative values)
amountLateFees - Late payment penalty charges
amountInterest - Interest charges on overdue balances
amountCarrierProvided - Charges from carrier-provided services
amountManualBilling - Manually created billing items
amountLowUsage - Low usage or minimum commitment charges
amountManual - Other manual adjustments and miscellaneous charges

Multi-Currency Support

Invoice KPIs fully support multi-currency operations:

All monetary values are returned by currency
Totals are not combined across currencies
Average calculations are per-currency
Ensure your reporting handles multiple currencies appropriately

Customer KPIs - Correlate customer counts with invoice generation
Feature KPIs - Match feature revenue with invoice breakdowns
Number KPIs - Track number-related charges in invoices

Invoice KPIs

Available KPIs

Invoice Summary

Invoices by Dealer

Invoices by Month

Invoices by Dealer by Month

Invoice Breakdown

Invoice Breakdown by Month

Invoice Breakdown by Dealer by Month

Filtering Options

Filter Examples

Use Cases

Revenue Tracking

Segmentation Analysis

Revenue Composition Analysis

Cash Flow Management

Best Practices

Understanding Charge Types

Multi-Currency Support

Related KPIs