Pular para o conteúdo principal
GET
/
v1
/
packages
/
{id}
Recuperar um Pacote
curl --request GET \
  --url https://fees.sandbox.lerian.net/v1/packages/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "id": "ff99e917-a112-4571-99cf-301a9231d826",
  "feeGroupLabel": "Fee Division",
  "description": "Package created for testing",
  "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",
    "customer-brl-2"
  ],
  "fees": {
    "maintenance": {
      "feeLabel": "Administrative Fee",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": "16"
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": false,
      "creditAccount": "business-brl-4",
      "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252",
      "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed"
    },
    "adm": {
      "feeLabel": "Test fee",
      "calculationModel": {
        "applicationRule": "percentage",
        "calculations": [
          {
            "type": "percentage",
            "value": "6"
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": true,
      "creditAccount": "business-brl-3",
      "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252",
      "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed"
    }
  },
  "enable": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

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:

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

Parâmetros de caminho

​
id
string
obrigatório

Identificador único do pacote que você deseja atualizar.

Exemplo:

"019c96a0-10ce-75fc-a273-dc799079a99c"

Resposta

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

​
id
string
obrigatório

Identificador único do pacote, no formato UUIDv7.

​
feeGroupLabel
string
obrigatório

Nome do grupo de taxas, utilizado para identificar o pacote de taxas configurado.

​
ledgerId
string
obrigatório

Identificador único do Ledger ao qual este Pacote de Taxas está vinculado no Midaz Ledger.

​
minimumAmount
string
obrigatório

Valor mínimo da transação abaixo do qual as taxas do pacote não se aplicam.

​
maximumAmount
string
obrigatório

Valor máximo da transação acima do qual as taxas do pacote não se aplicam.

​
fees
object
obrigatório

Objeto contendo regras de taxas com nomes personalizados. Cada chave é definida pelo cliente (ex., admFee, iof) e seu valor deve seguir o schema do objeto Fee.

​
enable
boolean
obrigatório

Se true, indica que o pacote está ativo.

​
description
string | null

Resumo breve do pacote explicando o que ele abrange.

​
transactionRoute
string | null

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

​
segmentId
string | null

Identificador único do Segmento ao qual este Pacote de Taxas está vinculado no Midaz Ledger.

​
waivedAccounts
string[] | null

Lista de contas que estão isentas das taxas definidas no pacote.

​
createdAt
string<date-time>

Data em que o pacote foi criado.

​
updatedAt
string<date-time> | null

Data em que o pacote foi atualizado pela última vez.

​
deletedAt
string<date-time> | null

Data em que o pacote foi excluído.