Lean Technologies Expenses API

The Expenses API from Lean Technologies — 1 operation(s) for expenses.

OpenAPI Specification

lean-technologies-expenses-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Consents Account On File Account Controls (New) Account Controls (New) Expenses API
  version: v0.2.3
servers:
- url: https://sandbox.leantech.me
  description: Sandbox
- url: https://api2.leantech.me
  description: Production
security:
- bearerAuth: []
tags:
- name: Expenses
  x-displayName: Expenses
paths:
  /insights/v2/expenses:
    servers: []
    get:
      operationId: getExpenses
      summary: Get Expenses
      description: Provides insights on the expenses (outflows) from a bank account.
      parameters:
      - name: entity_id
        in: query
        description: The `entity_id` you're querying for.
        required: true
        schema:
          type: string
          format: uuid
      - name: async
        in: query
        description: 'When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it''''s recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.'
        required: false
        schema:
          type: boolean
          default: true
        deprecated: true
      - name: start_date
        in: query
        description: The start date in UTC (in the format YYYY-MM-DD) you want to query expenses for.
        required: false
        schema:
          type: string
          format: date
        x-field-extra-annotation: '@jakarta.validation.constraints.PastOrPresent'
      - name: expense_type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ExpenseType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    insights:
                      $ref: '#/components/schemas/Expenses'
                    type:
                      $ref: '#/components/schemas/InsightsResultType'
                  type: object
              examples:
                Get_Expenses_UAE_2:
                  summary: Successful get expenses insights - UAE
                  value:
                    status: OK
                    results_id: d982e1fd-aaf0-41fe-9f11-a4f67f4dc918
                    message: Data successfully retrieved
                    timestamp: '2026-01-08T12:07:48Z'
                    type: expenses
                    insights:
                      currency: AED
                      total:
                        count: 142
                        amount: 45650.75
                        first_date_time: '2025-07-01T08:15:00Z'
                        last_date_time: '2025-12-28T19:45:00Z'
                        average_monthly_count: 23.67
                        average_monthly_amount: 7608.46
                        minimum_monthly_amount:
                          month: 8
                          year: 2025
                          amount: 6850.25
                        maximum_monthly_amount:
                          month: 11
                          year: 2025
                          amount: 8950.5
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: GROCERIES
                            count: 38
                            amount: 12450
                            fraction_of_total_expenses: 0.2727
                          - category: RENT_AND_SERVICES
                            count: 6
                            amount: 12000
                            fraction_of_total_expenses: 0.2629
                          - category: TRANSPORT
                            count: 24
                            amount: 4850.75
                            fraction_of_total_expenses: 0.1063
                          - category: RESTAURANTS_DINING
                            count: 18
                            amount: 4250
                            fraction_of_total_expenses: 0.0931
                          - category: RETAIL
                            count: 22
                            amount: 3800
                            fraction_of_total_expenses: 0.0833
                          - category: HEALTH_AND_WELLBEING
                            count: 8
                            amount: 2500
                            fraction_of_total_expenses: 0.0548
                          - category: EDUCATION
                            count: 4
                            amount: 2000
                            fraction_of_total_expenses: 0.0438
                          - category: ENTERTAINMENT
                            count: 12
                            amount: 1800
                            fraction_of_total_expenses: 0.0394
                          - category: BANK_FEES_AND_CHARGES
                            count: 6
                            amount: 450
                            fraction_of_total_expenses: 0.0099
                          - category: CHARITY
                            count: 2
                            amount: 500
                            fraction_of_total_expenses: 0.011
                          - category: OTHER
                            count: 2
                            amount: 250
                            fraction_of_total_expenses: 0.0055
                      monthly_totals:
                      - month: 7
                        year: 2025
                        amount: 7200
                        count: 20
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: GROCERIES
                            count: 6
                            amount: 2100
                            fraction_of_total_expenses: 0.2917
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 2000
                            fraction_of_total_expenses: 0.2778
                          - category: TRANSPORT
                            count: 4
                            amount: 850
                            fraction_of_total_expenses: 0.1181
                          - category: RESTAURANTS_DINING
                            count: 3
                            amount: 750
                            fraction_of_total_expenses: 0.1042
                          - category: RETAIL
                            count: 4
                            amount: 650
                            fraction_of_total_expenses: 0.0903
                          - category: HEALTH_AND_WELLBEING
                            count: 1
                            amount: 400
                            fraction_of_total_expenses: 0.0556
                          - category: ENTERTAINMENT
                            count: 1
                            amount: 650
                            fraction_of_total_expenses: 0.0903
                      - month: 8
                        year: 2025
                        amount: 6850.25
                        count: 18
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: GROCERIES
                            count: 5
                            amount: 1950
                            fraction_of_total_expenses: 0.2845
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 2000
                            fraction_of_total_expenses: 0.2918
                          - category: TRANSPORT
                            count: 3
                            amount: 750.25
                            fraction_of_total_expenses: 0.1095
                          - category: RESTAURANTS_DINING
                            count: 3
                            amount: 650
                            fraction_of_total_expenses: 0.0949
                          - category: RETAIL
                            count: 3
                            amount: 600
                            fraction_of_total_expenses: 0.0876
                          - category: HEALTH_AND_WELLBEING
                            count: 1
                            amount: 400
                            fraction_of_total_expenses: 0.0584
                          - category: ENTERTAINMENT
                            count: 2
                            amount: 500
                            fraction_of_total_expenses: 0.073
                      - month: 9
                        year: 2025
                        amount: 7850.5
                        count: 25
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: GROCERIES
                            count: 7
                            amount: 2200
                            fraction_of_total_expenses: 0.2803
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 2000
                            fraction_of_total_expenses: 0.2548
                          - category: TRANSPORT
                            count: 5
                            amount: 950.5
                            fraction_of_total_expenses: 0.1211
                          - category: RESTAURANTS_DINING
                            count: 4
                            amount: 900
                            fraction_of_total_expenses: 0.1146
                          - category: RETAIL
                            count: 4
                            amount: 700
                            fraction_of_total_expenses: 0.0892
                          - category: HEALTH_AND_WELLBEING
                            count: 2
                            amount: 500
                            fraction_of_total_expenses: 0.0637
                          - category: EDUCATION
                            count: 1
                            amount: 500
                            fraction_of_total_expenses: 0.0637
                          - category: ENTERTAINMENT
                            count: 1
                            amount: 100
                            fraction_of_total_expenses: 0.0127
                      - month: 10
                        year: 2025
                        amount: 8200
                        count: 26
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: GROCERIES
                            count: 7
                            amount: 2300
                            fraction_of_total_expenses: 0.2805
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 2000
                            fraction_of_total_expenses: 0.2439
                          - category: TRANSPORT
                            count: 5
                            amount: 1000
                            fraction_of_total_expenses: 0.122
                          - category: RESTAURANTS_DINING
                            count: 4
                            amount: 950
                            fraction_of_total_expenses: 0.1159
                          - category: RETAIL
                            count: 5
                            amount: 850
                            fraction_of_total_expenses: 0.1037
                          - category: HEALTH_AND_WELLBEING
                            count: 2
                            amount: 500
                            fraction_of_total_expenses: 0.061
                          - category: EDUCATION
                            count: 1
                            amount: 500
                            fraction_of_total_expenses: 0.061
                          - category: ENTERTAINMENT
                            count: 1
                            amount: 150
                            fraction_of_total_expenses: 0.0183
                      - month: 11
                        year: 2025
                        amount: 8950.5
                        count: 28
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: GROCERIES
                            count: 7
                            amount: 2400
                            fraction_of_total_expenses: 0.2682
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 2000
                            fraction_of_total_expenses: 0.2235
                          - category: TRANSPORT
                            count: 4
                            amount: 850.5
                            fraction_of_total_expenses: 0.095
                          - category: RESTAURANTS_DINING
                            count: 2
                            amount: 600
                            fraction_of_total_expenses: 0.067
                          - category: RETAIL
                            count: 4
                            amount: 800
                            fraction_of_total_expenses: 0.0894
                          - category: HEALTH_AND_WELLBEING
                            count: 1
                            amount: 400
                            fraction_of_total_expenses: 0.0447
                          - category: EDUCATION
                            count: 1
                            amount: 500
                            fraction_of_total_expenses: 0.0559
                          - category: ENTERTAINMENT
                            count: 4
                            amount: 800
                            fraction_of_total_expenses: 0.0894
                          - category: CHARITY
                            count: 1
                            amount: 300
                            fraction_of_total_expenses: 0.0335
                          - category: BANK_FEES_AND_CHARGES
                            count: 3
                            amount: 200
                            fraction_of_total_expenses: 0.0223
                      - month: 12
                        year: 2025
                        amount: 8500
                        count: 25
                        is_month_complete: false
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: GROCERIES
                            count: 6
                            amount: 1800
                            fraction_of_total_expenses: 0.2118
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 2000
                            fraction_of_total_expenses: 0.2353
                          - category: TRANSPORT
                            count: 3
                            amount: 450
                            fraction_of_total_expenses: 0.0529
                          - category: RESTAURANTS_DINING
                            count: 2
                            amount: 400
                            fraction_of_total_expenses: 0.0471
                          - category: RETAIL
                            count: 2
                            amount: 200
                            fraction_of_total_expenses: 0.0235
                          - category: HEALTH_AND_WELLBEING
                            count: 1
                            amount: 300
                            fraction_of_total_expenses: 0.0353
                          - category: EDUCATION
                            count: 1
                            amount: 500
                            fraction_of_total_expenses: 0.0588
                          - category: ENTERTAINMENT
                            count: 3
                            amount: 500
                            fraction_of_total_expenses: 0.0588
                          - category: CHARITY
                            count: 1
                            amount: 200
                            fraction_of_total_expenses: 0.0235
                          - category: BANK_FEES_AND_CHARGES
                            count: 3
                            amount: 150
                            fraction_of_total_expenses: 0.0176
                          - category: OTHER
                            count: 2
                            amount: 250
                            fraction_of_total_expenses: 0.0294
                Get_Expenses_UAE:
                  summary: Successful get expenses insights - UAE
                  value:
                    status: OK
                    results_id: d982e1fd-aaf0-41fe-9f11-a4f67f4dc918
                    message: Data successfully retrieved
                    timestamp: '2026-01-08T12:07:48Z'
                    type: expenses
                    insights:
                      currency: AED
                      total:
                        count: 168
                        amount: 67850.25
                        first_date_time: '2025-07-01T09:00:00Z'
                        last_date_time: '2025-12-29T20:30:00Z'
                        average_monthly_count: 28
                        average_monthly_amount: 11308.38
                        minimum_monthly_amount:
                          month: 8
                          year: 2025
                          amount: 9850
                        maximum_monthly_amount:
                          month: 11
                          year: 2025
                          amount: 12850.75
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: RENT_AND_SERVICES
                            count: 6
                            amount: 18000
                            fraction_of_total_expenses: 0.2653
                          - category: GROCERIES
                            count: 42
                            amount: 15200
                            fraction_of_total_expenses: 0.2241
                          - category: TRANSPORT
                            count: 28
                            amount: 7200.25
                            fraction_of_total_expenses: 0.1061
                          - category: RESTAURANTS_DINING
                            count: 24
                            amount: 6800
                            fraction_of_total_expenses: 0.1002
                          - category: RETAIL
                            count: 26
                            amount: 6200
                            fraction_of_total_expenses: 0.0914
                          - category: HEALTH_AND_WELLBEING
                            count: 10
                            amount: 3800
                            fraction_of_total_expenses: 0.056
                          - category: ENTERTAINMENT
                            count: 16
                            amount: 3200
                            fraction_of_total_expenses: 0.0472
                          - category: EDUCATION
                            count: 6
                            amount: 3000
                            fraction_of_total_expenses: 0.0442
                          - category: TRAVEL
                            count: 4
                            amount: 2500
                            fraction_of_total_expenses: 0.0369
                          - category: BANK_FEES_AND_CHARGES
                            count: 4
                            amount: 750
                            fraction_of_total_expenses: 0.0111
                          - category: OTHER
                            count: 2
                            amount: 200
                            fraction_of_total_expenses: 0.0029
                      monthly_totals:
                      - month: 7
                        year: 2025
                        amount: 10500
                        count: 24
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 3000
                            fraction_of_total_expenses: 0.2857
                          - category: GROCERIES
                            count: 7
                            amount: 2500
                            fraction_of_total_expenses: 0.2381
                          - category: TRANSPORT
                            count: 4
                            amount: 1200
                            fraction_of_total_expenses: 0.1143
                          - category: RESTAURANTS_DINING
                            count: 4
                            amount: 1100
                            fraction_of_total_expenses: 0.1048
                          - category: RETAIL
                            count: 4
                            amount: 900
                            fraction_of_total_expenses: 0.0857
                          - category: HEALTH_AND_WELLBEING
                            count: 2
                            amount: 600
                            fraction_of_total_expenses: 0.0571
                          - category: ENTERTAINMENT
                            count: 2
                            amount: 200
                            fraction_of_total_expenses: 0.019
                      - month: 8
                        year: 2025
                        amount: 9850
                        count: 22
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 3000
                            fraction_of_total_expenses: 0.3046
                          - category: GROCERIES
                            count: 6
                            amount: 2200
                            fraction_of_total_expenses: 0.2234
                          - category: TRANSPORT
                            count: 3
                            amount: 950
                            fraction_of_total_expenses: 0.0964
                          - category: RESTAURANTS_DINING
                            count: 3
                            amount: 900
                            fraction_of_total_expenses: 0.0914
                          - category: RETAIL
                            count: 4
                            amount: 800
                            fraction_of_total_expenses: 0.0812
                          - category: HEALTH_AND_WELLBEING
                            count: 2
                            amount: 500
                            fraction_of_total_expenses: 0.0508
                          - category: ENTERTAINMENT
                            count: 2
                            amount: 300
                            fraction_of_total_expenses: 0.0305
                          - category: BANK_FEES_AND_CHARGES
                            count: 1
                            amount: 200
                            fraction_of_total_expenses: 0.0203
                      - month: 9
                        year: 2025
                        amount: 11200
                        count: 28
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 3000
                            fraction_of_total_expenses: 0.2679
                          - category: GROCERIES
                            count: 7
                            amount: 2600
                            fraction_of_total_expenses: 0.2321
                          - category: TRANSPORT
                            count: 5
                            amount: 1250
                            fraction_of_total_expenses: 0.1116
                          - category: RESTAURANTS_DINING
                            count: 4
                            amount: 1200
                            fraction_of_total_expenses: 0.1071
                          - category: RETAIL
                            count: 5
                            amount: 1100
                            fraction_of_total_expenses: 0.0982
                          - category: HEALTH_AND_WELLBEING
                            count: 2
                            amount: 650
                            fraction_of_total_expenses: 0.058
                          - category: ENTERTAINMENT
                            count: 2
                            amount: 400
                            fraction_of_total_expenses: 0.0357
                          - category: EDUCATION
                            count: 1
                            amount: 500
                            fraction_of_total_expenses: 0.0446
                          - category: TRAVEL
                            count: 1
                            amount: 500
                            fraction_of_total_expenses: 0.0446
                      - month: 10
                        year: 2025
                        amount: 11500.5
                        count: 30
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 3000
                            fraction_of_total_expenses: 0.2609
                          - category: GROCERIES
                            count: 8
                            amount: 2700
                            fraction_of_total_expenses: 0.2348
                          - category: TRANSPORT
                            count: 5
                            amount: 1300.5
                            fraction_of_total_expenses: 0.1131
                          - category: RESTAURANTS_DINING
                            count: 5
                            amount: 1300
                            fraction_of_total_expenses: 0.113
                          - category: RETAIL
                            count: 5
                            amount: 1200
                            fraction_of_total_expenses: 0.1043
                          - category: HEALTH_AND_WELLBEING
                            count: 2
                            amount: 700
                            fraction_of_total_expenses: 0.0609
                          - category: ENTERTAINMENT
                            count: 3
                            amount: 600
                            fraction_of_total_expenses: 0.0522
                          - category: EDUCATION
                            count: 1
                            amount: 500
                            fraction_of_total_expenses: 0.0435
                          - category: TRAVEL
                            count: 1
                            amount: 200
                            fraction_of_total_expenses: 0.0174
                      - month: 11
                        year: 2025
                        amount: 12850.75
                        count: 32
                        is_month_complete: true
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 3000
                            fraction_of_total_expenses: 0.2335
                          - category: GROCERIES
                            count: 7
                            amount: 2800
                            fraction_of_total_expenses: 0.2179
                          - category: TRANSPORT
                            count: 5
                            amount: 1400.75
                            fraction_of_total_expenses: 0.109
                          - category: RESTAURANTS_DINING
                            count: 4
                            amount: 1200
                            fraction_of_total_expenses: 0.0934
                          - category: RETAIL
                            count: 4
                            amount: 1100
                            fraction_of_total_expenses: 0.0856
                          - category: HEALTH_AND_WELLBEING
                            count: 1
                            amount: 500
                            fraction_of_total_expenses: 0.0389
                          - category: ENTERTAINMENT
                            count: 4
                            amount: 1000
                            fraction_of_total_expenses: 0.0778
                          - category: EDUCATION
                            count: 2
                            amount: 1000
                            fraction_of_total_expenses: 0.0778
                          - category: TRAVEL
                            count: 2
                            amount: 1500
                            fraction_of_total_expenses: 0.1167
                          - category: BANK_FEES_AND_CHARGES
                            count: 1
                            amount: 150
                            fraction_of_total_expenses: 0.0117
                      - month: 12
                        year: 2025
                        amount: 11950
                        count: 32
                        is_month_complete: false
                        breakdown:
                        - by: category
                          breakdowns:
                          - category: RENT_AND_SERVICES
                            count: 1
                            amount: 3000
                            fraction_of_total_expenses: 0.251
                          - category: GROCERIES
                            count: 7
                            amount: 2400
                            fraction_of_total_expenses: 0.2008
                          - category: TRANSPORT
                            count: 6
                            amount: 1100
                            fraction_of_total_expenses: 0.0921
                          - category: RESTAURANTS_DINING
                            count: 4
                            amount: 1100
                            fraction_of_total_expenses: 0.0921
                          - category: RETAIL
                            count: 4
                            amount: 1100
                            fraction_of_total_expenses: 0.0921
                          - category: HEALTH_AND_WELLBEING
                            count: 1
                            amount: 650
                            fraction_of_total_expenses: 0.0544
                          - category: ENTERTAINMENT
                            count: 3
                            amount: 900
                            fraction_of_total_expenses: 0.0753
                          - category: EDUCATION
                            count: 2
                            amount: 1000
                            fraction_of_total_expenses: 0.0837
                          - category: TRAVEL
                            count: 1
                            amount: 300
                            fraction_of_total_expenses: 0.0251
                          - category: BANK_FEES_AND_CHARGES
                            count: 2
                            amount: 400
                            fraction_of_total_expenses: 0.0335
                          - category: OTHER
                            count: 1
                            amount: 200
                            fraction_of_total_expenses: 0.0167
        '202':
          description: Accepted (Asynchronous request)
          content:
            application/json:
              examples:
                GetIncomeAsyncExample:
                  $ref: '#/componen

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lean-technologies/refs/heads/main/openapi/lean-technologies-expenses-api-openapi.yml