Saltar al contenido principal
Actualizar un paquete
curl --request PATCH \
  --url http://127.0.0.1:4002/v1/packages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "feeGroupLabel": "Paquete actualizado",
  "description": "Conjunto actualizado de cargos administrativos",
  "minimumAmount": 200000,
  "minimumAmountScale": 4,
  "maximumAmount": 150000,
  "maximumAmountScale": 5,
  "waivedAccounts": [
    "acc003",
    "acc004"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Tarifa administrativa",
      "calculationModel": {
        "applicationRule": "flatValue",
        "calculations": [
          {
            "type": "flat",
            "value": 15000,
            "valueScale": 3
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "0194fb45-ec77-793d-aeb2-8f86c5467869"
    }
  },
  "enable": false
}
'
{
  "id": "0194dc48-b6ab-728d-9b02-56bff488489a",
  "feeGroupLabel": "Paquete actualizado",
  "description": "Conjunto actualizado de cargos administrativos.",
  "chartOfAccounts": "PIX-DEBIT",
  "segmentId": "ecd2ac18-920e-4438-9f84-208eac050c8a",
  "ledgerId": "b4de02fe-275d-48f9-8288-862cde0d6474",
  "minimumAmount": 200000,
  "maximumAmount": 150000,
  "minimumAmountScale": 4,
  "maximumAmountScale": 4,
  "waivedAccounts": [
    "@acc001",
    "@acc002",
    "@acc003",
    "@acc004"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Tarifa administrativa",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": 1500,
            "valueScale": 2
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "0194fb45-ec77-793d-aeb2-8f86c5467869"
    }
  },
  "enable": false,
  "createdAt": "2025-04-10T03:21:06.782Z",
  "updatedAt": "2025-04-09T18:45:17.976Z",
  "deletedAt": null
}

​
Actualización parcial

Solo puede enviar los campos que desee actualizar. El resto de los valores permanecerán sin cambios. Por ejemplo, para actualizar parcialmente las tarifas:
  • Para agregar una nueva tarifa, inclúyala en la carga útil.
  • Para actualizar una tarifa existente, envíe el nuevo valor.
  • Para eliminar un valor específico, asígnele el valor nulo.
  • Para eliminar un objeto de tarifa completo, utilice un array vacío (p. ej., "taxaAdm": []).
Los campos ledgerId, segmentId y chartOfAccount no se pueden actualizar.

Autorizaciones

​
Authorization
string
header
requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Encabezados

​
Authorization
string

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

​
Content-Type
string
requerido

El tipo de contenido de la solicitud.

​
X-Organization-Id
string
requerido

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

​
X-lerian-Id
string

Identificador único del cliente de Lerian.

Parámetros de ruta

​
id
string
requerido

Identificador único del paquete que deseas actualizar.

Cuerpo

application/json
​
feeGroupLabel
string
requerido

Nombre utilizado para identificar el paquete de tarifas configurado.

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

​
waivedAccounts
string[]

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

Respuesta

201 - application/json
​
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.