openapi: 3.2.0
info:
  description: User API to be consumed by the clients that are not companies and that are connecting their individual accounts
  title: User Endpoints API
  contact: {}
  version: '05'
servers:
- url: https://api.getrollee.com/api/v0.5
tags:
- name: Endpoints
paths:
  /accounts/{id}/activity:
    get:
      description: Get activity information of an account. Available for gig economy platforms only.
      tags:
      - Endpoints
      summary: Get activity
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ActivityInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdActivity
      x-operation-id-source: derived
  /accounts/{id}/assets:
    get:
      description: Get assets information of an account. Available for gig economy and tax.
      tags:
      - Endpoints
      summary: Get assets
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.AssetsInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdAssets
      x-operation-id-source: derived
  /accounts/{id}/banking_info:
    get:
      description: Get bank information of an account. Available for gig economy and tax.
      tags:
      - Endpoints
      summary: Get bank informations
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.BankInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdBankingInfo
      x-operation-id-source: derived
  /accounts/{id}/bonuses:
    get:
      description: Get bonuses information of an account
      tags:
      - Endpoints
      summary: Get bonuses
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.BonusesInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdBonuses
      x-operation-id-source: derived
  /accounts/{id}/documents:
    get:
      description: Get documents information of an account
      tags:
      - Endpoints
      summary: Get documents
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/std_models.DocumentClientOutput'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdDocuments
      x-operation-id-source: derived
  /accounts/{id}/employment:
    get:
      description: Get employment information of an account. Available for gig economy and tax.
      tags:
      - Endpoints
      summary: Get employment
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.EmploymentInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdEmployment
      x-operation-id-source: derived
  /accounts/{id}/income:
    get:
      description: Get income information of an account. Available for gig economy and tax.
      tags:
      - Endpoints
      summary: Get income
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.IncomeInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdIncome
      x-operation-id-source: derived
  /accounts/{id}/orders:
    get:
      description: Get orders information of an account
      tags:
      - Endpoints
      summary: Get orders
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.OrdersInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdOrders
      x-operation-id-source: derived
  /accounts/{id}/performance:
    get:
      description: Get performance information of an account. Available for gig economy platforms only.
      tags:
      - Endpoints
      summary: Get performance
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.PerformanceInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdPerformance
      x-operation-id-source: derived
  /accounts/{id}/profile:
    get:
      description: Get profile information of an account. Available for gig economy and tax.
      tags:
      - Endpoints
      summary: Get profile
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ProfileInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdProfile
      x-operation-id-source: derived
  /accounts/{id}/purchase_intent:
    get:
      description: Get purchase_intent information of an account
      tags:
      - Endpoints
      summary: Get purchase_intent
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.PurchaseIntentInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdPurchaseIntent
      x-operation-id-source: derived
  /accounts/{id}/taxes:
    get:
      description: Get taxes information of an account
      tags:
      - Endpoints
      summary: Get taxes
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: filter by tax_period_start_date, returning taxes whose period starts on or after this time (unix timestamp or YYYY-MM-DD). The default value is 90 days ago (36 months for Revolut accounts).
        name: start_date
        in: query
        schema:
          type: number
      - description: filter by tax_period_start_date, returning taxes whose period starts on or before this time (unix timestamp or YYYY-MM-DD). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.TaxesInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdTaxes
      x-operation-id-source: derived
  /accounts/{id}/transactions:
    get:
      description: Get transactions of an account
      tags:
      - Endpoints
      summary: Get transactions
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.TransactionInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdTransactions
      x-operation-id-source: derived
  /accounts/{id}/trips:
    get:
      description: Get trips information of an account. Available for gig economy platforms only.
      tags:
      - Endpoints
      summary: Get trips
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.TripsInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdTrips
      x-operation-id-source: derived
  /accounts/{id}/vehicles:
    get:
      description: Get vehicles information of an account. Available for gig economy platforms only.
      tags:
      - Endpoints
      summary: Get vehicles
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.VehicleInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdVehicles
      x-operation-id-source: derived
  /accounts/{id}/wallet:
    get:
      description: Get wallet information of an account
      tags:
      - Endpoints
      summary: Get wallet
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: account id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago.
        name: start_date
        in: query
        schema:
          type: number
      - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day.
        name: end_date
        in: query
        schema:
          type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.WalletInformation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getAccountsByIdWallet
      x-operation-id-source: derived
