Get invoice metrics

GET /api/v1/invoices/metrics

Retrieve aggregated invoice metrics for the business: total outstanding and total overdue across all open invoices.

Operation ID: get_invoice_metrics_api_v1_invoices_metrics_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Responses

200 Successful Response

Schema: InvoiceMetricsResponse

total_outstanding integer required: Sum of the total for all invoices in 'open' status (in cents).
total_overdue integer required: Sum of the total for all open invoices where the current date exceeds the due date (in cents).

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/invoices/metrics

bash

curl -X GET 'https://api.ondayzero.com/api/v1/invoices/metrics' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/invoices/metrics', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/invoices/metrics", headers=headers)
data = response.json()