Skip to main content
GET
/
master-entities
/
{master_entity_id}
/
settlements
/
{settlement_id}
Consultar detalle de una liquidación
curl --request GET \
  --url https://api.tupana.ai/v1/master-entities/{master_entity_id}/settlements/{settlement_id}/ \
  --header 'Authorization: <api-key>'
{
  "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"
    }
  ]
}

¿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.

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.

Authorizations

Authorization
string
header
required

API Key para autenticación. Formato: Api-Key YOUR-API-KEY

Path Parameters

master_entity_id
integer
required

ID del destinatario (MasterEntity).

settlement_id
integer
required

ID de la liquidación.

Response

Detalle de la liquidación con items inline

settlement_id
integer
Example:

1042

period_date
string<date> | null
Example:

"2026-04-30"

status
enum<string>
Available options:
pending,
paid,
failed
Example:

"paid"

gross_total
string
Example:

"150000.00"

commission_base_total
string

Comisión sin IVA (2%% del bruto, redondeo hacia abajo sin decimales por item).

Example:

"3000.00"

commission_iva_total
string

IVA (19%%) sobre la comisión base.

Example:

"570.00"

commission_total
string

Comisión total (commission_base_total + commission_iva_total).

Example:

"3570.00"

net_total
string
Example:

"146430.00"

paid_at
string<date-time> | null
Example:

"2026-05-02T15:00:00+00:00"

items
object[]