List Packages

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
}

GET

packages

List Packages

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
}

Headers

Authorization

string

The authorization token in the 'Bearer ' format.
Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

Content-Type

string

required

The type of media of the resource. Must be application/json.

Example:

"application/json"

X-Organization-Id

string

required

The unique identifier of the Organization associated with the request.

Example:

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

Query Parameters

page

integer

Page number to be returned.

limit

integer

Number of records returned.

total

integer

Number of items returned.

sortOrder

string

The order used to sort the results.

transactionRoute

string

The main accounting route that defines the nature of the transaction. Helps group related operations in the ledger.

enable

boolean

If true it indicates that the package is active.

startDate

string

The starting date of the period you want to retrieve. Must also use the end_date.

endDate

string

The end date of the period you want to retrieve. Must also use the start_date.

ledgerId

string

Ledger identifier.

Example:

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

segmentId

string

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

Example:

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

Response

Indicates that the resource was successfully created and the operation was completed as expected.

items

object[]

List with the items returned.

Show child attributes

items.id

string

required

Unique identifier of the package, in UUIDv7 format.

items.feeGroupLabel

string

required

Name of the tax group, used to identify the configured tax package.

items.ledgerId

string

required

Unique identifier of the Ledger this Fee Package is linked to in the Midaz Ledger.

items.minimumAmount

string

required

Minimum transaction amount below which the fees in the package don't apply.

items.maximumAmount

string

required

Maximum transaction amount above which the fees in the package don't apply.

items.fees

object

required

Object containing custom-named tax rules. Each key is defined by the client (e.g., admFee, iof, and its value must follow the Fee object schema.

Show child attributes

items.fees.{key}

object

Represents a tax rule defined under a custom key in the fees object. The key name (e.g., admFee, iof) is defined by the client and must follow camelCase formatting.

Show child attributes

items.fees.{key}.feeLabel

string

required

Display name for the fee, like 'Administrative Fee' or 'IOF'.

items.fees.{key}.calculationModel

object

required

Object that defines the calculation model for the fee.

Show child attributes

items.fees.{key}.calculationModel.applicationRule

enum<string>

required

Defines how the fee is calculated. Options: maxBetweenTypes, percentual, or flatFee.

Available options:

maxBetweenTypes,

percentual,

flatFee

items.fees.{key}.calculationModel.calculations

object[]

required

List of values to be applied according to the applicationRule field.

Show child attributes

items.fees.{key}.calculationModel.calculations.type

string

required

Type of calculation used, like flat or percentage.

items.fees.{key}.calculationModel.calculations.value

string

required

Tax amount.

items.fees.{key}.referenceAmount

enum<string>

required

Defines which amount to use as the base for tax calculation.

Available options:

originalAmount,

afterFeesAmount

items.fees.{key}.priority

integer

required

Sets the order in which fees are applied.

items.fees.{key}.isDeductibleFrom

boolean

required

If true, it indicates that the fee is deducted from the base amount.

items.fees.{key}.creditAccount

string

required

The alias of the account that will receive the credits generated by the fee.

items.fees.{key}.routeFrom

string

Specifies the accounting route for the debit operation.

items.fees.{key}.routeTo

string

Specifies the accounting route for the credit operation.

items.enable

boolean

required

If true it indicates that the package is active.

items.description

string

Short summary of for the package explaining what it covers.

items.transactionRoute

string

The main accounting route that defines the nature of the transaction. Helps group related operations in the ledger.

items.segmentId

string

Unique identifier of the Segment this Fee Package is linked to in the Midaz Ledger.

items.waivedAccounts

string[]

List of accounts that are exempt from the taxes defined in the package.

items.createdAt

string<date-time>

Date when the package was created.

items.updatedAt

string<date-time>

Date when the package was last updated.

items.deletedAt

string<date-time>

Date when the package was deleted.

page

integer

Page number returned.

limit

integer

Number of records returned.

total

integer

Number of items returned.

Retrieve a Package

Update a Package

⌘I

CRM

Fees Engine

Direct Pix

List Packages

Headers

Query Parameters

Response