Skip to main content
GET
/
v1
/
packages
/
{id}
Retrieve a Package
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": "b2d91a9f-a369-4d8f-9116-660493b528ab",
  "segmentId": "0196255c-4434-70c0-bf91-6af2effa8cb8",
  "ledgerId": "0196255b-735e-7988-8ad5-ee36a318a50c",
  "minimumAmount": "3000.00",
  "maximumAmount": "6000.00",
  "waivedAccounts": [
    "@account1",
    "@account2"
  ],
  "fees": {
    "maintenance": {
      "feeLabel": "Administrative Fee",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": "16"
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": false,
      "creditAccount": "@account4",
      "routeFrom": "039e417f-cda1-43d0-8ca7-860b1c055197",
      "routeTo": "039e417f-cda1-43d0-8ca7-860b1c055197"
    },
    "adm": {
      "feeLabel": "Test fee",
      "calculationModel": {
        "applicationRule": "percentage",
        "calculations": [
          {
            "type": "percentage",
            "value": "6"
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": true,
      "creditAccount": "@account3",
      "routeFrom": "55811b39-71a5-4ec7-aac6-caa67b1fa6aa",
      "routeTo": "55811b39-71a5-4ec7-aac6-caa67b1fa6aa"
    }
  },
  "enable": true
}

Headers

​
Authorization
string

The authorization token in the 'Bearer <token>' 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"

Path Parameters

​
id
string
required

Unique identifier of the package that you want to update.

Example:

"0195fd1b-b50e-7750-a897-67e2159d1aed"

Response

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

​
id
string
required

Unique identifier of the package, in UUIDv7 format.

​
feeGroupLabel
string
required

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

​
ledgerId
string
required

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

​
minimumAmount
string
required

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

​
maximumAmount
string
required

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

​
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.

​
enable
boolean
required

If true it indicates that the package is active.

​
description
string

Short summary of for the package explaining what it covers.

​
transactionRoute
string

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

​
segmentId
string

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

​
waivedAccounts
string[]

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

​
createdAt
string<date-time>

Date when the package was created.

​
updatedAt
string<date-time>

Date when the package was last updated.

​
deletedAt
string<date-time>

Date when the package was deleted.