Pular para o conteúdo principal
GET
/
v1
/
packages
Listar Pacotes
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": "Package 1",
      "description": "Package created for testing",
      "transactionRoute": "bde4a930-1ffe-40bf-9e4d-17c28cc9295e",
      "segmentId": "01962516-d221-7340-b481-2e52d0dea76b",
      "ledgerId": "01962515-e02a-7eac-b616-5d0df19c3400",
      "minimumAmount": "3000.00",
      "maximumAmount": "6000.00",
      "waivedAccounts": [
        "@account1"
      ],
      "fees": {
        "fee1": {
          "feeLabel": "Administrative fee 1",
          "calculationModel": {
            "applicationRule": "maxBetweenTypes",
            "calculations": [
              {
                "type": "flat",
                "value": "15"
              },
              {
                "type": "percentage",
                "value": "2"
              }
            ]
          },
          "referenceAmount": "originalAmount",
          "priority": 1,
          "isDeductibleFrom": false,
          "creditAccount": "@fee1",
          "routeFrom": "d35a121f-a638-4d2d-966b-65657a049f12",
          "routeTo": "d35a121f-a638-4d2d-966b-65657a049f12"
        },
        "fee2": {
          "feeLabel": "Administrative fee 2",
          "calculationModel": {
            "applicationRule": "flatFee",
            "calculations": [
              {
                "type": "flat",
                "value": "5"
              }
            ]
          },
          "referenceAmount": "originalAmount",
          "priority": 2,
          "isDeductibleFrom": false,
          "creditAccount": "@fee2",
          "routeFrom": "d35a121f-a638-4d2d-966b-65657a049f12",
          "routeTo": "d35a121f-a638-4d2d-966b-65657a049f12"
        },
        "fee3": {
          "feeLabel": "Fee 3",
          "calculationModel": {
            "applicationRule": "percentual",
            "calculations": [
              {
                "type": "percentage",
                "value": "5"
              }
            ]
          },
          "referenceAmount": "afterFeesAmount",
          "priority": 3,
          "isDeductibleFrom": true,
          "creditAccount": "@fee3",
          "routeFrom": "d35a121f-a638-4d2d-966b-65657a049f12",
          "routeTo": "d35a121f-a638-4d2d-966b-65657a049f12"
        }
      },
      "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": "Package 2",
      "description": "Second package created for testing",
      "transactionRoute": "bde4a930-1ffe-40bf-9e4d-17c28cc9295e",
      "segmentId": "01962516-d221-7340-b481-2e52d0dea76b",
      "ledgerId": "01962515-e02a-7eac-b616-5d0df19c3400",
      "minimumAmount": "3000.00",
      "maximumAmount": "6000.00",
      "waivedAccounts": [],
      "fees": {
        "fee1": {
          "feeLabel": "Administrative fee test 2",
          "calculationModel": {
            "applicationRule": "maxBetweenTypes",
            "calculations": [
              {
                "type": "flat",
                "value": "16"
              },
              {
                "type": "percentage",
                "value": "1"
              }
            ]
          },
          "referenceAmount": "originalAmount",
          "priority": 1,
          "isDeductibleFrom": false,
          "creditAccount": "@fee1",
          "routeFrom": "d35a121f-a638-4d2d-966b-65657a049f12",
          "routeTo": "d35a121f-a638-4d2d-966b-65657a049f12"
        }
      },
      "enable": true,
      "createdAt": "2025-04-11T13:56:02.814Z",
      "updatedAt": "2025-04-11T13:56:02.814Z",
      "deletedAt": null
    }
  ],
  "page": 1,
  "limit": 5,
  "total": 3
}

Cabeçalhos

​
Authorization
string

O token de autorização no formato 'Bearer '. Importante: Este header é obrigatório se o seu ambiente possui o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

Exemplo:

"application/json"

​
X-Organization-Id
string
obrigatório

O identificador único da Organização associada à requisição.

Exemplo:

"0195fb87-eeb6-7487-bc58-659255a23ef1"

Parâmetros de consulta

​
page
integer

Número da página a ser retornada.

​
limit
integer

Número de registros retornados.

​
total
integer

Número de itens retornados.

​
sortOrder
string

A ordem utilizada para classificar os resultados.

​
transactionRoute
string

A rota contábil principal que define a natureza da transação. Ajuda a agrupar operações relacionadas no ledger.

​
enable
boolean

Se true, indica que o pacote está ativo.

​
startDate
string

A data inicial do período que você deseja recuperar. Deve ser usada junto com o end_date.

​
endDate
string

A data final do período que você deseja recuperar. Deve ser usada junto com o start_date.

​
ledgerId
string

Identificador do Ledger.

Exemplo:

"0195156e-a4ce-7774-8c65-f2d1bf268989"

​
segmentId
string

Identificador único do produto ou categoria ao qual as taxas estão vinculadas. Este campo está associado ao Midaz Ledger.

Exemplo:

"0195156e-26e2-708e-aa8f-1ca3266f6347"

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

​
items
object[]

Lista com os itens retornados.

​
page
integer

Número da página retornada.

​
limit
integer

Número de registros retornados.

​
total
integer

Número de itens retornados.