components:
  schemas:
    std_models.Time20060102150405:
      type: object
      properties:
        inner:
          type: string
    std_models.DocumentClientOutput:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/models.Metadata'
        document_date:
          type: string
        expire_date:
          type: string
        id:
          type: string
        issued_date:
          type: string
        link:
          type: string
        name:
          type: string
        number:
          type: string
        retrieved_date:
          type: string
        type:
          type: string
    std_models.Transaction:
      type: object
      properties:
        account_number:
          type: string
        currency:
          type: string
        gross_amount:
          type: number
        recipient:
          type: string
        recipient_currency:
          type: string
        status:
          type: string
        transaction_date:
          $ref: '#/components/schemas/std_models.Time20060102'
        transaction_detail:
          type: string
        transaction_id:
          type: string
        transaction_type:
          type: string
        withdrawal_method_id:
          type: string
    models.VehicleInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Vehicle'
        size:
          type: integer
        user_id:
          type: string
    models.ActivityInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Activity'
        size:
          type: integer
        user_id:
          type: string
    std_models.Vehicle:
      type: object
      properties:
        color:
          type: string
        license_plate:
          type: string
        make:
          type: string
        model:
          type: string
        status:
          type: string
        vehicle_type:
          type: string
        vin:
          type: string
        year:
          type: integer
    models.ProfileInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Profile'
        size:
          type: integer
        user_id:
          type: string
    models.PerformanceInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Performance'
        size:
          type: integer
        user_id:
          type: string
    std_models.PeriodType:
      type: string
      enum:
      - daily
      - weekly
      - monthly
      - yearly
      - custom
      x-enum-varnames:
      - Daily
      - Weekly
      - Monthly
      - Yearly
      - Custom
    std_models.Performance:
      type: object
      properties:
        acceptance_rate:
          type: number
        cancellation_rate:
          type: number
        completition_rate:
          type: number
        driver_rating:
          type: number
        driver_score:
          type: number
        online_hours:
          type: number
        price_per_driving_hour:
          type: number
        price_per_online_hour:
          type: number
        time_period_end_date:
          description: of format "YYYY-MM-DD" not null
          allOf:
          - $ref: '#/components/schemas/std_models.Time20060102'
        time_period_start_date:
          description: of format "YYYY-MM-DD" not null
          allOf:
          - $ref: '#/components/schemas/std_models.Time20060102'
        time_period_type:
          description: ', on of [daily, weekly, monthly, yearly, custom] not null'
          allOf:
          - $ref: '#/components/schemas/std_models.PeriodType'
    models.AssetsInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Assets'
        size:
          type: integer
        user_id:
          type: string
    std_models.TripDuration:
      type: object
      properties:
        hours:
          type: integer
        inner:
          type: integer
        minutes:
          type: integer
        seconds:
          type: integer
    models.Metadata:
      type: object
      additionalProperties: {}
    std_models.Employment:
      type: object
      properties:
        contract_type:
          type: string
        currency:
          type: string
        duration_days:
          type: integer
        employment_type:
          type: string
        end_date:
          description: of format YYYY-MM-DD
          type: string
        income:
          type: number
        income_description:
          type: string
        organization_address:
          type: string
        organization_fiscal_id:
          type: string
        organization_name:
          type: string
        organization_sector:
          type: string
        retrieved_date:
          type: string
        start_date:
          description: 'of format "YYYY-MM-DD" # !TODO ?'
          type: string
        status:
          type: string
        title:
          type: string
        worker_id:
          type: string
    models.OrdersInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Order'
        size:
          type: integer
        user_id:
          type: string
    models.BonusesInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Bonus'
        size:
          type: integer
        user_id:
          type: string
    std_models.PurchaseIntent:
      type: object
      properties:
        currency:
          type: string
        items:
          type: array
          items: {}
        purchase_intent_id:
          type: string
        retrieved_at:
          $ref: '#/components/schemas/std_models.Time20060102'
        subtotal:
          type: number
        type:
          type: string
    std_models.Assets:
      type: object
      properties:
        address:
          type: string
        city:
          type: string
        occupation:
          type: string
        ownership_structure:
          type: string
        primary_asset_area:
          type: number
        primary_asset_area_measure:
          type: string
        primary_asset_category:
          type: number
        primary_asset_rooms:
          type: number
        primary_asset_subtype:
          type: string
        primary_asset_type:
          type: string
        primary_asset_uuid:
          type: string
        property_rights:
          type: string
        secondary_asset_area:
          type: number
        secondary_asset_category:
          type: number
        secondary_asset_type:
          type: string
    models.IncomeInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Income'
        size:
          type: integer
        user_id:
          type: string
    std_models.Bonus:
      type: object
      properties:
        bonus_created_at:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        bonus_id:
          type: string
        bonus_name:
          type: string
        city:
          type: string
        details:
          $ref: '#/components/schemas/std_models.JSON'
        end_date:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        start_date:
          $ref: '#/components/schemas/std_models.Time20060102150405'
    models.EmploymentInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Employment'
        size:
          type: integer
        user_id:
          type: string
    std_models.JSON:
      type: object
      additionalProperties: {}
    std_models.Activity:
      type: object
      properties:
        acceptance_rate:
          type: number
        afternoon_trips_total:
          type: number
        afternoon_trips_total_perc:
          type: number
        cancellation_rate:
          type: number
        currency:
          type: string
        distance_per_trip:
          type: number
        distance_total:
          type: number
        hours_most_active:
          type: string
        morning_trips_total:
          type: number
        morning_trips_total_perc:
          type: number
        night_trips_total:
          type: number
        night_trips_total_perc:
          type: number
        online_duration:
          description: of format "HHMMSS" or "DD days, HHMMSS"
          type: string
        organization_id:
          type: string
        organization_name:
          type: string
        price_per_driving_hour:
          type: number
        price_per_km:
          type: number
        price_per_online_hour:
          description: deprecated
          type: number
        price_per_trip:
          type: number
        price_total:
          type: number
        ranking_average:
          type: number
        ranking_average_global:
          type: number
        time_on_trips:
          type: string
        time_period_end_date:
          $ref: '#/components/schemas/std_models.Time20060102'
        time_period_start_date:
          description: of format "YYYY-MM-DD" not null
          allOf:
          - $ref: '#/components/schemas/std_models.Time20060102'
        time_period_type:
          description: ', on of [daily, weekly, monthly, yearly, custom] not null'
          allOf:
          - $ref: '#/components/schemas/std_models.PeriodType'
        trips_per_hour:
          type: number
        trips_total:
          type: integer
    std_models.Tax:
      type: object
      properties:
        currency:
          type: string
        employment_income:
          type: number
        income_tax:
          type: number
        national_insurance:
          type: number
        other_income:
          type: number
        personal_allowance:
          type: number
        self_employed_income:
          type: number
        tax_period_end_date:
          $ref: '#/components/schemas/std_models.Time20060102'
        tax_period_start_date:
          $ref: '#/components/schemas/std_models.Time20060102'
        tax_year:
          type: string
        total_tax_and_nic:
          type: number
        total_tax_and_nic_due_or_overpaid:
          type: number
        total_tax_free_amount:
          type: number
        total_taxable_income:
          type: number
    dyndpoint.DynamicDataPointResult:
      type: object
      properties:
        error:
          type: string
        name:
          type: string
        result:
          type: string
    stdinsert.Trips:
      type: object
      properties:
        isSuccess:
          type: boolean
        items:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Trip'
        statusContext:
          type: string
    models.BankInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.BankAccount'
        size:
          type: integer
        user_id:
          type: string
    std_models.Profile:
      type: object
      properties:
        birth_country:
          type: string
        birth_place:
          type: string
        birth_postal_code:
          type: string
        city:
          type: string
        country:
          type: string
        country_phone_code:
          type: string
        date_of_birth:
          type: string
        driver_rating:
          type: number
        email:
          type: string
        first_name:
          type: string
        fiscal_id:
          type: string
        full_name:
          type: string
        gender:
          type: string
        last_name:
          type: string
        licence_expire_dt:
          type: string
        licence_number:
          type: string
        marital_status:
          type: string
        married_name:
          type: string
        nationality:
          type: string
        number_of_dependents:
          type: integer
        personal_public_service_number:
          type: string
        phone:
          type: string
        social_security_number:
          type: string
        state:
          type: string
        street:
          type: string
        subscription_date:
          type: string
        url:
          type: string
        zip:
          type: string
    models.PurchaseIntentInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.PurchaseIntent'
        size:
          type: integer
        user_id:
          type: string
    std_models.Wallet:
      type: object
      properties:
        balance:
          type: number
        currency:
          type: string
        retrieved_ts:
          description: of format "YYYY-MM-DD HH:MM:SS"
          allOf:
          - $ref: '#/components/schemas/std_models.Time20060102150405'
        retrieved_tz:
          type: string
    models.TransactionInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Transaction'
        size:
          type: integer
        user_id:
          type: string
    std_models.Income:
      type: object
      properties:
        advertisement_bonus:
          type: number
        airport_surcharge:
          type: number
        bonus_amount:
          type: number
        bonus_amount_details:
          $ref: '#/components/schemas/std_models.JSON'
        cancellation_fee:
          type: number
        card_earnings:
          type: number
        cash_earnings:
          type: number
        contribution_base:
          type: number
        contribution_days:
          type: number
        currency:
          type: string
        dynamic_data_points:
          type: array
          items:
            $ref: '#/components/schemas/dyndpoint.DynamicDataPointResult'
        earnings_guarantee:
          type: number
        earnings_info:
          type: string
        electric_mobility_fee:
          type: number
        employer_fiscal_id:
          type: string
        employment_classification:
          type: string
        employment_subtype:
          type: string
        employment_type:
          type: string
        expenses:
          type: number
        fare:
          type: number
        french_gross_earnings:
          type: number
        gross_earnings:
          type: number
        gross_fare:
          type: number
        income_tax_basis:
          type: string
        income_tax_paid:
          type: number
        kept_by_uber:
          type: number
        material_fee:
          type: number
        net_amount:
          type: number
        net_amount_after_vat:
          type: number
        net_fare:
          type: number
        net_income_details:
          $ref: '#/components/schemas/std_models.JSON'
        ni_paid:
          type: number
        organization_id:
          type: string
        organization_name:
          type: string
        other_amount:
          type: number
        other_fees:
          type: number
        pay_frequency:
          type: string
        payouts:
          type: number
        platform_fee:
          type: number
        reimbursements:
          type: number
        rider_fare:
          type: number
        social_net_amount:
          type: number
        tax_rate:
          type: number
        tax_year:
          type: number
        taxes:
          type: number
        time_period_start_date:
          description: of format "YYYY-MM-DD"
          allOf:
          - $ref: '#/components/schemas/std_models.Time20060102'
        time_period_type:
          description: ', one of [daily, weekly, monthly, yearly, custom]'
          allOf:
          - $ref: '#/components/schemas/std_models.PeriodType'
        tips:
          type: number
        tolls:
          type: number
        usc_status:
          type: string
        variable_amount:
          type: number
        waiting_time_fee:
          type: number
    std_models.Time20060102:
      type: object
      properties:
        inner:
          type: string
    std_models.Trip:
      type: object
      properties:
        airport_surcharge:
          type: number
        bonus:
          type: number
        cash_collected:
          type: number
        currency:
          type: string
        distance:
          type: number
        distance_measure:
          type: string
        driver_total_earnings_per_trip_distance:
          type: number
        driver_total_earnings_per_trip_minute:
          type: number
        duration:
          description: of format "HH:MM:SS"
          allOf:
          - $ref: '#/components/schemas/std_models.TripDuration'
        end_location:
          type: string
        fare:
          type: number
        fare_without_vat:
          type: number
        fees:
          type: number
        gross_fare:
          type: number
        kept_by_uber:
          type: number
        list_of_order_ids:
          type: array
          items:
            type: string
        migration_trip_id:
          type: string
        net_fare:
          type: number
        number_of_orders:
          type: integer
        organization_id:
          type: string
        organization_name:
          type: string
        other:
          type: number
        payment_type:
          type: string
        pickup_location_name:
          type: string
        recipient_address:
          type: string
        recipient_is_company:
          type: boolean
        recipient_name:
          type: string
        recipient_reg_code:
          type: string
        recipient_vat_code:
          type: string
        refunded_fees:
          type: number
        ride_duration:
          $ref: '#/components/schemas/std_models.TripDuration'
        ride_type:
          type: string
        rider_fare:
          type: number
        rider_promotions:
          type: number
        start_location:
          type: string
        stop_fare:
          type: number
        surge_fare:
          type: number
        taxes:
          type: number
        timezone:
          type: string
        tips:
          type: number
        tolls:
          type: number
        trip_begin_ts:
          description: of format "YYYY-MM-DD HH:MM:SS"
          allOf:
          - $ref: '#/components/schemas/std_models.Time20060102150405'
        trip_end_ts:
          description: of format "YYYY-MM-DD HH:MM:SS"
          allOf:
          - $ref: '#/components/schemas/std_models.Time20060102150405'
        trip_id:
          type: string
        trip_status:
          type: string
        trip_ts:
          description: of format "YYYY-MM-DD HH:MM:SS"
          allOf:
          - $ref: '#/components/schemas/std_models.Time20060102150405'
        trip_ts_local:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        trip_type:
          type: string
        tz:
          type: string
    models.TaxesInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Tax'
        size:
          type: integer
        user_id:
          type: string
    std_models.BankAccount:
      type: object
      properties:
        account_number:
          type: string
        account_type:
          type: string
        iban:
          type: string
        recipient:
          type: string
        swift:
          type: string
    std_models.Order:
      type: object
      properties:
        coupon:
          type: number
        courier_rating_review:
          type: number
        currency:
          type: string
        delivery_accept_time_ts_local:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        delivery_address:
          type: string
        delivery_arrive_ts_local:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        delivery_collect_time_ts_local:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        delivery_fee:
          type: number
        delivery_latitude:
          type: number
        delivery_longitude:
          type: number
        items:
          type: array
          items: {}
        order_completed_ts:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        order_completed_ts_local:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        order_created_ts:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        order_created_ts_local:
          $ref: '#/components/schemas/std_models.Time20060102150405'
        order_id:
          type: string
        order_status:
          type: string
        payment_amount:
          type: number
        payment_brand:
          type: string
        payment_method_name:
          type: string
        payment_method_type:
          type: string
        service_fee:
          type: number
        store_address:
          type: string
        store_city:
          type: string
        store_country:
          type: string
        store_id:
          type: string
        store_latitude:
          type: number
        store_longitude:
          type: number
        store_name:
          type: string
        store_rating_review:
          type: number
        store_type:
          type: string
        subtotal:
          type: number
        total:
          type: number
    models.WalletInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/std_models.Wallet'
        size:
          type: integer
        user_id:
          type: string
    models.ServerError:
      type: object
      properties:
        error:
          type: string
    models.TripsInformation:
      type: object
      properties:
        account_id:
          type: string
        connected:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/stdinsert.Trips'
        size:
          type: integer
        user_id:
          type: string
