GET
/
v1
/
packages
List Packages
curl --request GET \
  --url https://fees.sandbox.midaz.io/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. This header is required if your environment has the Acces Manager plugin enabled.

​
Content-Type
string
required

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

​
X-Organization-Id
string
required

The unique identifier of the Organization associated with the request.

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 end date of the period you want to retrieve. Must also use the start_date.

​
endDate
string

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

​
ledgerId
string

Ledger identifier.

​
segmentId
string

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

Response

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

​
items
object[]

List with the items returned.

​
page
integer

Page number returned.

​
limit
integer

Number of records returned.

​
total
integer

Number of items returned.