Skip to main content
GET
/
v1
/
analytics
/
collections
/
summary
Get Collections Summary
curl --request GET \
  --url http://api.stuut.ai/v1/analytics/collections/summary \
  --header 'Authorization: Bearer <token>'
[
  {
    "period_end": "2023-12-25",
    "period_start": "2023-12-25",
    "avg_days_to_pay_from_due": 123,
    "avg_days_to_pay_from_issued": 123,
    "amount_collected": 123,
    "amount_collected_stuut_touched": 123,
    "amount_collected_automated": 123,
    "amount_issued": 123,
    "amount_issued_stuut_touched": 123,
    "amount_overdue": 123,
    "amount_overdue_stuut_touched": 123,
    "amount_receivables": 123,
    "amount_receivables_stuut_touched": 123,
    "balance": 123,
    "balance_stuut_touched": 123,
    "balance_for_period": 123,
    "balance_for_period_stuut_touched": 123,
    "balance_period_start": 123,
    "balance_period_start_stuut_touched": 123,
    "invoices_collected": 123,
    "invoices_collected_stuut_touched": 123,
    "invoices_issued": 123,
    "invoices_open": 123,
    "invoices_overdue": 123,
    "invoices_paid": 123,
    "invoices_touched": 123,
    "invoices_touched_and_collected": 123,
    "amount_collected_other": 0,
    "dso": null,
    "dso_stuut_touched": null,
    "invoices_touched_and_collected_ratio": 0
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

interval
enum<string>
default:monthly

The time period for the query

Available options:
weekly,
monthly,
all

Response

Successful response

period_end
string<date>
required

The period end date.

period_start
string<date>
required

The period start date.

avg_days_to_pay_from_due
number
required

Average days to payment from due date

avg_days_to_pay_from_issued
number
required

Average days to payment from issued date

amount_collected
integer
required

Total amount collected

amount_collected_stuut_touched
integer
required

Total amount collected with stuut

amount_collected_automated
integer
required

Total amount collection through Stuut automation

amount_issued
integer
required

Total amount issued

amount_issued_stuut_touched
integer
required

Total amount issued for invoices touched by stuut

amount_overdue
integer
required

Total remaining overdue for the period

amount_overdue_stuut_touched
integer
required

Total remaining overdue for the period

amount_receivables
integer
required

Total accounts receivable

amount_receivables_stuut_touched
integer
required

Total accounts receivable with stuut

balance
integer
required

Total open balance

balance_stuut_touched
integer
required

Total open balance of invoices touched by stuut

balance_for_period
integer
required

Total open balance for the period

balance_for_period_stuut_touched
integer
required

Total open balance for the period of invoices touched by stuut

balance_period_start
integer
required

Total open balance of invoices

balance_period_start_stuut_touched
integer
required

Total open balance of invoices touched by stuut

invoices_collected
integer
required

Total # invoices collected on

invoices_collected_stuut_touched
integer
required

Total # invoices collected on with stuut

invoices_issued
integer
required

Total # invoices issued

invoices_open
integer
required

Total # open invoices

invoices_overdue
integer
required

Total # overdue invoices

invoices_paid
integer
required

Total # paid invoices

invoices_touched
integer
required

Total # invoices touched by stuut

invoices_touched_and_collected
integer
required

Total # invoices touched by stuut

amount_collected_other
integer
default:0

Total amount collected outside of Stuut.

dso
number | null

Days of sale outstanding

dso_stuut_touched
number | null

Days of sale outstanding with stuut

invoices_touched_and_collected_ratio
number
default:0

Total # invoices touched by stuut