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

# List funder submissions with their current decision and offers

> One row per funder submission on the deal, newest first, each carrying the funder, outbound status, send eligibility, send attempts, the current (non-superseded) decision, and the full decision history with each decision's offers. The envelope also identifies the requested record's broker link, records linked to it, and submitting broker identities evaluated for funder exclusions. Broker customers only; responds 404 for others.




## OpenAPI

````yaml https://app.herondata.io/swagger get /api/broker/end_users/{end_user_heron_id}/funder_submissions/
openapi: 3.0.0
info:
  contact:
    email: support@herondata.io
    name: Support
  title: Heron Data API
  version: '2021-07-19'
servers:
  - description: Production
    url: https://app.herondata.io
security:
  - ApiKeyAuth:
      - key_XXX
externalDocs:
  description: Read Tutorial
  url: https://docs.herondata.io/
paths:
  /api/broker/end_users/{end_user_heron_id}/funder_submissions/:
    get:
      summary: List funder submissions with their current decision and offers
      description: >
        One row per funder submission on the deal, newest first, each carrying
        the funder, outbound status, send eligibility, send attempts, the
        current (non-superseded) decision, and the full decision history with
        each decision's offers. The envelope also identifies the requested
        record's broker link, records linked to it, and submitting broker
        identities evaluated for funder exclusions. Broker customers only;
        responds 404 for others.
      parameters:
        - description: The Heron ID of the end user
          in: path
          name: end_user_heron_id
          required: true
          schema:
            type: string
        - description: Page number
          in: query
          name: page
          required: false
          schema:
            default: 1
            minimum: 1
            type: integer
        - description: Page size, default 25, max 50
          in: query
          name: limit
          required: false
          schema:
            default: 25
            maximum: 50
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrokerLifecyclePage'
          description: One page of funder submissions
        '404':
          description: End user not found or not a broker customer
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BrokerLifecyclePage:
      additionalProperties: false
      properties:
        broker_link_status:
          enum:
            - unlinked
            - linked
            - dismissed
            - reclassified
            - null
          nullable: true
          readOnly: true
        classification:
          enum:
            - submission
            - decision
            - other
            - null
          nullable: true
          readOnly: true
        has_more:
          readOnly: true
          type: boolean
        items:
          items:
            $ref: '#/components/schemas/BrokerLifecycleFunderSubmission'
          readOnly: true
          type: array
        limit:
          readOnly: true
          type: integer
        linked_deal_end_user_heron_id:
          nullable: true
          readOnly: true
          type: string
        linked_deal_name:
          nullable: true
          readOnly: true
          type: string
        linked_records:
          items:
            $ref: '#/components/schemas/BrokerLinkedRecord'
          readOnly: true
          type: array
        page:
          readOnly: true
          type: integer
        submitting_brokers:
          items:
            $ref: '#/components/schemas/SubmittingBroker'
          nullable: true
          readOnly: true
          type: array
      type: object
    BrokerLifecycleFunderSubmission:
      additionalProperties: false
      properties:
        attempts:
          items:
            $ref: '#/components/schemas/FunderSubmissionAttempt'
          readOnly: true
          type: array
        configured_channel:
          enum:
            - email
            - api
            - web_portal
            - all_offers
            - crm_lendsaas
            - null
          nullable: true
          readOnly: true
        created:
          format: date-time
          readOnly: true
          type: string
        current_decision:
          allOf:
            - $ref: '#/components/schemas/FunderSubmissionDecision'
          nullable: true
          readOnly: true
        decisions:
          items:
            $ref: '#/components/schemas/FunderSubmissionDecision'
          readOnly: true
          type: array
        funder:
          allOf:
            - $ref: '#/components/schemas/Funder1'
          readOnly: true
        heron_id:
          readOnly: true
          type: string
        send_eligibility:
          allOf:
            - $ref: '#/components/schemas/SendEligibility'
          readOnly: true
        should_send:
          nullable: true
          readOnly: true
          type: boolean
        status:
          enum:
            - pending
            - in_progress
            - submitted_to_funder
            - invalid_data_for_funder
            - submission_failed
            - approved
            - declined
            - null
          nullable: true
          readOnly: true
        submission_configured:
          nullable: true
          readOnly: true
          type: boolean
        submission_status_message:
          nullable: true
          readOnly: true
          type: string
        submitted_at:
          format: date-time
          nullable: true
          readOnly: true
          type: string
      type: object
    BrokerLinkedRecord:
      additionalProperties: false
      properties:
        classification:
          enum:
            - submission
            - decision
            - other
          readOnly: true
        created:
          format: date-time
          readOnly: true
          type: string
        heron_id:
          readOnly: true
          type: string
        link_type:
          enum:
            - absorbed_submission_duplicate
            - linked_decision
          readOnly: true
        name:
          nullable: true
          readOnly: true
          type: string
      type: object
    SubmittingBroker:
      additionalProperties: false
      properties:
        company:
          nullable: true
          readOnly: true
          type: string
        domain:
          nullable: true
          readOnly: true
          type: string
        email:
          nullable: true
          readOnly: true
          type: string
      type: object
    FunderSubmissionAttempt:
      additionalProperties: false
      properties:
        channel:
          enum:
            - email
            - api
            - web_portal
            - all_offers
            - crm_lendsaas
          readOnly: true
        completed_at:
          format: date-time
          nullable: true
          readOnly: true
          type: string
        created:
          format: date-time
          readOnly: true
          type: string
        heron_id:
          readOnly: true
          type: string
        is_production:
          readOnly: true
          type: boolean
        status:
          enum:
            - in_progress
            - succeeded
            - failed
            - action_required
            - unknown
          readOnly: true
      type: object
    FunderSubmissionDecision:
      additionalProperties: false
      properties:
        application_identifier:
          nullable: true
          readOnly: true
          type: string
        application_status:
          nullable: true
          readOnly: true
          type: string
        attribution_method:
          readOnly: true
          type: string
        decline_reason:
          nullable: true
          readOnly: true
          type: string
        email_classification:
          enum:
            - general-chatter
            - request-for-information
            - initial-decision
            - term-negotiation
            - amendment
            - null
          nullable: true
          readOnly: true
        email_decision_stage:
          enum:
            - initial-decision
            - amendment
            - pre-decision
            - post-decision
            - null
          nullable: true
          readOnly: true
        has_competing_offers:
          nullable: true
          readOnly: true
          type: boolean
        heron_id:
          readOnly: true
          type: string
        lender_notes:
          nullable: true
          readOnly: true
          type: string
        offer_link_url:
          nullable: true
          readOnly: true
          type: string
        offers:
          items:
            $ref: '#/components/schemas/FunderSubmissionOffer'
          readOnly: true
          type: array
        provider_effective_at:
          format: date-time
          nullable: true
          readOnly: true
          type: string
        raw_application_status:
          nullable: true
          readOnly: true
          type: string
        requested_info:
          nullable: true
          readOnly: true
          type: string
        source_email_end_user_heron_id:
          nullable: true
          readOnly: true
          type: string
        source_email_heron_id:
          nullable: true
          readOnly: true
          type: string
        source_received_at:
          format: date-time
          readOnly: true
          type: string
        status_reasoning:
          nullable: true
          readOnly: true
          type: string
        stipulations:
          nullable: true
          readOnly: true
          type: string
        superseded_at:
          format: date-time
          nullable: true
          readOnly: true
          type: string
      type: object
    Funder1:
      additionalProperties: false
      properties:
        heron_id:
          readOnly: true
          type: string
        name:
          readOnly: true
          type: string
      type: object
    SendEligibility:
      additionalProperties: false
      properties:
        detail:
          nullable: true
          readOnly: true
          type: string
        evidence:
          items:
            $ref: '#/components/schemas/FunderExclusionEvidence'
          nullable: true
          readOnly: true
          type: array
        reason:
          enum:
            - excluded
            - held
            - unconfigured
            - in_progress
            - ambiguous_attempt
            - sent
            - decided
            - null
          nullable: true
          readOnly: true
        sendable:
          readOnly: true
          type: boolean
      type: object
    FunderSubmissionOffer:
      additionalProperties: false
      properties:
        apr:
          nullable: true
          readOnly: true
          type: number
        biweekly_payment:
          nullable: true
          readOnly: true
          type: number
        buy_rate:
          nullable: true
          readOnly: true
          type: number
        commission_amount:
          nullable: true
          readOnly: true
          type: number
        commission_percent:
          nullable: true
          readOnly: true
          type: number
        computed:
          allOf:
            - $ref: '#/components/schemas/FunderSubmissionOfferComputed'
          readOnly: true
        daily_payment:
          nullable: true
          readOnly: true
          type: number
        draw_fee_amount:
          nullable: true
          readOnly: true
          type: number
        draw_fee_percentage:
          nullable: true
          readOnly: true
          type: number
        factor_rate:
          nullable: true
          readOnly: true
          type: number
        funded_amount:
          nullable: true
          readOnly: true
          type: number
        funding_position:
          nullable: true
          readOnly: true
          type: integer
        heron_id:
          readOnly: true
          type: string
        holdback_percentage:
          nullable: true
          readOnly: true
          type: number
        interest_rate:
          nullable: true
          readOnly: true
          type: number
        monthly_payment:
          nullable: true
          readOnly: true
          type: number
        ordinal:
          readOnly: true
          type: integer
        origination_fee_amount:
          nullable: true
          readOnly: true
          type: number
        origination_fee_percentage:
          nullable: true
          readOnly: true
          type: number
        payback_amount:
          nullable: true
          readOnly: true
          type: number
        payment_frequency:
          nullable: true
          readOnly: true
          type: string
        raw_product_text:
          nullable: true
          readOnly: true
          type: string
        source:
          enum:
            - email
            - api
            - web_portal
            - all_offers
            - crm_lendsaas
            - null
          nullable: true
          readOnly: true
        stipulations:
          nullable: true
          readOnly: true
          type: string
        term_days:
          nullable: true
          readOnly: true
          type: number
        term_months:
          nullable: true
          readOnly: true
          type: number
        term_number_of_payments:
          nullable: true
          readOnly: true
          type: number
        term_weeks:
          nullable: true
          readOnly: true
          type: number
        weekly_payment:
          nullable: true
          readOnly: true
          type: number
      type: object
    FunderExclusionEvidence:
      properties:
        configured_value:
          readOnly: true
          type: string
        funder_heron_id:
          readOnly: true
          type: string
        match_type:
          enum:
            - domain
            - email
            - name
          readOnly: true
        observed_value:
          readOnly: true
          type: string
        similarity:
          nullable: true
          readOnly: true
          type: number
        status:
          enum:
            - excluded
            - held
          readOnly: true
      type: object
    FunderSubmissionOfferComputed:
      additionalProperties: false
      properties:
        biweekly_payment:
          nullable: true
          readOnly: true
          type: number
        buy_rate:
          nullable: true
          readOnly: true
          type: number
        commission_amount:
          nullable: true
          readOnly: true
          type: number
        commission_percent:
          nullable: true
          readOnly: true
          type: number
        daily_payment:
          nullable: true
          readOnly: true
          type: number
        factor_rate:
          nullable: true
          readOnly: true
          type: number
        monthly_payment:
          nullable: true
          readOnly: true
          type: number
        origination_fee_amount:
          nullable: true
          readOnly: true
          type: number
        origination_fee_percentage:
          nullable: true
          readOnly: true
          type: number
        payback_amount:
          nullable: true
          readOnly: true
          type: number
        payment_frequency:
          readOnly: true
          type: string
        term_days:
          nullable: true
          readOnly: true
          type: number
        term_months:
          nullable: true
          readOnly: true
          type: number
        term_number_of_payments:
          nullable: true
          readOnly: true
          type: number
        term_weeks:
          nullable: true
          readOnly: true
          type: number
        weekly_payment:
          nullable: true
          readOnly: true
          type: number
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey

````