TypeScript data models reference for Evolución Patrimonial

All data in the platform is typed with TypeScript interfaces defined in types/index.ts. Every object exchanged between components, consumed from the mock layer, or persisted to external sources conforms to one of these interfaces. This reference documents every field across all interfaces so auditors, developers, and integrators share a common vocabulary.

Declaracion

The root object representing a single patrimonial declaration. It groups metadata (identity and provenance) with the full patrimonial snapshot.

interface Declaracion {
  metadata: DeclaracionMetadata;
  situacionPatrimonial: SituacionPatrimonial;
}

metadata

DeclaracionMetadata

required

Identity and provenance information for the declaration. See DeclaracionMetadata below.

situacionPatrimonial

SituacionPatrimonial

required

Full patrimonial snapshot at the time of filing. See SituacionPatrimonial below.

DeclaracionMetadata

Describes the identity, origin, and availability status of a declaration. Used throughout search results, comparison selectors, and revision records.

interface DeclaracionMetadata {
  id: string;
  rfc: string;
  nombreCompleto: string;
  institucion: string;
  ejercicio: number;
  tipoDeclaracion: 'INICIAL' | 'MODIFICACION' | 'CONCLUSION';
  fuente: string;
  fechaActualizacion: string;
  estatusDisponibilidad: 'COMPLETA' | 'PARCIAL' | 'NO_DISPONIBLE';
}

string

required

Unique declaration identifier. Convention: D-{year}-{sequence}, e.g. "D-2022-001".

rfc

string

required

RFC (Registro Federal de Contribuyentes) of the public servant, e.g. "ROBJ800101XYZ".

nombreCompleto

string

required

Full name of the public servant as it appears in the source system, e.g. "Juan Roberto Robles".

institucion

string

required

Name of the public institution where the servant holds their position, e.g. "Secretaría de Finanzas".

ejercicio

number

required

Fiscal year to which the declaration corresponds, e.g. 2022.

tipoDeclaracion

'INICIAL' | 'MODIFICACION' | 'CONCLUSION'

required

Declaration type. See Declaration types for the significance of each value.

fuente

string

required

Human-readable name of the data source that provided this declaration, e.g. "SFP API Nacional". Corresponds to FuenteDatos.nombre.

fechaActualizacion

string

required

ISO 8601 datetime of the last update from the source system, e.g. "2022-05-15T10:00:00Z".

estatusDisponibilidad

'COMPLETA' | 'PARCIAL' | 'NO_DISPONIBLE'

required

Data completeness status as reported by the source. COMPLETA means all sections are available; PARCIAL means one or more sections are missing; NO_DISPONIBLE means the declaration cannot be retrieved.

SituacionPatrimonial

The complete patrimonial snapshot of a public servant at the time of filing. All top-level fields are optional because data availability depends on the source system.

interface SituacionPatrimonial {
  datosGenerales?: { nombre, primerApellido, segundoApellido, rfc };
  ingresos?: Ingresos;
  bienesInmuebles?: { ninguno: boolean; bienes: BienInmueble[] };
  vehiculos?: { ninguno: boolean; vehiculos: Vehiculo[] };
}

datosGenerales

object

Identity data as stored in the patrimonial section (may differ from metadata fields if the source system stores them independently).

Show datosGenerales fields

nombre

string

required

Given name(s) of the public servant.

primerApellido

string

required

First (paternal) surname.

segundoApellido

string

required

Second (maternal) surname. May be an empty string if not applicable.

rfc

string

required

RFC as stored in the patrimonial section.

ingresos

Ingresos

Monthly income breakdown. See Ingresos below.

bienesInmuebles

object

Real-estate holdings declared during this period.

Show bienesInmuebles fields

ninguno

boolean

required

true when the servant explicitly declared no real-estate holdings.

bienes

BienInmueble[]

required

Array of individual real-estate assets. See BienInmueble below. Empty array when ninguno is true.

vehiculos

object

Vehicle holdings declared during this period.

Show vehiculos fields

ninguno

boolean

required

true when the servant explicitly declared no vehicles.

vehiculos

Vehiculo[]

required

