Saltar al contenido principal
GET
/
v1
/
packages
Listar paquetes
curl --request GET \
  --url https://fees.sandbox.lerian.net/v1/packages \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "items": [
    {
      "id": "0196251d-a93a-7c42-9eef-c9f463470e21",
      "feeGroupLabel": "Paquete 1",
      "description": "Paquete creado para pruebas",
      "transactionRoute": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
      "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f",
      "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
      "minimumAmount": "3000.00",
      "maximumAmount": "6000.00",
      "waivedAccounts": [
        "customer-brl-1"
      ],
      "fees": {
        "fee1": {
          "feeLabel": "Tasa administrativa 1",
          "calculationModel": {
            "applicationRule": "maxBetweenTypes",
            "calculations": [
              {
                "type": "flat",
                "value": "15"
              },
              {
                "type": "percentage",
                "value": "2"
              }
            ]
          },
          "referenceAmount": "originalAmount",
          "priority": 1,
          "isDeductibleFrom": false,
          "creditAccount": "business-brl-1",
          "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252",
          "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed"
        },
        "fee2": {
          "feeLabel": "Tasa administrativa 2",
          "calculationModel": {
            "applicationRule": "flatFee",
            "calculations": [
              {
                "type": "flat",
                "value": "5"
              }
            ]
          },
          "referenceAmount": "originalAmount",
          "priority": 2,
          "isDeductibleFrom": false,
          "creditAccount": "business-brl-2",
          "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252",
          "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed"
        },
        "fee3": {
          "feeLabel": "Tasa 3",
          "calculationModel": {
            "applicationRule": "percentual",
            "calculations": [
              {
                "type": "percentage",
                "value": "5"
              }
            ]
          },
          "referenceAmount": "afterFeesAmount",
          "priority": 3,
          "isDeductibleFrom": true,
          "creditAccount": "business-brl-3",
          "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252",
          "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed"
        }
      },
      "enable": true,
      "createdAt": "2025-04-11T13:50:23.034Z",
      "updatedAt": "2025-04-11T13:50:23.034Z",
      "deletedAt": null
    },
    {
      "id": "01962522-d87e-7120-80bf-c55b770df818",
      "feeGroupLabel": "Paquete 2",
      "description": "Segundo paquete creado para pruebas.",
      "transactionRoute": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
      "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f",
      "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
      "minimumAmount": "3000.00",
      "maximumAmount": "6000.00",
      "waivedAccounts": [],
      "fees": {
        "fee1": {
          "feeLabel": "Prueba de tasas administrativas 2",
          "calculationModel": {
            "applicationRule": "maxBetweenTypes",
            "calculations": [
              {
                "type": "flat",
                "value": "16"
              },
              {
                "type": "percentage",
                "value": "1"
              }
            ]
          },
          "referenceAmount": "originalAmount",
          "priority": 1,
          "isDeductibleFrom": false,
          "creditAccount": "business-brl-1",
          "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252",
          "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed"
        }
      },
      "enable": true,
      "createdAt": "2025-04-11T13:56:02.814Z",
      "updatedAt": "2025-04-11T13:56:02.814Z",
      "deletedAt": null
    }
  ],
  "page": 1,
  "limit": 5,
  "total": 3
}

Encabezados

​
Authorization
string

El token de autorización en formato 'Bearer '.

Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

​
Content-Type
string
requerido

Tipo de medio del recurso. Debe ser application/json.

Ejemplo:

"application/json"

​
X-Organization-Id
string
requerido

Identificador único de la organización asociada a la solicitud.

Ejemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

Parámetros de consulta

​
page
integer

Número de página que se devolverá.

​
limit
integer

Cantidad de registros devueltos.

​
total
integer

Cantidad de elementos devueltos.

​
sortOrder
string

Orden utilizado para clasificar los resultados.

​
transactionRoute
string

La ruta contable principal que define la naturaleza de la transacción. Ayuda a agrupar operaciones relacionadas en el Ledger.

​
enable
boolean

Si true, indica que el paquete está activo.

​
startDate
string

Fecha de finalización del período que deseas recuperar. Debes usar también start_date.

​
endDate
string

Fecha de inicio del período que deseas recuperar. Debes usar también end_date.

​
ledgerId
string

Identificador del Ledger.

Ejemplo:

"019c96a0-0ac0-7de9-9f53-9cf842a2ee5a"

​
segmentId
string

Identificador único del producto o categoría a la que están vinculadas las tarifas. Este campo está asociado al Ledger de Midaz.

Ejemplo:

"019c96a0-0b4e-7079-8be0-ab6bdccf975f"

Respuesta

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

​
items
object[]

Lista con los elementos devueltos.

​
page
integer

Número de página devuelto.

​
limit
integer

Cantidad de registros devueltos.

​
total
integer

Cantidad de elementos devueltos.