Leo1

Leo1 Summary for fee module API

The Summary for fee module API from Leo1 — 5 operation(s) for summary for fee module.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.leo1.in/
📖
APIReference
https://docs.leo1.in/api/start-transaction
📖
GettingStarted
https://docs.leo1.in/intro
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/leo1/refs/heads/main/authentication/leo1-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/leo1/refs/heads/main/openapi/leo1-summary-for-fee-module-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/leo1/refs/heads/main/asyncapi/leo1-fees-webhooks.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/leo1/refs/heads/main/errors/leo1-problem-types.yml

OpenAPI Specification

leo1-summary-for-fee-module-api-openapi.yml Raw ↑ 
openapi: 3.0.2
info:
  title: leofees_backend api Summary for fee module API
  version: version
  description: General system endpoints for the API.
tags:
- name: Summary for fee module
paths:
  /api/v1/summary/get_fees_numbers/{branch_ids}:
    get:
      tags:
      - Summary for fee module
      summary: Get Fees Numbers
      description: API to get fee numbers
      operationId: get_fees_numbers_api_v1_summary_get_fees_numbers__branch_ids__get
      parameters:
      - required: true
        schema:
          title: Branch Ids
          type: string
        name: branch_ids
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/summary/get_payment_trends:
    get:
      tags:
      - Summary for fee module
      summary: Get Payment Trends
      description: API to get payment trends for given branches
      operationId: get_payment_trends_api_v1_summary_get_payment_trends_get
      parameters:
      - required: true
        schema:
          title: Branch Ids
          type: string
        name: branch_ids
        in: query
      - required: true
        schema:
          title: Start Time
          type: string
        name: start_time
        in: query
      - required: true
        schema:
          title: End Time
          type: string
        name: end_time
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/summary/get_payment_stats:
    get:
      tags:
      - Summary for fee module
      summary: Get Payment Stats
      description: API to get payment stats based on filters
      operationId: get_payment_stats_api_v1_summary_get_payment_stats_get
      parameters:
      - required: true
        schema:
          title: Branch Ids
          type: string
        name: branch_ids
        in: query
      - required: true
        schema:
          title: Start Time
          type: string
        name: start_time
        in: query
      - required: true
        schema:
          title: End Time
          type: string
        name: end_time
        in: query
      - required: true
        schema:
          title: Label Type
          type: string
        name: label_type
        in: query
      - required: false
        schema:
          title: Payment Methods
          type: string
        name: payment_methods
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/summary/get_fee_summary:
    get:
      tags:
      - Summary for fee module
      summary: Get Institutes Fee Summary
      description: API to get payment stats based on filters
      operationId: get_institutes_fee_summary_api_v1_summary_get_fee_summary_get
      parameters:
      - required: true
        schema:
          title: Institute Ids
          type: string
        name: institute_ids
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/summary/download_payment_data:
    get:
      tags:
      - Summary for fee module
      summary: Download Payment Data
      description: API to download payment data
      operationId: download_payment_data_api_v1_summary_download_payment_data_get
      parameters:
      - required: true
        schema:
          title: Institute Ids
          type: string
        name: institute_ids
        in: query
      - required: true
        schema:
          title: Branch Ids
          type: string
        name: branch_ids
        in: query
      - required: true
        schema:
          title: Start Time
          type: string
        name: start_time
        in: query
      - required: true
        schema:
          title: End Time
          type: string
        name: end_time
        in: query
      - required: false
        schema:
          title: Payment Methods
          type: string
        name: payment_methods
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
components:
  schemas:
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: secret-key