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

# Listar dispersiones

> Lista todas las dispersiones abiertas y las selladas que se enviaron en el periodo elegido. `counts` agrupa por rol antes del filtro de rol; los totales de `summary` sí aplican el filtro de rol. Estado, canal, día de pago y paginación acotan `payload`. Requiere `disbursements.view`.



## OpenAPI

````yaml /openapi/application.json get /api/v1/accounts/{account_id}/treasury/payouts
openapi: 3.1.0
info:
  title: API de Yampi
  description: >-
    API de cuenta de Yampi: chats, inventario, negocios, contratos, tesorería y
    Livia. Autenticación con el header `api_access_token`.
  version: 1.2.0
  termsOfService: https://yampi.ai/terms/
  contact:
    email: hola@yampi.ai
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://app.yampi.ai
    description: Producción
security: []
tags:
  - name: Agents
    description: Agent management APIs
  - name: Canned Responses
    description: Pre-defined responses for common queries
  - name: Contacts
    description: Contact management APIs
  - name: Contact Labels
    description: Manage contact labels
  - name: Conversation Assignments
    description: Manage conversation assignments
  - name: Conversation Labels
    description: Manage conversation labels
  - name: Conversations
    description: Conversation management APIs
  - name: Custom Attributes
    description: Custom fields for contacts and conversations
  - name: Custom Filters
    description: Saved filters for conversations
  - name: Inboxes
    description: Communication channels setup
  - name: Integrations
    description: Third-party integrations
  - name: Messages
    description: Message management APIs
  - name: Profile
    description: User profile APIs
  - name: Reports
    description: Analytics and reporting APIs
  - name: Teams
    description: Team management APIs
  - name: Webhooks
    description: Event notification webhooks
  - name: Automation Rule
    description: Workflow automation rules
  - name: Help Center
    description: Knowledge base management
  - name: Account
    description: Current account profile and settings
  - name: Audit Logs
    description: Account audit log
  - name: Properties
    description: Property portfolio APIs
  - name: Companies
    description: Company CRM APIs
  - name: Opportunities
    description: Opportunity CRM APIs
  - name: Opportunity Reminders
    description: Reminders on opportunities
  - name: Contract Templates
    description: Contract template library
  - name: Contract Submissions
    description: Contract sending and tracking
  - name: Contract Imports
    description: Import signed contracts into the account
  - name: Livia
    description: Asistentes de Livia
  - name: Livia Tareas
    description: Tareas one-shot de Livia
  - name: SLA Policies
    description: SLA policy management
  - name: Applied SLAs
    description: SLA instances applied to conversations
  - name: SAML Settings
    description: Account SAML SSO settings
  - name: Treasury Subscriptions
    description: Recurring treasury subscriptions
  - name: Treasury Rent Readjustments
    description: Proposed rent raises reviewed before the tenant is notified
  - name: Treasury Payments
    description: Treasury payment recording
  - name: Treasury Adjustments
    description: Debit and credit adjustments
  - name: Treasury Adjustment Concepts
    description: Catálogo de conceptos de la agencia para cargos y descuentos.
  - name: Treasury Rules
    description: Notification, retry, collection and tax rules
  - name: Treasury Dashboard
    description: Treasury dashboard
  - name: Treasury Settings
    description: Treasury account settings
  - name: Treasury Owners
    description: Owner statements
  - name: Treasury Reports
    description: Aging and commission reports
  - name: Livia Documentos
    description: Documentos de conocimiento de Livia
  - name: Livia Escenarios
    description: Escenarios de un asistente de Livia
  - name: Livia Herramientas
    description: Herramientas HTTP de Livia
  - name: Livia Desk
    description: Hilos y mensajes de Livia Desk
  - name: Client Qualifications
    description: >-
      Criterios con los que un asistente califica a un cliente a partir de una
      conversación, y las bandas en las que cae.
  - name: Livia Preferencias
    description: Preferencias de Livia a nivel de cuenta
  - name: Documents
    description: Account document library
  - name: Document Folders
    description: Document library folders
  - name: Calendar Events
    description: Account calendar, availability and booking links
  - name: Agent Tasks
    description: Agent task inbox and lifecycle
  - name: Labels
    description: Account labels
  - name: Notifications
    description: User notifications and notification settings
  - name: Search
    description: Account search and AI search
  - name: Macros
    description: Conversation macros
  - name: Campaigns
    description: Outbound campaigns
  - name: Flow Definitions
    description: Livia flow builder
  - name: Custom Roles
    description: Custom agent roles
  - name: Assignment Policies
    description: Conversation assignment policies
  - name: Requirements
    description: Capture requirements
  - name: Zones
    description: Location zones and cities
  - name: Geocoding
    description: Authenticated geocoding
  - name: Domains
    description: Account custom domains
  - name: Connector Clients
    description: MCP connector client identifiers
  - name: Presigned Contracts
    description: Already-signed contracts uploaded to the account
  - name: Contract Webhooks
    description: Outbound contract webhook URLs
  - name: Contracts Settings
    description: Account contracts settings
  - name: Treasury Collections
    description: Collection steps, notices, agreements and exceptions
  - name: Treasury Guarantees
    description: Rental guarantees and claims
  - name: Treasury E-Invoices
    description: Electronic invoicing
  - name: Treasury Available Contracts
    description: Completed contracts that can seed subscriptions
  - name: Opportunity Pipelines
    description: CRM funnels
  - name: Opportunity Columns
    description: CRM kanban columns
  - name: Opportunity Lose Reasons
    description: CRM lose reasons
  - name: Requirement Quotes
    description: Priced quotes on capture requirements
  - name: Conversation Participants
    description: Agents participating in a conversation
  - name: Conversation Draft Messages
    description: Per-conversation composer drafts
  - name: MCP
    description: Account-scoped MCP JSON-RPC server
  - name: Treasury Bank Batches
    description: Bank payout files and beneficiary account confirmation
  - name: Treasury Bank Statements
    description: Imported bank statements and matching of their lines
  - name: Treasury Third Parties
    description: >-
      Propietarios, administraciones, proveedores y aliados a los que la agencia
      les paga o les cobra.
  - name: Treasury Payouts
    description: What each recipient receives, by date and channel
  - name: Contract Drafts
    description: Contracts being written before they are sent
  - name: Contract Reviews
    description: Review rounds, versions and comments on a contract
  - name: Contact Assignment Requests
    description: Requests to be assigned a contact
  - name: Onboarding
    description: Account onboarding details
  - name: Owner Portal Invites
    description: Owner portal invite, eligibility and revoke
  - name: Channel Authorizations
    description: Start OAuth or embedded signup for inbox channels
  - name: CSAT Survey Responses
    description: Account CSAT responses, metrics and review notes
  - name: Dashboard
    description: Account dashboard summary and trends
  - name: Dashboard Apps
    description: Embedded dashboard apps
  - name: Bulk Actions
    description: Bulk conversation and contact actions
  - name: Assignable Agents
    description: Agents assignable across a set of inboxes
  - name: Tracking Pixels
    description: Advertising tracking pixels
  - name: Calls
    description: Account call history
  - name: WhatsApp Calls
    description: WhatsApp voice calls
  - name: WhatsApp Groups
    description: WhatsApp Cloud group management on an inbox
