Charge metrics

Needs: Finance, Read

Returns client charge metrics from billing entries dated in a period, covering services, group services and travel: total charged, invoiced and not invoiced, paid, outstanding, draft and void, hours billed, average hourly charge, and totals by status, type and funding source. Staff pay is not included.

Note: Amounts are client charges from billing entries dated in the period. Void entries are left out of the charged totals. outstanding is Unpaid plus Authorised plus Exported CSV. by_type keys are service, group_service and travel. The figures shown are an example.

Note: breakdown is only returned with group_by. For client it also carries a name.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/charges/metrics?from=example_string&to=example_string&client_id=123&group_by=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/charges/metrics?from=example_string&to=example_string&client_id=123&group_by=example_string"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/charges/metrics?from=example_string&to=example_string&client_id=123&group_by=example_string", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://app.imploy.com.au/api/integrations/v1/charges/metrics?from=example_string&to=example_string&client_id=123&group_by=example_string", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://app.imploy.com.au/api/integrations/v1/charges/metrics?from=example_string&to=example_string&client_id=123&group_by=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "period": {
    "from": "2026-03-01",
    "to": "2026-03-31"
  },
  "totals": {
    "charged": 52340.5,
    "entries": 410,
    "invoiced": 40120,
    "not_invoiced": 12220.5,
    "paid": 30000,
    "outstanding": 22340.5,
    "draft": 1800,
    "void": 350,
    "service_hours_billed": 880.25,
    "average_hourly_charge": 58.4,
    "unique_clients_charged": 36
  },
  "by_status": {
    "Paid": {
      "amount": 30000,
      "entries": 250
    }
  },
  "by_type": {
    "service": {
      "amount": 50000,
      "entries": 390
    }
  },
  "by_funding": {
    "ndis": {
      "amount": 40000,
      "entries": 300
    }
  },
  "breakdown": [
    {
      "key": "ndis",
      "amount": 40000,
      "hours": 700,
      "entries": 300
    }
  ]
}