Skip to main content
GET
Retrieve the dashboard summary

Authorizations

Authorization
string
header
required

A Dueflow access token: dfp_ (personal) or dfs_ (service). Permissions are the token's scopes intersected with the role ceiling, re-evaluated per request.

Scopes

payments:read

Query Parameters

termId
string

Limit the money sections to a term: an organization term's id (GET /organization/terms), or fall / spring for an organization that hasn't defined its own terms

Required string length: 1 - 64
from
string<date>

Start of a custom range (YYYY-MM-DD, a UTC calendar day); requires to

to
string<date>

End of a custom range (YYYY-MM-DD, a UTC calendar day, inclusive); requires from

Response

Success

organizationType
enum<string>
required
Available options:
chapter,
national
range
object | null
required

The range the money sections cover: charges by creation date, recent activity by event date, whole UTC calendar days. Null for all time

totals
object[] | null
required

Per currency, as the dashboard's tiles show it; a currency with nothing billed is left out. A national's totals are its HQ charges, to its chapters and straight to their members, and need chapters:read; null without it

outstandingMemberCount
integer | null
required

Members with a balance, archived ones included, as the Outstanding tile counts them. Null for a national

Required range: -9007199254740991 <= x <= 9007199254740991
percentPaid
integer | null
required

Percent of members with every charge paid, rounded. A national's: percent of chapters with every charge sent to the chapter paid (bills sent straight to members aren't counted), as the dashboard shows it

Required range: -9007199254740991 <= x <= 9007199254740991
outstandingMembers
object | null
required

A chapter's members with a balance; needs members:read

recentActivity
object[] | null
required

Newest first, at most 10. A chapter's: charges created and payments received. A national's: the charges it sent to its chapters (not bills sent straight to members), which needs chapters:read

reimbursements
object | null
required

Submitted reimbursements waiting for a decision, over all time; needs reimbursements:read

subscriptions
object
required

Current subscriptions (a national's: its HQ plans), whatever the range

chapters
object | null
required

A national's chapter rollup; needs chapters:read