Update a Package

Use this endpoint to update a specific package. Send only the fields you want to change — any fields not included will remain unchanged. Ideal for partial updates without overwriting the entire configuration.

PATCH /v1/packages/{id}

Update a Package

cURL

curl --request PATCH \
  --url https://fees.sandbox.lerian.net/v1/packages/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "feeGroupLabel": "Standard Package",
  "description": "Package for testing",
  "minimumAmount": "3000.00",
  "maximumAmount": "6000.00",
  "waivedAccounts": [
    "customer-brl-1",
    "customer-brl-2",
    "customer-brl-3"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Administrative Fee",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": "16.00"
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": true,
      "creditAccount": "business-brl-1",
      "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252",
      "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed"
    },
    "iof": {
      "feeLabel": "IOF",
      "calculationModel": {
        "applicationRule": "percentual",
        "calculations": [
          {
            "type": "percentage",
            "value": "6.00"
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "business-brl-2"
    }
  },
  "enable": true
}
'

200

Example

{
  "id": "0194dc48-b6ab-728d-9b02-56bff488489a",
  "feeGroupLabel": "Standard Package",
  "description": "Package 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",
    "customer-brl-3"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Administrative Fee",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": "16.00"
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": true,
      "creditAccount": "business-brl-1",
      "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252",
      "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed"
    },
    "iof": {
      "feeLabel": "IOF",
      "calculationModel": {
        "applicationRule": "percentual",
        "calculations": [
          {
            "type": "percentage",
            "value": "6.00"
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "business-brl-2"
    }
  },
  "enable": true,
  "createdAt": "2025-04-10T03:21:06.782Z",
  "updatedAt": "2025-04-09T18:45:17.976Z",
  "deletedAt": null
}

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:

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

Path Parameters

id · string · required

Unique identifier of the package that you want to update.

Example:

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

Body

application/json

feeGroupLabel · string

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

description · string

Short summary of what this Fee Package is designed to handle.

minimumAmount · string

Minimum transaction amount below which the fees in the package don't apply. Important: Use a dot (.) as the decimal separator — commas are not accepted.

maximumAmount · string

Maximum transaction amount above which the fees in the package don't apply. Important: Use a dot (.) as the decimal separator — commas are not accepted.

waivedAccounts · string[]

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

fees · object

Object containing custom-named tax rules. Each key is defined by the client (e.g., admFee, iof), and its value must follow the FeeUpdate object schema. Send only the subfields you want to change for each fee.

Show child attributes

enable · boolean

If true it indicates that the package is active.

Response

200

application/json

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.

Show child attributes

enable · boolean · required

If true it indicates that the package is active.

description · string | null

Short summary of for the package explaining what it covers.

transactionRoute · string | null

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

segmentId · string | null

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

waivedAccounts · string[] | null

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> | null

Date when the package was last updated.

deletedAt · string<date-time> | null

Date when the package was deleted.