Array of individual vehicles. See Vehiculo below. Empty array when ninguno is true.

Ingresos

Monthly income figures declared by the public servant. Used by the congruence analysis panel to assess whether new asset acquisitions are consistent with reported income.

interface Ingresos {
  remuneracionMensualNeta: number;
  otrosIngresosMensuales: number;
  ingresoMensualNeto: number;
  ninguno: boolean;
}

remuneracionMensualNeta

number

required

Net monthly salary from the public position, in Mexican pesos, e.g. 45000.

otrosIngresosMensuales

number

required

Other monthly income (honoraria, rental income, etc.), in Mexican pesos, e.g. 25000.

ingresoMensualNeto

number

required

Sum of all net monthly income. Should equal remuneracionMensualNeta + otrosIngresosMensuales, e.g. 73000.

ninguno

boolean

required

true when the servant explicitly declared zero income. Typically false for active public servants.

BienInmueble

A single real-estate asset within the bienesInmuebles.bienes array.

interface BienInmueble {
  idRegistro: string;
  tipoInmueble: string;
  valorAdquisicion: number;
  formaAdquisicion: string;
  fechaAdquisicion: string;
}

idRegistro

string

required

Unique registry ID for this asset within the declaration, e.g. "INM-1".

tipoInmueble

string

required

Property type as reported by the source, e.g. "Casa", "Departamento", "Terreno".

valorAdquisicion

number

required

Acquisition value in Mexican pesos at the time of purchase, e.g. 2500000.

formaAdquisicion

string

required

Method of acquisition, e.g. "Crédito", "Contado", "Herencia".

fechaAdquisicion

string

required

Date of acquisition in YYYY-MM-DD format, e.g. "2023-02-10".

Vehiculo

A single vehicle within the vehiculos.vehiculos array.

interface Vehiculo {
  idRegistro: string;
  tipoVehiculo: string;
  marca: string;
  modelo: string;
  anio: number;
  valorAdquisicion: number;
}

idRegistro

string

required

Unique registry ID for this vehicle within the declaration, e.g. "VEH-1".

tipoVehiculo

string

required

Vehicle category as reported by the source, e.g. "SUV", "Sedán", "Motocicleta".

marca

string

required

Manufacturer brand, e.g. "Honda".

modelo

string

required

Model name, e.g. "CR-V".

anio

number

required

Model year, e.g. 2023.

valorAdquisicion

number

required

Acquisition value in Mexican pesos, e.g. 650000.

Revision

An audit revision (expediente) created by an auditor to document a comparison and record findings. Each revision references one or more Declaracion IDs.

interface Revision {
  id: string;
  rfcServidorPublico: string;
  nombreServidorPublico: string;
  declaracionesComparadas: string[];
  estatus: 'EN_PROCESO' | 'OBSERVACIONES' | 'SIN_OBSERVACIONES' | 'INCONSISTENCIAS' | 'CERRADA';
  nivelRiesgo: 'BAJO' | 'MEDIO' | 'ALTO' | 'CRITICO';
  etiquetas: string[];
  observacionesGenerales: string;
  fechaCreacion: string;
  fechaActualizacion: string;
  auditorAsignado: string;
}

string

required

Unique revision identifier. Convention: REV-{sequence}, e.g. "REV-001".

rfcServidorPublico

string

required

RFC of the public servant under review, e.g. "ROBJ800101XYZ".

nombreServidorPublico

string

required

Full name of the public servant under review, e.g. "Juan Roberto Robles".

declaracionesComparadas

string[]

required

Array of DeclaracionMetadata.id values included in this revision, e.g. ["D-2022-001", "D-2023-001"]. Typically two declarations (base period vs. recent period).

estatus

'EN_PROCESO' | 'OBSERVACIONES' | 'SIN_OBSERVACIONES' | 'INCONSISTENCIAS' | 'CERRADA'

required

Current workflow status of the revision:

EN_PROCESO — actively being reviewed
OBSERVACIONES — findings noted, pending resolution
SIN_OBSERVACIONES — review complete, no issues found
INCONSISTENCIAS — confirmed discrepancies requiring action
CERRADA — revision finalized and archived

