Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CLINTONARMANDO/apiregistropendientes/llms.txt

Use this file to discover all available pages before exploring further.

A pendiente is the core unit of work in API Registro Pendientes. It represents a single field operation — an installation, a fault repair, a device pickup, or a service relocation — that must be scheduled, assigned to a technician, and tracked from creation to completion. Every interaction a client has with your field team is modelled as a pendiente.

What a pendiente represents

When a client calls to report a service outage, request a new internet connection, or ask to move their service to a new address, a dispatcher creates a pendiente. That record captures who requested it, when it should be done, where the technician needs to go, and what work needs to be performed. Pendientes are not simple tickets. Each type carries its own set of sub-entity fields (speeds, device types, VLAN/PPPoE configuration flags), and the record advances through a defined state machine that reflects actual field progress. The API enforces valid state transitions and checks the requesting user’s permissions at each step.

The five work order types

AVERIA

A fault or service interruption reported by a client. The technician diagnoses and repairs the issue on-site. May require PPPoE or VLAN reconfiguration after the fix.

INSTALACION_INTERNET

A new internet service installation. Includes speed tier, monthly cost, and network provisioning — PPPoE credentials and/or VLAN assignment are typically required before the job can be finalised.

INSTALACION_CAMARAS

Installation of surveillance cameras at a client’s premises. Tracked separately from internet installations because the billing and equipment workflow differs.

RECOJO_DISPOSITIVOS

Device pickup from a client location. Records the type of equipment being recovered and the reason for retrieval (e.g., service cancellation, equipment swap).

TRASLADO

Relocation of an existing service to a new address. Captures the destination address, the service type being moved, and any new network configuration required at the new site.

Core fields

Every pendiente shares a common set of fields regardless of type:
FieldTypeDescription
idLongAuto-generated primary key.
fechaCreacionTimestampRecord creation timestamp (inherited from BaseEntity).
fechaPendienteLocalDateScheduled date for the field visit.
registradoPorEmpleadoEmployee who created the work order.
asignadoAEmpleadoTechnician assigned to perform the work. Nullable until assigned.
clienteClienteClient associated with this work order.
estadoEstadoPendienteCurrent lifecycle state (see Estados).
estadoTecnicoEstadoTecnicoNetwork configuration sub-state for PPPoE/VLAN tasks.
tipoTipoPendienteWork order type (one of the five values above).
prioridadPrioridadPendienteUrgency level: BAJA, MEDIA, URGENTE, or MUY_URGENTE.
lugarLugarPendienteGeographic zone where the work will be performed.
empresaEmpresaPendienteISP brand under which the work is performed: SIMAX, WINEX, or OTRO.
direccionStringStreet address or location description for the technician.

Priority levels

Low priority. Routine work with no time constraint. Schedule according to technician availability.

Location zones

The lugar field places the work order in one of the geographic zones served by the ISP. Valid values are: ZONA_RURAL, JULIACA, PUNO, CHUCUITO, PLATERIA, ACORA, ILAVE, JULI, POMATA, CHACACHACA, YONGUYO, ZEPITA, and DESAGUADERO.
Zone is used for dispatching and reporting. It is separate from direccion, which holds the specific street address the technician needs to visit.

Type-specific sub-entities

Each work order type has its own sub-entity with fields that only apply to that type of work. These are returned as nested objects in the API response.
Captures everything needed to provision a new subscriber:
FieldDescription
Speed tierDownload/upload speeds promised to the client.
Monthly costAgreed monthly billing amount.
PPPoE credentialsUsername and password to be configured on the ONU/router. Linked to estadoTecnico.
VLAN IDThe VLAN to be assigned on the access switch. Linked to estadoTecnico.
Both PPPoE and VLAN provisioning are tracked via the estadoTecnico field. The pendiente cannot be finalised until the network team marks the configuration complete.
Tracks the details of a fault diagnosis and repair:
FieldDescription
Fault descriptionWhat the technician found and what was done to fix it.
PPPoE flagWhether PPPoE reconfiguration was needed after the repair.
VLAN flagWhether VLAN reconfiguration was needed after the repair.
After a repair, if the technician changes the ONT or reconfigures the access port, network tasks are raised against estadoTecnico just as they are for installations.
Records the details of a service relocation:
FieldDescription
Destination addressNew address where the service is being moved.
Service typeType of service being relocated (e.g., internet, cameras).
PPPoE flagWhether PPPoE must be reconfigured at the new site.
VLAN flagWhether a new VLAN must be assigned at the new site.
Captures camera installation specifics such as camera count, mounting details, and NVR/DVR configuration notes. Network provisioning for camera VLANs follows the same estadoTecnico pattern when applicable.
FieldDescription
Device typeThe type of equipment being collected (ONU, router, DVR, etc.).
ReasonWhy the device is being retrieved (cancellation, upgrade, swap).
No network configuration tasks are associated with device pickups. The estadoTecnico for these records remains OK.
A pendiente does not exist in isolation. It sits at the centre of several other domain objects:

Cliente

Every pendiente is linked to a client record. The client’s contact details and service history are available through the relationship.

Empleado

Two employee references exist: registradoPor (the dispatcher) and asignadoA (the field technician). Both are foreign keys to the Empleado entity.

Pagos

Payments associated with the work order. Recorded by users with the REGISTRAR_PAGO permission. Multiple payments can be attached to a single pendiente.

Notas

Free-text notes added by any authorised user during the lifecycle of the pendiente. Useful for communicating between dispatcher, technician, and network team.

Historial

An append-only audit log of every state change, assignment, and significant update. Accessible to users with VER_HISTORIAL permission.
Use the history endpoint to audit a work order’s full timeline, including who changed each state and when. This is especially useful for resolving billing disputes or reviewing SLA compliance.

Build docs developers (and LLMs) love