paths:
  /api/v1/accounts/{account_id}/treasury/payouts:
    parameters:
      - $ref: '#/components/parameters/account_id'
    get:
      tags:
        - Treasury Payouts
      summary: Listar dispersiones
      description: >-
        Lista todas las dispersiones abiertas y las selladas que se enviaron en
        el periodo elegido. `counts` agrupa por rol antes del filtro de rol; los
        totales de `summary` sí aplican el filtro de rol. Estado, canal, día de
        pago y paginación acotan `payload`. Requiere `disbursements.view`.
      operationId: listTreasuryPayouts
      parameters:
        - in: query
          name: role
          schema:
            type: string
            enum:
              - owner
              - ph_admin
              - vendor
              - ally
        - in: query
          name: status
          schema:
            type: string
            enum:
              - awaiting_approval
              - awaiting_resolution
              - approved
              - sent
              - confirmed
              - rejected
              - returned
        - in: query
          name: channel
          schema:
            type: string
        - in: query
          name: month
          schema:
            type: string
          description: >-
            Mes de las dispersiones selladas, como YYYY-MM. Por defecto, el mes
            actual en la zona horaria de facturación de la cuenta.
        - in: query
          name: from
          schema:
            type: string
            format: date
          description: >-
            Inicio del periodo (incluido) para las dispersiones selladas;
            reemplaza el primer día del mes.
        - in: query
          name: to
          schema:
            type: string
            format: date
          description: >-
            Fin del periodo (incluido) para las dispersiones selladas; reemplaza
            el último día del mes.
        - in: query
          name: q
          schema:
            type: string
          description: >-
            Busca por ID de la dispersión, referencia externa, nombre del
            destinatario o razón social de la empresa.
        - in: query
          name: payout_day
          schema:
            type: integer
          description: Solo propietarios cuyo mandato les paga ese día del mes.
        - in: query
          name: sort
          schema:
            type: string
            enum:
              - amount
              - status
              - date
          description: >-
            Campo de orden. Sin él, primero van las dispersiones abiertas y
            luego por fecha programada e ID.
        - in: query
          name: order
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            default: 1
        - in: query
          name: per_page
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: Dispersiones con conteos, totales por estado y paginación.
          content:
            application/json:
              schema:
                type: object
                required:
                  - counts
                  - summary
                  - meta
                  - payload
                properties:
                  counts:
                    type: object
                    description: >-
                      Cantidad de dispersiones en total (`all`) y por rol:
                      `owner`, `ph_admin`, `vendor` y `ally`.
                    additionalProperties:
                      type: integer
                  summary:
                    type: object
                    properties:
                      next_date:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: >-
                          Fecha programada más cercana entre las dispersiones
                          aprobadas y las que esperan aprobación.
                    additionalProperties:
                      type: object
                      description: Totales por estado de la dispersión.
                      required:
                        - count
                        - amount
                      properties:
                        count:
                          type: integer
                        amount:
                          type: string
                          description: >-
                            Total decimal de este estado, antes de los filtros
                            de estado, canal, día de pago y paginación.
                  meta:
                    type: object
                    properties:
                      total_count:
                        type: integer
                      current_page:
                        type: integer
                      page:
                        type: integer
                      total_pages:
                        type: integer
                      payout_days:
                        type: array
                        items:
                          type: integer
                  payload:
                    type: array
                    items:
                      $ref: '#/components/schemas/treasury_payout'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          description: La tesorería está desactivada en la cuenta.
        '404':
          $ref: '#/components/responses/not_found'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - userApiKey: []