nivelRiesgo

'BAJO' | 'MEDIO' | 'ALTO' | 'CRITICO'

required

Risk classification assigned by the auditor. See Risk levels for full definitions.

etiquetas

string[]

required

Free-form tags applied by the auditor for categorization, e.g. ["Incremento patrimonial", "Bienes"]. Empty array when no tags have been assigned.

observacionesGenerales

string

required

Free-text narrative of findings and observations written by the auditor.

fechaCreacion

string

required

ISO 8601 datetime when the revision was first created, e.g. "2023-06-01T09:00:00Z".

fechaActualizacion

string

required

ISO 8601 datetime of the most recent update to the revision, e.g. "2023-06-02T16:30:00Z".

auditorAsignado

string

required

Name or identifier of the auditor responsible for this revision, e.g. "Ana López".

FuenteDatos

Represents a configured external data source from which declarations are ingested.

interface FuenteDatos {
  id: string;
  nombre: string;
  urlBase: string;
  estado: 'ACTIVA' | 'INACTIVA';
  ultimaSincronizacion: string;
}

string

required

Unique data source identifier, e.g. "F-1".

nombre

string

required

Human-readable name of the data source, e.g. "SFP Declaranet Nacional".

urlBase

string

required

Base URL of the source API, e.g. "https://api.declaranet.gob.mx/v1".

estado

'ACTIVA' | 'INACTIVA'

required

Connection status. ACTIVA means the source is reachable and synchronizing; INACTIVA means it has been disabled or is unreachable.

ultimaSincronizacion

string

required

ISO 8601 datetime of the last successful data sync, e.g. "2023-10-24T18:00:00Z".

BitacoraAccion

A single audit log entry recording a user action in the platform. Used in the Bitácora module, accessible to administrators only.

interface BitacoraAccion {
  id: string;
  usuario: string;
  accion: string;
  modulo: string;
  entidadAfectada: string;
  fecha: string;
  resultado: 'EXITO' | 'ERROR';
}

string

required

Unique log entry identifier. Convention: LOG-{sequence}, e.g. "LOG-100".

usuario

string

required

Name or identifier of the user who performed the action, e.g. "Ana López".

accion

string

required

Description of the action performed, e.g. "Comparación Generada", "Prueba de Conexión".

modulo

string

required

Platform module where the action took place, e.g. "Comparación", "Fuentes de Datos".

entidadAfectada

string

required

The entity (RFC, data source name, revision ID, etc.) that was affected by the action, e.g. "ROBJ800101XYZ".

fecha

string

required

ISO 8601 datetime when the action occurred, e.g. "2023-10-24T09:15:00Z".

resultado

'EXITO' | 'ERROR'

required

Outcome of the action. EXITO means it completed successfully; ERROR means it failed.

User

Represents an authenticated platform user. Used to determine role-based access and display the current user in the sidebar.

interface User {
  id: string;
  name: string;
  role: 'AUDITOR' | 'ADMIN' | 'OIC_CHIEF';
  email: string;
}

string

required

Unique user identifier, e.g. "u1".

name

string

required

Display name of the user, e.g. "Ana López (Auditora)".

role

'AUDITOR' | 'ADMIN' | 'OIC_CHIEF'

required

Role that controls module visibility and access. See User roles for full definitions.

string

required

Institutional email address, e.g. "ana.lopez@oic.gob.mx".

Data Models

Roles & Permissions

TypeScript data models reference for Evolución Patrimonial

Declaracion

DeclaracionMetadata

SituacionPatrimonial

Ingresos

BienInmueble

Vehiculo

Revision

FuenteDatos

BitacoraAccion

User

Build docs developers (and LLMs) love

Data Models

Roles & Permissions

Documentation Index

​Declaracion

​DeclaracionMetadata

​SituacionPatrimonial

​Ingresos

​BienInmueble

​Vehiculo

​Revision

​FuenteDatos

​BitacoraAccion

​User

Build docs developers (and LLMs) love

Declaracion

DeclaracionMetadata

SituacionPatrimonial

Ingresos

BienInmueble

Vehiculo

Revision

FuenteDatos

BitacoraAccion

User