> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Get payment dashboard > Returns aggregated counts, amounts, and breakdowns of payments for the specified period. ## OpenAPI ````yaml /en/openapi/v3-current/payments.yaml get /v1/dashboards/payments openapi: 3.1.0 info: description: >- API for the Lerian Payments interface via BTG. It covers boleto issuance, cancellation, installments, and queries; bill payments (bankslip, utilities, and DARF), cancellation, and queries; aggregated boleto and payment dashboards; provider connection and outbound webhook configuration; and the provider webhook receiver for settlement events. ERROR BODIES. A failed request arrives in one of three shapes, and which one you get depends on where the service catches the failure, not on which endpoint you called. The authentication and authorization layer runs ahead of everything else and answers plain text with a bare reason and no error code. A failure that the request pipeline catches next, before the API layer sees it, answers a flat JSON body on application/json; the idempotency check is the pipeline rule you meet most often. Everything the API layer catches answers an RFC 9457 problem document on application/problem+json. Read the media type to tell the two JSON bodies apart. The code member holds the same PBP-NNNN value in both, so branch on it, and handle 401 and 403 by status because a refusal from the authentication layer carries no code. One pipeline refusal is not listed on the operations below: while a first request under the same idempotency key is still in flight, a retry is answered 409 with code PBP-0007 and the flat body. title: Payments — via BTG API version: 1.0.0 servers: - url: https://payments.sandbox.lerian.net security: [] tags: - description: >- Tenant-level setup: connecting the banking provider and configuring where status notifications are delivered. name: Admin - description: >- Issuing, querying and cancelling boletos, including installment series and the rendered PDF. name: Boletos - description: >- Aggregated counts, amounts and breakdowns over a period, for boletos and for payments. name: Dashboards - description: >- Paying bankslips, utility bills and DARF tax slips, and querying or cancelling those payments. name: Payments - description: >- The webhook the payment provider posts settlement events to. Authenticated with a credential agreed with the provider, not with the platform identity used by the rest of this API. name: Settlement paths: /v1/dashboards/payments: get: tags: - Dashboards summary: Get payment dashboard description: >- Returns aggregated counts, amounts, and breakdowns of payments for the specified period. operationId: getPaymentDashboard parameters: - description: >- Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing. in: header name: X-Organization-Id schema: description: >- Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing. type: string - description: Created-from date, inclusive. explode: false in: query name: from schema: description: Created-from date, inclusive. examples: - '2026-01-01' format: date type: string - description: Created-to date, inclusive. explode: false in: query name: to schema: description: Created-to date, inclusive. examples: - '2026-12-31' format: date type: string - description: Payment type filter. explode: false in: query name: type schema: description: Payment type filter. enum: - BANKSLIP - UTILITIES - DARF examples: - BANKSLIP type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaymentDashboardResponse' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' text/plain: schema: type: string application/json: schema: $ref: '#/components/schemas/PipelineError' description: >- Authentication failed. Two shapes are possible and a client must accept both: the authentication middleware answers `text/plain` with a bare reason (for example `Missing Token`) and carries no error code, while a refusal raised inside the service answers `application/problem+json` with code `PBP-0003`. '403': content: text/plain: schema: type: string description: >- The authenticated principal is not permitted to perform this action. Answered as `text/plain` by the authorization middleware, with no error code. '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Internal Server Error security: - BearerAuth: [] components: schemas: PaymentDashboardResponse: additionalProperties: false properties: byStatus: additionalProperties: $ref: '#/components/schemas/PaymentTypeCountAmount' type: object byType: additionalProperties: $ref: '#/components/schemas/PaymentTypeCountAmount' type: object totalAmount: type: string totalApproved: format: int64 type: integer totalCanceled: format: int64 type: integer totalCreated: format: int64 type: integer totalExecuted: format: int64 type: integer totalFailed: format: int64 type: integer totalPendingApproval: format: int64 type: integer totalRejected: format: int64 type: integer totalScheduled: description: >- Payments in the SCHEDULED state. This API version never creates one: payment scheduling is out of scope and no payment endpoint accepts a scheduling date, so a non-zero value can only be a scheduled payment reported by the provider — never one you requested. The same rows are also counted under byStatus.SCHEDULED. format: int64 type: integer totalSettled: format: int64 type: integer totalSettledAmount: type: string required: - totalCreated - totalScheduled - totalSettled - totalFailed - totalRejected - totalCanceled - totalPendingApproval - totalApproved - totalExecuted - totalAmount - totalSettledAmount - byType - byStatus type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object PipelineError: additionalProperties: false description: >- The flat error body. A failure caught before the API layer sees the request answers this shape on the application/json media type, instead of the RFC 9457 problem document. Read the media type to tell the two apart. The idempotency check is the rule that answers this way most often. properties: code: description: >- Stable, machine-readable error code, in the form PBP-NNNN. Branch on this value. It carries the same meaning as the code member of the problem document. examples: - PBP-0013 type: string details: additionalProperties: true description: Optional object carrying further facts about this occurrence. type: - object - 'null' message: description: A human-readable explanation specific to this occurrence. examples: - >- The request body does not match the original request for this idempotency key. type: string title: description: Short label for the condition. examples: - Idempotency Key Conflict type: string required: - code - title - message type: object PaymentTypeCountAmount: additionalProperties: false properties: amount: type: string count: format: int64 type: integer required: - count - amount type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````