Saltar al contenido principal
Crear un paquete
curl --request POST \
  --url http://127.0.0.1:4002/v1/packages \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "feeGroupLabel": "Paquete estándar",
  "description": "Conjunto de cargos.",
  "chartOfAccounts": "PIX-DEBIT",
  "segmentId": "ecd2ac18-920e-4438-9f84-208eac050c8a",
  "ledgerId": "b4de02fe-275d-48f9-8288-862cde0d6474",
  "minimumAmount": 10000,
  "minimumAmountScale": 2,
  "maximumAmount": 100000,
  "maximumAmountScale": 2,
  "waivedAccounts": [
    "@acc001",
    "@acc002",
    "@acc003"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Tarifa administrativa",
      "calculationModel": {
        "applicationRule": "maxBetweenTypes",
        "calculations": [
          {
            "type": "flat",
            "value": 500,
            "valueScale": 2
          },
          {
            "type": "percentage",
            "value": 250,
            "valueScale": 2
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": true,
      "creditAccount": "@fees"
    },
    "iof": {
      "feeLabel": "IOF",
      "calculationModel": {
        "applicationRule": "percentual",
        "calculations": [
          {
            "type": "percentage",
            "value": 96,
            "valueScale": 2
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "@iof"
    }
  },
  "enable": true
}
'
{
  "id": "33de988c-348c-476f-840b-72612c4600f6",
  "feeGroupLabel": "Paquete estándar",
  "description": "Conjunto de cargos.",
  "chartOfAccounts": "PIX-DEBIT",
  "segmentId": "ecd2ac18-920e-4438-9f84-208eac050c8a",
  "ledgerId": "b4de02fe-275d-48f9-8288-862cde0d6474",
  "minimumAmount": 10000,
  "maximumAmount": 100000,
  "minimumAmountScale": 2,
  "maximumAmountScale": 27,
  "waivedAccounts": [
    "@acc001",
    "@acc002",
    "@acc003"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Tarifa administrativa",
      "calculationModel": {
        "applicationRule": "maxBetweenTypes",
        "calculations": [
          {
            "type": "flat",
            "value": 500,
            "valueScale": 2
          },
          {
            "type": "percentage",
            "value": 250,
            "valueScale": 2
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": true,
      "creditAccount": "@fees"
    },
    "iof": {
      "feeLabel": "IOF",
      "calculationModel": {
        "applicationRule": "percentual",
        "calculations": [
          {
            "type": "percentage",
            "value": 96,
            "valueScale": 2
          }
        ]
      },
      "referenceAmount": "afterFeeAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "@iof"
    }
  },
  "enable": false,
  "createdAt": "2025-04-10T07:33:03.121Z",
  "updatedAt": null,
  "deletedAt": null
}

Encabezados

​
X-Organization-Id
string
requerido

Identificador único de la organización asociada con la solicitud.

​
Authorization
string

El token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el plugin Access Manager.

​
X-lerian-Id
string

Identificador único del cliente de Lerian.

​
Content-Type
string
requerido

El tipo de medio del recurso. Debe ser application/json.

Cuerpo

application/json
​
feeGroupLabel
string
requerido

Nombre utilizado para identificar el paquete de tarifas configurado.

​
ledgerId
string
requerido

Identificador único del libro contable al que está vinculado este paquete en el Midaz Ledger.

​
minimumAmount
integer
requerido

Monto mínimo de transacción por debajo del cual no se aplican las tarifas del paquete.

​
minimumAmountScale
integer
requerido

Escala para el campo minimumAmount.

​
maximumAmount
integer
requerido

Monto máximo de transacción por encima del cual no se aplican las tarifas del paquete.

​
maximumAmountScale
integer
requerido

Escala para el campo maximumAmount.

​
fees
object
requerido

Lista que contiene la definición de cada impuesto individual del paquete.

​
enable
boolean
requerido

Si es true, indica que el paquete está activo.

​
description
string

Resumen breve de lo que está diseñado para gestionar este paquete de tarifas.

​
chartOfAccounts
string

Identificador que se vincula a una regla contable, como debit-type-transaction o credit-type-transaction.

​
segmentId
string

Identificador único del segmento al que está vinculado este paquete en el Midaz Ledger.

​
waivedAccounts
string[]

Lista de cuentas a las que no se les cobrarán las tarifas de este paquete.

Respuesta

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

​
id
string

Identificador único del paquete en formato UUIDv7.

​
feeGroupLabel
string

Nombre utilizado para identificar el paquete de tarifas configurado.

​
description
string

Resumen breve de lo que está diseñado para gestionar este paquete de tarifas.

​
chartOfAccounts
string

Identificador que se vincula a una regla contable, como debit-type-transaction o credit-type-transaction.

​
segmentId
string

Identificador único del segmento al que está vinculado este paquete en el Midaz Ledger.

​
ledgerId
string

Identificador único del libro contable al que está vinculado este paquete en el Midaz Ledger.

​
minimumAmount
integer

Monto mínimo de transacción por debajo del cual no se aplican las tarifas del paquete.

​
maximumAmount
integer

Monto máximo de transacción por encima del cual no se aplican las tarifas del paquete.

​
minimumAmountScale
integer

Escala para el campo minimumAmount.

​
maximumAmountScale
integer

Escala para el campo maximumAmount.

​
waivedAccounts
string[]

Lista de cuentas a las que no se les cobrarán las tarifas de este paquete.

​
fees
object

Lista que contiene la definición de cada impuesto individual del paquete.

​
enable
boolean

Si es true, indica que el paquete está activo.

​
createdAt
string<date-time>

Fecha en la que se creó el paquete.

​
updatedAt
string<date-time>

Fecha de la última actualización del paquete.

​
deletedAt
string<date-time>

Fecha en la que el paquete fue eliminado.