x-provenance:
  method: searched
  source: https://developers.getrollee.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.getrollee.com/reference/delete_accounts-id-1.md
  - https://developers.getrollee.com/reference/delete_users-id-1.md
  - https://developers.getrollee.com/reference/delete_webhooks-type-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-activity-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-assets-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-banking-info-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-bonuses-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-documents-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-employment-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-income-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-orders.md
  - https://developers.getrollee.com/reference/get_accounts-id-performance-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-profile-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-purchase-intent.md
  - https://developers.getrollee.com/reference/get_accounts-id-taxes.md
  - https://developers.getrollee.com/reference/get_accounts-id-transactions-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-trips-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-vehicles-1.md
  - https://developers.getrollee.com/reference/get_accounts-id-wallet-1.md
  - https://developers.getrollee.com/reference/get_data-settings-1.md
  - https://developers.getrollee.com/reference/get_data-sources-1.md
  - https://developers.getrollee.com/reference/get_token-refresh-2.md
  - https://developers.getrollee.com/reference/get_users-1.md
  - https://developers.getrollee.com/reference/get_users-id-2.md
  - https://developers.getrollee.com/reference/get_users-id-accounts-1.md
  - https://developers.getrollee.com/reference/get_users-id-performance-index-1.md
  - https://developers.getrollee.com/reference/get_webhooks-2.md
  - https://developers.getrollee.com/reference/get_webhooks-v2-1.md
  - https://developers.getrollee.com/reference/post_accounts-id-approve-device.md
  - https://developers.getrollee.com/reference/post_accounts-id-disconnect-1.md
  - https://developers.getrollee.com/reference/post_accounts-id-reconnect-1.md
  - https://developers.getrollee.com/reference/post_sessions-session-refresh-2.md
  - https://developers.getrollee.com/reference/post_users-1.md
  - https://developers.getrollee.com/reference/post_users-id-sessions-new-1.md
  - https://developers.getrollee.com/reference/put_users-id-2.md
  - https://developers.getrollee.com/reference/put_webhooks-accounts-1.md
  - https://developers.getrollee.com/reference/put_webhooks-endpoints-1.md
  - https://developers.getrollee.com/reference/put_webhooks-multi-endpoints-1.md
  - https://developers.getrollee.com/reference/put_webhooks-rollee-connect-events-1.md
  - https://developers.getrollee.com/reference/put_webhooks-users-1.md
  merge:
    pages: 41
    deduped: 84
    conflicts_kept_first: 0