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

# Show creditor detail

> Show a creditor company profile with summary revenue metrics, performance metrics, plan details, eco profile details, and contacts.



## OpenAPI

````yaml /api/superadmin.openapi.yaml get /manage-creditors/{company}
openapi: 3.1.0
info:
  title: YouNegotiate Superadmin API
  version: '2.0'
  description: Stateless API endpoints for the Superadmin portal.
servers:
  - url: https://api.hub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public superadmin domain system and health endpoints.
  - name: Authentication
    description: Superadmin login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated superadmin profile endpoints.
  - name: Admin Configuration
    description: Platform configuration values and feature flag controls.
  - name: MailHub Users
    description: Superadmin management for EcoMail Hub / EcoPortal users.
  - name: Super Admin Users
    description: Superadmin management for platform operations users.
  - name: Consumers
    description: Superadmin consumer account list, detail, filter, and export endpoints.
  - name: Creditors
    description: Superadmin creditor account list and account access endpoints.
  - name: Sub Accounts
    description: Superadmin sub account list and export endpoints.
  - name: Reseller Partners
    description: Superadmin reseller partner list and report-history endpoints.
  - name: Special Plan Inquiries
    description: >-
      Superadmin special membership inquiry list, detail, resolve, and close
      endpoints.
  - name: Plans
    description: >-
      Superadmin membership plan list, create, update, reorder, visibility, and
      delete endpoints.
  - name: Failed - Canceled
    description: Superadmin failed or cancelled membership list and custom email endpoints.
  - name: Merchant Requests
    description: >-
      Superadmin merchant API request list, export, email, forwarding, progress,
      and approval endpoints.
  - name: Bill Pay Donations
    description: Superadmin Bill Pay gift donation list, export, and receipt endpoints.
  - name: Export & Reporting
    description: Superadmin generated report options and CSV download endpoints.
  - name: Communications / Templates
    description: >-
      Superadmin email and SMS template management for manual communications and
      campaigns.
  - name: Communications / Groups
    description: >-
      Superadmin communication group management for dynamic consumer targeting
      and campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Superadmin email and SMS campaign scheduling, immediate send, and delivery
      queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Superadmin campaign tracker snapshots, refresh actions, and consumer
      exports.
  - name: Automated Communications
    description: >-
      Superadmin automated email/SMS templates, trigger configuration, and
      delivery history endpoints.
paths:
  /manage-creditors/{company}:
    get:
      tags:
        - Creditors
      summary: Show creditor detail
      description: >-
        Show a creditor company profile with summary revenue metrics,
        performance metrics, plan details, eco profile details, and contacts.
      operationId: superadminShowCreditor
      parameters:
        - name: company
          in: path
          required: true
          description: Creditor company ID.
          schema:
            type: integer
      responses:
        '200':
          description: Creditor company detail returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperadminCreditorDetailResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - bearerAuth: []