components:
  parameters:
    account_id:
      in: path
      name: account_id
      schema:
        type: integer
      required: true
      description: The numeric ID of the account
  schemas:
    treasury_payout:
      type: object
      description: >-
        La dispersión de un destinatario: mientras está abierta, con el monto
        vivo del libro; después del envío, con el monto sellado.
      required:
        - id
        - role
        - status
        - channel
        - currency
        - reference
        - recipient_type
        - recipient_id
        - amount
      properties:
        id:
          type: integer
        role:
          type: string
          enum:
            - owner
            - ph_admin
            - vendor
            - ally
        status:
          type: string
          enum:
            - awaiting_approval
            - awaiting_resolution
            - approved
            - sent
            - confirmed
            - rejected
            - returned
        channel:
          type:
            - string
            - 'null'
          description: >-
            Canal de dispersión configurado para el concepto de la dispersión, o
            `manual` cuando se registró pagada a mano.
        scheduled_on:
          type:
            - string
            - 'null'
          format: date
        closed_at:
          type:
            - string
            - 'null'
          format: date-time
        currency:
          type: string
        reference:
          type: string
          description: Referencia estable de la dispersión, con prefijo YMP-G.
        external_reference:
          type:
            - string
            - 'null'
        recipient_type:
          type: string
          enum:
            - Contact
            - Company
        recipient_id:
          type: integer
        recipient_name:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        amount:
          type: string
          description: Monto decimal en la moneda de la dispersión, como texto.
        sent_on:
          type:
            - string
            - 'null'
          format: date
          description: >-
            Fecha de pago declarada en una dispersión manual; si no, la fecha
            local de la cuenta en que se envió.
        hold_reason:
          type:
            - string
            - 'null'
          description: >-
            Motivo por el que una dispersión abierta está retenida; null si no
            hay retención o si ya está sellada.
        disbursed_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Fecha y hora de cierre de una dispersión confirmada; null en los
            demás estados.
        approval:
          type:
            - object
            - 'null'
          properties:
            approved_at:
              type: string
              format: date-time
            approved_amount:
              type: string
              description: Monto decimal que cubre la aprobación.
            approved_by:
              type:
                - object
                - 'null'
              properties:
                id:
                  type: integer
                name:
                  type: string
        came_back_reason:
          type:
            - string
            - 'null'
        scheduled_on_overridden:
          type: boolean
        reschedules:
          type: array
          items:
            type: object
            properties:
              at:
                type: string
                format: date-time
              by_id:
                type:
                  - integer
                  - 'null'
              by_name:
                type:
                  - string
                  - 'null'
              from:
                type:
                  - string
                  - 'null'
                format: date
              to:
                type: string
                format: date
              reason:
                type:
                  - string
                  - 'null'
  responses:
    unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
    not_found:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
    unprocessable_entity:
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        Token de usuario. Envía el valor en el header `api_access_token`. Lo
        obtienes en el perfil (`GET /api/v1/profile`) o al regenerarlo.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.