GET
/
v1
/
packages
List Packages
curl --request GET \
  --url http://127.0.0.1:4002/v1/packages \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "items": [
    {
      "id": "0195b3c3-9926-785d-a220-9488a4abe9c7",
      "feeGroupLabel": "Teste Calculo",
      "description": "teste enable",
      "chartOfAccounts": null,
      "segmentId": "0195b02d-7552-7b96-8e80-af64fc6efab2",
      "ledgerId": "0195aaf2-f0b9-75a2-bf83-2448407e943c",
      "minimumAmount": 200,
      "maximumAmount": 10000,
      "minimumAmountScale": 2,
      "maximumAmountScale": 2,
      "waivedAccounts": [
        "@sane",
        "@teste"
      ],
      "fees": {
        "iof": {
          "feeLabel": "Ajuste conta de credito fee",
          "calculationModel": {
            "applicationRule": "percentual",
            "calculations": [
              {
                "type": "percentage",
                "value": 600,
                "valueScale": 2
              }
            ]
          },
          "referenceAmount": "originalAmount",
          "priority": 1,
          "isDeductibleFrom": true,
          "creditAccount": "iof"
        },
        "taxaAdminPercent": {
          "feeLabel": "TAXA FIXA",
          "calculationModel": {
            "applicationRule": "flatFee",
            "calculations": [
              {
                "type": "flat",
                "value": 1600,
                "valueScale": 2
              }
            ]
          },
          "referenceAmount": "afterFeesAmount",
          "priority": 2,
          "isDeductibleFrom": false,
          "creditAccount": "deb"
        }
      },
      "enable": false,
      "createdAt": "2025-03-20T13:34:55.27Z",
      "updatedAt": "2025-03-20T17:35:40.866Z",
      "deletedAt": null
    },
    {
      "id": "0195b569-0cf7-71dd-ac1b-a4f68f1a5b24",
      "feeGroupLabel": "tarifas para testes",
      "description": "Tarifas diversas",
      "chartOfAccounts": "teste-cred",
      "segmentId": "0195b02d-7552-7b96-8e80-af64fc6efab2",
      "ledgerId": "0195aaf2-f0b9-75a2-bf83-2448407e943c",
      "minimumAmount": 900,
      "maximumAmount": 10000,
      "mininumAmountScale": 2,
      "maximumAmountScale": 2,
      "waivedAccounts": [
        "@TESTE"
      ],
      "fees": {
        "iof": {
          "feeLabel": "taxa IOF",
          "calculationModel": {
            "applicationRule": "percentual",
            "calculations": [
              {
                "type": "percentage",
                "value": 600,
                "valueScale": 2
              }
            ]
          },
          "referenceAmount": "originalAmount",
          "priority": 1,
          "isDeductibleFrom": true,
          "creditAccount": "deb"
        },
        "taxaAdminPercent": {
          "feeLabel": "Taxa fixa",
          "calculationModel": {
            "applicationRule": "flatFee",
            "calculations": [
              {
                "type": "flat",
                "value": 1700,
                "valueScale": 2
              }
            ]
          },
          "referenceAmount": "afterFeesAmount",
          "priority": 2,
          "isDeductibleFrom": false,
          "creditAccount": "deb"
        }
      },
      "enable": false,
      "createdAt": "2025-03-20T21:15:15.575Z",
      "updatedAt": "2025-03-20T21:15:15.575Z",
      "deletedAt": null
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 2
}

Headers

Authorization
string

The authorization token. </b>This header is required if your environment has the Acces Manager plugin enabled</b>.

Content-Type
string
required

The request content type.

X-Organization-Id
string
required

The unique identifier of the Organization associated with the request.

X-lerian-Id
string

The unique identifier of Lerian's client.

Query Parameters

page
integer

Page number to be returned.

limit
integer

Number of records returned.

total
integer

Number of items returned.

chartOfAccounts
string

Accounting script identifier, for example, for debit-type operations, we may have debit-type-transaction, and for credit-type operations, credit-type-transaction.

segmentId
string

Unique identifier of the product or category to which the taxes are linked. This field is associated with the Midaz Ledger.

ledgerId
string

Ledger identifier.

Response

200 - application/json
items
object[]
required

List with the items returned.

page
integer
required

Page number returned.

limit
integer
required

Number of records returned.

total
integer
required

Number of items returned.