> ## Documentation Index > Fetch the complete documentation index at: https://docs.dueflow.co/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve the dashboard summary > > **Requires scope** `payments:read` · **Minimum role** viewer The treasurer's home screen in one call: billed, collected and outstanding per currency, the percent paid, the members who owe (longest overdue first, at most 10), recent activity (at most 10), reimbursements awaiting review, subscription stats and, for a national, its chapters with a balance (at most 25). Requires `payments:read`; each optional section is `null` without its own scope: `members:read` for who owes, `reimbursements:read` for reimbursements, `chapters:read` for a national's chapter sections. Pass `termId`, or `from` and `to`, to limit the money sections to a range of charge creation dates. Costs 5 read units. [Scopes and roles](https://docs.dueflow.co/api-reference/scopes) ## OpenAPI ````yaml /openapi.json get /v1/summary openapi: 3.1.0 info: title: Dueflow API version: 1.0.0 description: >- Read and write your organization's Dueflow data. Authenticate with a personal access token or an organization service token as a bearer credential; cookies are ignored. Every endpoint is also a tool on the Dueflow MCP server at https://api.dueflow.co/mcp, which accepts the same bearer tokens or an OAuth connection from ChatGPT and Claude. Timestamps in responses are RFC 3339, UTC, millisecond precision (`2026-01-31T17:04:05.123Z`). Timestamps you send are RFC 3339: send UTC (`Z`); some filters, such as `updatedSince`, also accept an offset. Responses may gain fields at any time; ignore the ones you don't know. Every failure answers with the `Error` envelope; branch on its `code`. termsOfService: https://dueflow.co/terms contact: name: Dueflow support email: hello@dueflow.co url: https://docs.dueflow.co servers: - url: https://api.dueflow.co description: Production security: - bearerAuth: [] paths: /v1/summary: get: tags: - Organization summary: Retrieve the dashboard summary description: >- > **Requires scope** `payments:read` · **Minimum role** viewer The treasurer's home screen in one call: billed, collected and outstanding per currency, the percent paid, the members who owe (longest overdue first, at most 10), recent activity (at most 10), reimbursements awaiting review, subscription stats and, for a national, its chapters with a balance (at most 25). Requires `payments:read`; each optional section is `null` without its own scope: `members:read` for who owes, `reimbursements:read` for reimbursements, `chapters:read` for a national's chapter sections. Pass `termId`, or `from` and `to`, to limit the money sections to a range of charge creation dates. Costs 5 read units. [Scopes and roles](https://docs.dueflow.co/api-reference/scopes) operationId: getSummary parameters: - name: termId in: query required: false schema: description: >- 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 type: string minLength: 1 maxLength: 64 - name: from in: query required: false schema: description: >- Start of a custom range (YYYY-MM-DD, a UTC calendar day); requires to type: string format: date - name: to in: query required: false schema: description: >- End of a custom range (YYYY-MM-DD, a UTC calendar day, inclusive); requires from type: string format: date responses: '200': description: Success headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/DashboardSummary' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' default: $ref: '#/components/responses/UnexpectedError' security: - bearerAuth: - payments:read components: headers: X-Request-Id: description: >- Identifies the request; quote it to support. Also in the error body as `requestId`. schema: type: string RateLimit-Limit: description: Requests the token's budget for this kind of request allows per window. schema: type: integer RateLimit-Remaining: description: Requests left in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the window resets. schema: type: integer Retry-After: description: Seconds to wait before retrying. schema: type: integer schemas: DashboardSummary: type: object properties: organizationType: type: string enum: - chapter - national range: type: - object - 'null' properties: termId: type: - string - 'null' from: type: string format: date to: type: string format: date required: - termId - from - to description: >- The range the money sections cover: charges by creation date, recent activity by event date, whole UTC calendar days. Null for all time totals: type: - array - 'null' items: type: object properties: currency: type: string billed: description: Collected plus outstanding, as a decimal string type: string collected: description: >- Paid so far, store and subscriptions included, as a decimal string type: string outstanding: description: Still owed on open charges, as a decimal string type: string required: - currency - billed - collected - outstanding description: >- 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: type: - integer - 'null' minimum: -9007199254740991 maximum: 9007199254740991 description: >- Members with a balance, archived ones included, as the Outstanding tile counts them. Null for a national percentPaid: description: >- 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 type: - integer - 'null' minimum: -9007199254740991 maximum: 9007199254740991 outstandingMembers: type: - object - 'null' properties: count: description: >- Active members with a balance; outstandingMemberCount also counts archived ones type: integer minimum: -9007199254740991 maximum: 9007199254740991 data: description: >- Who owes, longest overdue first, then most owed, then by name: at most 10. GET /members and GET /payments page the rest type: array items: type: object properties: id: type: string firstName: type: string lastName: type: string outstandingPaymentCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 outstanding: type: array items: type: object properties: currency: type: string amount: description: The amount in currency, as a decimal string type: string required: - currency - amount oldestDueDate: description: >- The earliest due date among the member's open charges, a calendar date; a charge without a due date counts from the day it was created, in the charge's deadline time zone type: string format: date required: - id - firstName - lastName - outstandingPaymentCount - outstanding - oldestDueDate required: - count - data description: A chapter's members with a balance; needs members:read recentActivity: type: - array - 'null' items: type: object properties: id: type: string status: description: 'The payment (or installment) status: paid, pending, …' type: string paymentId: type: string description: type: - string - 'null' amount: description: The amount, as a decimal string type: string currency: type: string occurredAt: description: >- A chapter's: when the installment was paid or started processing, else when the charge was created. A national's: when the charge was sent to the chapter type: string format: date-time paidAt: type: - string - 'null' format: date-time description: When it was paid; null while unpaid member: type: - object - 'null' properties: id: type: string firstName: type: string lastName: type: string required: - id - firstName - lastName description: >- Null for a charge without a member, or when the caller can't read the roster chapter: type: - object - 'null' properties: id: type: string name: type: string required: - id - name description: The billed chapter, on a national's activity required: - id - status - paymentId - description - amount - currency - occurredAt - paidAt - member - chapter description: >- 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: type: - object - 'null' properties: awaitingReview: type: object properties: count: type: integer minimum: -9007199254740991 maximum: 9007199254740991 totals: type: array items: type: object properties: currency: type: string amount: description: The amount in currency, as a decimal string type: string required: - currency - amount required: - count - totals required: - awaitingReview description: >- Submitted reimbursements waiting for a decision, over all time; needs reimbursements:read subscriptions: description: >- Current subscriptions (a national's: its HQ plans), whatever the range type: object properties: activeCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 pastDueCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 monthlyRecurring: type: array items: type: object properties: currency: type: string amount: description: The amount in currency, as a decimal string type: string required: - currency - amount required: - activeCount - pastDueCount - monthlyRecurring chapters: type: - object - 'null' properties: totalChapters: type: integer minimum: -9007199254740991 maximum: 9007199254740991 outstandingChapters: type: integer minimum: -9007199254740991 maximum: 9007199254740991 totalMembers: type: integer minimum: -9007199254740991 maximum: 9007199254740991 count: description: Chapters with an unpaid HQ charge, before the cap on data type: integer minimum: -9007199254740991 maximum: 9007199254740991 data: description: >- Chapters with an unpaid HQ charge, largest balance first, then by name: at most 25. GET /chapters lists every chapter type: array items: type: object properties: id: type: string name: type: string totalMembers: type: integer minimum: -9007199254740991 maximum: 9007199254740991 paymentPercentage: description: Percent of the chapter's HQ charges paid type: integer minimum: -9007199254740991 maximum: 9007199254740991 membersWithOutstanding: type: integer minimum: -9007199254740991 maximum: 9007199254740991 collected: type: array items: type: object properties: currency: type: string amount: description: The amount in currency, as a decimal string type: string required: - currency - amount outstanding: type: array items: type: object properties: currency: type: string amount: description: The amount in currency, as a decimal string type: string required: - currency - amount required: - id - name - totalMembers - paymentPercentage - membersWithOutstanding - collected - outstanding required: - totalChapters - outstandingChapters - totalMembers - count - data description: A national's chapter rollup; needs chapters:read required: - organizationType - range - totals - outstandingMemberCount - percentPaid - outstandingMembers - recentActivity - reimbursements - subscriptions - chapters Error: type: object properties: error: type: object properties: code: description: >- A stable, machine-readable reason. One of `invalid_request` (400), `invalid_token` (401), `insufficient_scope` (403), `step_up_required` (403), `not_found` (404), `method_not_allowed` (405), `conflict` (409), `sync_expired` (410), `rate_limited` (429), `internal_error` (500), `provider_error` (502). New codes may be added; treat an unknown one by its HTTP status. type: string message: type: string param: type: string requiredScopes: type: array items: type: string requestId: type: string docsUrl: type: string required: - code - message - requestId - docsUrl required: - error responses: BadRequest: description: >- Invalid input: a parameter or body field fails validation (`param` names it), the body isn't JSON, or a business rule refused the request. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Missing, malformed, expired or revoked token. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: The token lacks a required scope. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: No such resource, or the token's organization can't see it. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/Error' RateLimited: description: Rate limited; see the `Retry-After` header. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/Error' UnexpectedError: description: >- Any other failure, such as `internal_error` (500), as the `Error` envelope. A failure in front of the API (a gateway timeout, a request too large) may instead be plain text. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/Error' text/plain: schema: type: string securitySchemes: bearerAuth: type: http scheme: bearer description: >- A Dueflow access token: `dfp_` (personal) or `dfs_` (service). Permissions are the token's scopes intersected with the role ceiling, re-evaluated per request. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.