components:
  schemas:
    SuperadminCreditorDetailResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/SuperadminCreditorDetail'
    SuperadminCreditorDetail:
      allOf:
        - $ref: '#/components/schemas/SuperadminCreditorBase'
        - type: object
          required:
            - summary_metrics
            - performance_metrics
            - plan_details
            - eco_profile_details
            - contacts
          properties:
            summary_metrics:
              type: object
              required:
                - member_revenue
                - payment_revenue
                - auto_communication_revenue
                - super_admin_campaign
                - ecoletter_revenue
                - notice_responses
              properties:
                member_revenue:
                  type: object
                  required:
                    - amount
                  properties:
                    amount:
                      type: number
                      format: float
                      example: 150
                payment_revenue:
                  type: object
                  required:
                    - amount
                  properties:
                    amount:
                      type: number
                      format: float
                      example: 200.25
                auto_communication_revenue:
                  $ref: '#/components/schemas/SuperadminCreditorCountAmountMetric'
                super_admin_campaign:
                  $ref: '#/components/schemas/SuperadminCreditorCountAmountMetric'
                ecoletter_revenue:
                  $ref: '#/components/schemas/SuperadminCreditorCountAmountMetric'
                notice_responses:
                  type: object
                  required:
                    - added_count
                    - returned_count
                  properties:
                    added_count:
                      type: integer
                      example: 1
                    returned_count:
                      type: integer
                      example: 1
            performance_metrics:
              type: object
              required:
                - total_accounts
                - settlements_and_plans
                - settlement_payments_to_date
                - plan_payments_to_date
                - active_plans
                - disputes
                - no_pay
              properties:
                total_accounts:
                  $ref: '#/components/schemas/SuperadminCreditorCountAmountMetric'
                settlements_and_plans:
                  type: object
                  required:
                    - settlement_amount
                    - plan_amount
                  properties:
                    settlement_amount:
                      type: number
                      format: float
                      example: 750
                    plan_amount:
                      type: number
                      format: float
                      example: 650
                settlement_payments_to_date:
                  $ref: '#/components/schemas/SuperadminCreditorCountAmountMetric'
                plan_payments_to_date:
                  $ref: '#/components/schemas/SuperadminCreditorCountAmountMetric'
                active_plans:
                  $ref: '#/components/schemas/SuperadminCreditorCountAmountMetric'
                disputes:
                  $ref: '#/components/schemas/SuperadminCreditorCountAmountMetric'
                no_pay:
                  $ref: '#/components/schemas/SuperadminCreditorCountAmountMetric'
            plan_details:
              type: object
              required:
                - membership_type
                - start_date
                - plan_name
                - hosting
                - add_on
                - pay_term
                - pay_method_type
                - months_active
              properties:
                membership_type:
                  type: string
                  example: Partner - Channel Partners
                start_date:
                  type: string
                  example: Jan 15, 2026
                plan_name:
                  type: string
                  example: Growth Plus
                hosting:
                  type: string
                  example: 6/1000
                add_on:
                  type: integer
                  example: 25
                pay_term:
                  type: string
                  example: Monthly
                pay_method_type:
                  type: string
                  example: ACH
                months_active:
                  type: integer
                  example: 6
            eco_profile_details:
              type: object
              required:
                - company_name
                - phone
                - url
                - address_1
                - address_2
                - city
                - state
                - zip
                - tin
                - hours_opened
              properties:
                company_name:
                  type: string
                  example: Summit Ridge Financial LLC
                phone:
                  type: string
                  example: '8186017451'
                url:
                  type: string
                  example: https://summitridgefinancial.com
                address_1:
                  type: string
                  example: 233 South Wacker Drive
                address_2:
                  type: string
                  example: Suite 1400
                city:
                  type: string
                  example: Chicago
                state:
                  type: string
                  example: Illinois
                zip:
                  type: string
                  example: '60606'
                tin:
                  type: string
                  example: '123456789'
                hours_opened:
                  type: string
                  example: Monday to Friday | 02:00pm to 11:00pm
            contacts:
              type: object
              required:
                - parent_user
                - users
              properties:
                parent_user:
                  oneOf:
                    - $ref: '#/components/schemas/SuperadminCreditorContact'
                    - type: 'null'
                users:
                  type: array
                  items:
                    $ref: '#/components/schemas/SuperadminCreditorContact'
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    SuperadminCreditorBase:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_name:
          type: string
          nullable: true
        company_type:
          type: object
          required:
            - value
            - label
          properties:
            value:
              type: string
              nullable: true
              example: debt-buyer
            label:
              type: string
              example: Debt Buyer
        contact:
          type: object
          required:
            - name
            - email
          properties:
            name:
              type: string
              nullable: true
            email:
              type: string
              format: email
              nullable: true
        root_creditor:
          type:
            - object
            - 'null'
          properties:
            id:
              type: integer
            name:
              type: string
              nullable: true
            email:
              type: string
              format: email
              nullable: true
        recipient:
          type: object
          required:
            - name
            - email
          properties:
            name:
              type: string
              nullable: true
            email:
              type: string
              format: email
              nullable: true
        status_badge:
          type: object
          required:
            - value
            - label
            - tooltip
          properties:
            value:
              type: string
              enum:
                - AM
                - PM
                - FP
                - U
                - CN
                - blocked
            label:
              type: string
              example: AM
            tooltip:
              type: string
              nullable: true
              example: Active Member
        membership:
          type: object
          required:
            - plan_name
            - upload_accounts_limit
          properties:
            plan_name:
              type: string
              nullable: true
            upload_accounts_limit:
              type: integer
              nullable: true
        consumer_stats_loaded:
          type: boolean
        consumers_count:
          type: integer
          nullable: true
        total_balance:
          type: number
          format: float
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
        deleted_at:
          type: string
          format: date-time
          nullable: true
    SuperadminCreditorCountAmountMetric:
      type: object
      required:
        - count
        - amount
      properties:
        count:
          type: integer
          example: 2
        amount:
          type: number
          format: float
          example: 9.5
    SuperadminCreditorContact:
      type: object
      required:
        - id
        - name
        - email
      properties:
        id:
          type: integer
        name:
          type: string
          nullable: true
        email:
          type: string
          format: email
          nullable: true
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````