Customer Financial Summary

GET

customers

{id}

financial-summary

Customer financial summary

curl --request GET \
  --url https://billing.example.com/v1/customers/{id}/financial-summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://billing.example.com/v1/customers/{id}/financial-summary"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/customers/{id}/financial-summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/customers/{id}/financial-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/customers/{id}/financial-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/customers/{id}/financial-summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currencies": [
      {
        "currency": "<string>",
        "outstanding": 123,
        "past_due": 123,
        "past_due_count": 123,
        "billed": 123,
        "paid": 123
      }
    ]
  }
}

What it returns

A customer’s invoice-derived financial position, one block per currency:

outstanding — the amount remaining on open + past_due invoices.
past_due / past_due_count — the past-due slice of that, and how many invoices it spans.
billed — lifetime issued total.
paid — lifetime paid.

Written-off invoices are excluded from outstanding; draft and void invoices are excluded from billed and paid. Money is never summed across currencies — a customer billed in both USD and INR gets two blocks, not one converted figure. Every number here is derived from invoices you can list with List Invoices filtered by customer_id, so it can always be explained; see Explain any number.

Example request

curl https://api.recurso.dev/v1/customers/0b7a3f7e-4a2b-4c1d-9e8f-1a2b3c4d5e6f/financial-summary \
  -H "Authorization: Bearer $API_KEY"

Example response

{
  "data": {
    "customer_id": "0b7a3f7e-4a2b-4c1d-9e8f-1a2b3c4d5e6f",
    "currencies": [
      {
        "currency": "USD",
        "outstanding": 236000,
        "past_due": 118000,
        "past_due_count": 1,
        "billed": 944000,
        "paid": 708000
      }
    ]
  }
}

Fields

Field	Type	Description
`currency`	string	ISO currency code for this block
`outstanding`	integer (int64)	Amount remaining on `open` + `past_due` invoices, minor units
`past_due`	integer (int64)	The past-due portion of `outstanding`
`past_due_count`	integer	Number of past-due invoices
`billed`	integer (int64)	Lifetime issued total (excludes `draft`/`void`)
`paid`	integer (int64)	Lifetime paid (excludes `draft`/`void`)

Read-only. A customer with no non-draft invoices returns an empty currencies list; a missing or cross-tenant id returns 404. For the customer’s account-credit position, use the credit statement.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

string<uuid>

required

Response

The financial summary.

data

object

Show child attributes

Customer financial summary

curl --request GET \
  --url https://billing.example.com/v1/customers/{id}/financial-summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://billing.example.com/v1/customers/{id}/financial-summary"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/customers/{id}/financial-summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/customers/{id}/financial-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/customers/{id}/financial-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/customers/{id}/financial-summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currencies": [
      {
        "currency": "<string>",
        "outstanding": 123,
        "past_due": 123,
        "past_due_count": 123,
        "billed": 123,
        "paid": 123
      }
    ]
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Customer Financial Summary

What it returns

Example request

Example response

Fields

Authorizations

Path Parameters

Response

​What it returns

​Example request

​Example response

​Fields

Authorizations

Path Parameters

Response

What it returns

Example request

Example response

Fields