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

# Consultar liquidación

> Retorna el detalle completo de una liquidación: totales y, en `items`, el desglose por cobro con tarjeta (pagador, DTEs pagados, comisión y neto).

## ¿Para qué se usa?

Retorna el detalle completo de una liquidación: totales + desglose por cobro con tarjeta (`items`).

## Qué hace

* Devuelve los mismos campos que el endpoint de listado, más el desglose de la comisión (`commission_base_total` + `commission_iva_total`).
* En `items` incluye un registro por cobro con tarjeta dentro de la liquidación. Para cada uno: pagador, lista de DTEs que ese cobro pagó (con su folio y monto), bruto, comisión y neto.

## Estructura de un item

Cada item representa **un cobro con tarjeta** (no un DTE). Si el cobro pagó varios DTEs, todos aparecen en `documents`. Si el item no pudo ser asociado a un cobro (caso muy raro, normalmente conciliaciones manuales), `payer.name` y `documents` vendrán vacíos pero los montos están igual.

## Consideraciones importantes

### `items` inline (no paginado)

Los items vienen inline en la respuesta. Una liquidación típica tiene entre 1 y unas decenas de items.

### Para obtener el PDF del DTE

`documents[].document_id` corresponde al ID del DTE en la **API de Facturación**. Para obtener PDF/XML usa [Obtener Documento](/api-reference/documents/get).

### Scope por API Key

La API Key debe pertenecer a un usuario con acceso a la master entity indicada en la URL. Si no, el endpoint responde `403`. Si la liquidación existe pero pertenece a otra master entity, responde `404`.


## OpenAPI

````yaml api-reference/openapi-payment-requests.json GET /master-entities/{master_entity_id}/settlements/{settlement_id}/
openapi: 3.0.0
info:
  title: Tupana API - Recaudación
  description: >-
    API de Cobros — Crea sesiones de pago, procesa cobros y emite DTE
    automáticamente.
  version: 1.0.0
servers:
  - url: https://api.tupana.ai/v1
    description: Servidor de producción
security:
  - apiKeyAuth: []
paths:
  /master-entities/{master_entity_id}/settlements/{settlement_id}/:
    get:
      tags:
        - Liquidaciones
      summary: Consultar detalle de una liquidación
      description: >-
        Retorna el detalle completo de una liquidación: totales y, en `items`,
        el desglose por cobro con tarjeta (pagador, DTEs pagados, comisión y
        neto).
      operationId: getSettlement
      parameters:
        - name: master_entity_id
          in: path
          required: true
          description: ID del destinatario (MasterEntity).
          schema:
            type: integer
        - name: settlement_id
          in: path
          required: true
          description: ID de la liquidación.
          schema:
            type: integer
      responses:
        '200':
          description: Detalle de la liquidación con items inline
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementDetailResponse'
              example:
                settlement_id: 1042
                period_date: '2026-04-30'
                status: paid
                gross_total: '150000.00'
                commission_base_total: '3000.00'
                commission_iva_total: '570.00'
                commission_total: '3570.00'
                net_total: '146430.00'
                paid_at: '2026-05-02T15:00:00+00:00'
                items:
                  - id: 9871
                    date: '2026-04-29'
                    payer:
                      name: Juan Soto
                    documents:
                      - dte_type: '33'
                        folio: '1234'
                        amount: '50000'
                        receiver_rut: 11.111.111-1
                        receiver_name: Juan Soto
                        document_id: 5523
                    gross_amount: '50000.00'
                    commission_base: '1000.00'
                    commission_iva: '190.00'
                    commission_total: '1190.00'
                    net_amount: '48810.00'
        '401':
          description: API key inválida o no proporcionada
        '403':
          description: La API key no pertenece a un usuario con acceso a este destinatario
        '404':
          description: Liquidación no encontrada o no pertenece al destinatario
      security:
        - apiKeyAuth: []
components:
  schemas:
    SettlementDetailResponse:
      type: object
      properties:
        settlement_id:
          type: integer
          example: 1042
        period_date:
          type: string
          format: date
          nullable: true
          example: '2026-04-30'
        status:
          type: string
          enum:
            - pending
            - paid
            - failed
          example: paid
        gross_total:
          type: string
          example: '150000.00'
        commission_base_total:
          type: string
          description: >-
            Comisión sin IVA (2%% del bruto, redondeo hacia abajo sin decimales
            por item).
          example: '3000.00'
        commission_iva_total:
          type: string
          description: IVA (19%%) sobre la comisión base.
          example: '570.00'
        commission_total:
          type: string
          description: Comisión total (`commission_base_total + commission_iva_total`).
          example: '3570.00'
        net_total:
          type: string
          example: '146430.00'
        paid_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-05-02T15:00:00+00:00'
        items:
          type: array
          items:
            $ref: '#/components/schemas/SettlementItem'
    SettlementItem:
      type: object
      properties:
        id:
          type: integer
          example: 9871
        date:
          type: string
          format: date
          nullable: true
          description: Fecha del cobro con tarjeta.
          example: '2026-04-29'
        payer:
          type: object
          properties:
            name:
              type: string
              example: Juan Soto
        documents:
          type: array
          items:
            $ref: '#/components/schemas/SettlementItemDocument'
        gross_amount:
          type: string
          example: '50000.00'
        commission_base:
          type: string
          example: '1000.00'
        commission_iva:
          type: string
          example: '190.00'
        commission_total:
          type: string
          example: '1190.00'
        net_amount:
          type: string
          example: '48810.00'
    SettlementItemDocument:
      type: object
      description: DTE pagado por el cobro de este item.
      properties:
        dte_type:
          type: string
          example: '33'
        folio:
          type: string
          example: '1234'
        amount:
          type: string
          example: '50000'
        receiver_rut:
          type: string
          example: 11.111.111-1
        receiver_name:
          type: string
          example: Juan Soto
        document_id:
          type: integer
          nullable: true
          description: ID del DTE en la API de Facturación.
          example: 5523
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'API Key para autenticación. Formato: `Api-Key YOUR-API-KEY`'

````