← Volver al índice de esquemas

BeneficiaryCapacity

Cupo de beneficiarios activos del plan y ocupación actual de la cuenta autenticada.

Propiedades

CampoTipoDescripción
maxintegerTope de beneficiarios activos. `-1` significa sin tope.
currentintegerCantidad de beneficiarios activos guardados, independientemente del filtro de archivados.
requiredintegerCantidad de lugares necesarios para crear o reactivar cuentas del trabajo de importación.
exceededboolean`true` cuando el trabajo de importación necesita lugares nuevos y supera el cupo disponible.

Usado en operaciones

  • GET /v1/beneficiaries
  • GET /v1/beneficiaries/imports/{id}
  • GET /v1/beneficiaries/imports/{id}/preview

Referenciado por esquemas