> ## Documentation Index
> Fetch the complete documentation index at: https://docs.simplepay.mx/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the reporting home dashboard (payment-operations)



## OpenAPI

````yaml /openapi.json get /v1/reporting/home-dashboard
openapi: 3.1.0
info:
  title: SimplePay API
  version: '2026-06-13'
  description: >-
    Contrato público para integrar SimplePay desde un backend. Incluye
    únicamente operaciones para comercios y administración protegida de
    credenciales.
servers:
  - description: Live
    url: https://api.simplepay.mx
  - description: Sandbox
    url: https://api.test.simplepay.mx
security:
  - SimplePayApiKey: []
tags:
  - name: API keys
  - name: Hosted Checkout
  - name: Payment Links
  - name: Payments
  - name: Refunds
  - name: Webhooks
  - name: Digital Catalog
  - name: Payment Policy
  - name: Reporting
  - name: Workspace
  - name: Customer Hub
  - name: Bookable Payments
  - name: Table Pay
  - name: Physical Checkout
  - name: In-person Payments
  - name: Terminal
  - name: Tap to Pay
  - name: Ticketing
  - name: Admission Control
  - name: Intelligence
externalDocs:
  description: SimplePay developer documentation
  url: https://docs.simplepay.mx
paths:
  /v1/reporting/home-dashboard:
    get:
      tags:
        - Reporting
      summary: Get the reporting home dashboard (payment-operations)
      operationId: getReportingHomeDashboard
      responses:
        '200':
          description: >-
            Home reporting aggregates; platform-transfer credits are visible in
            activity but excluded from sales.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportingHomeDashboardResponse'
components:
  schemas:
    ReportingHomeDashboardResponse:
      type: object
      additionalProperties: true
      required:
        - as_of
        - currency
        - data_status
        - deposits
        - environment
        - income
        - object
        - payout_account
        - sales_by_day
        - source_complete_through
        - summary
        - truncated
      properties:
        as_of:
          type:
            - string
            - 'null'
          format: date-time
        currency:
          type: string
          pattern: ^[a-z]{3}$
        data_status:
          type: string
          enum:
            - ready
            - stale
            - syncing
            - unavailable
        deposits:
          type: object
          additionalProperties: false
          required:
            - pending_total_minor
            - upcoming
          properties:
            pending_total_minor:
              type: integer
              format: int64
              minimum: 0
              maximum: 9007199254740991
            upcoming:
              type: array
              maxItems: 5
              items:
                type: object
                additionalProperties: true
                required:
                  - amount_minor
                  - arrival_date
                  - currency
                  - id
                  - status
        environment:
          type: string
          enum:
            - live
            - sandbox
        income:
          type: object
          additionalProperties: false
          required:
            - ranges
          properties:
            ranges:
              type: object
              additionalProperties: false
              required:
                - seven_days
                - thirty_days
              properties:
                seven_days:
                  $ref: '#/components/schemas/ReportingIncomeRange'
                thirty_days:
                  $ref: '#/components/schemas/ReportingIncomeRange'
        object:
          const: simplepay.v2.reporting.home_dashboard
        payout_account:
          type: object
          additionalProperties: false
          required:
            - attached
            - data_status
            - institution_name
            - last4
            - payout_ready
            - reason
          properties:
            attached:
              type: boolean
            data_status:
              type: string
              enum:
                - ready
                - unavailable
            institution_name:
              type:
                - string
                - 'null'
              maxLength: 120
            last4:
              type:
                - string
                - 'null'
              pattern: ^[0-9]{4}$
            payout_ready:
              type: boolean
            reason:
              type: string
              enum:
                - no_external_account
                - requirements_due
                - ready
                - unavailable
        sales_by_day:
          type: array
          minItems: 7
          maxItems: 7
          items:
            $ref: '#/components/schemas/ReportingIncomePoint'
        source_complete_through:
          type:
            - string
            - 'null'
          format: date-time
        summary:
          type: object
          additionalProperties: false
          required:
            - has_deposit_history
            - has_successful_sales
            - month_deposits_minor
            - month_sales_minor
            - today_sales_minor
            - upcoming_deposit_arrival_date
            - upcoming_deposit_minor
          properties:
            has_deposit_history:
              type: boolean
            has_successful_sales:
              type: boolean
            month_deposits_minor:
              type: integer
              format: int64
            month_sales_minor:
              type: integer
              format: int64
            today_sales_minor:
              type: integer
              format: int64
            upcoming_deposit_arrival_date:
              type:
                - string
                - 'null'
              format: date
            upcoming_deposit_minor:
              type: integer
              format: int64
              minimum: 0
        truncated:
          type: boolean
    ReportingIncomeRange:
      type: object
      additionalProperties: false
      required:
        - average_ticket_minor
        - comparison_percent
        - end_date
        - fees_minor
        - gross_minor
        - net_minor
        - points
        - previous_gross_minor
        - refunds_minor
        - start_date
        - transaction_count
        - window_days
      properties:
        average_ticket_minor:
          type: integer
          format: int64
          minimum: 0
          maximum: 9007199254740991
        comparison_percent:
          type:
            - integer
            - 'null'
          minimum: -9007199254740991
          maximum: 9007199254740991
        end_date:
          type: string
          format: date
        fees_minor:
          type: integer
          format: int64
          minimum: 0
          maximum: 9007199254740991
        gross_minor:
          type: integer
          format: int64
          minimum: 0
          maximum: 9007199254740991
        net_minor:
          type: integer
          format: int64
          minimum: -9007199254740991
          maximum: 9007199254740991
        points:
          type: array
          minItems: 7
          maxItems: 30
          items:
            $ref: '#/components/schemas/ReportingIncomePoint'
        previous_gross_minor:
          type: integer
          format: int64
          minimum: 0
          maximum: 9007199254740991
        refunds_minor:
          type: integer
          format: int64
          minimum: 0
          maximum: 9007199254740991
        start_date:
          type: string
          format: date
        transaction_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        window_days:
          type: integer
          enum:
            - 7
            - 30
    ReportingIncomePoint:
      type: object
      additionalProperties: false
      required:
        - date
        - gross_minor
        - transaction_count
      properties:
        date:
          type: string
          format: date
        gross_minor:
          type: integer
          format: int64
          minimum: 0
          maximum: 9007199254740991
        transaction_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
  securitySchemes:
    SimplePayApiKey:
      type: http
      scheme: bearer

````