Diferencia entre revisiones de «API Elementos»
Sin resumen de edición |
Sin resumen de edición |
||
| Línea 21: | Línea 21: | ||
'''Ejemplo de Encabezado:''' | '''Ejemplo de Encabezado:''' | ||
<pre> | <pre> | ||
Authorization: Bearer <tu_token_jwt> | |||
Accept: application/json | Accept: application/json | ||
Content-Type: application/json | Content-Type: application/json | ||
Revisión actual - 11:05 6 nov 2026
API Elementos de Lazarvs
Esta documentación describe los endpoints disponibles en la API de Lazarvs para acceder a datos de elementos, verificar la existencia de clientes y objetos de contrato, así como insertarlos.
Índice
Información General
- Título: API_Elementos
- Descripción: API para operaciones de elementos en Lazarvs.
- URL Base del Servidor:
{{URL de Lazarvs}}/elementos
Autenticación
Para acceder a los endpoints, se requiere un token JWT que debe incluirse en el encabezado Authorization con el prefijo "Bearer".
Ejemplo de Encabezado:
Authorization: Bearer <tu_token_jwt> Accept: application/json Content-Type: application/json
Convenciones y nombres externos
Los nombres externos utilizados por la integración no incluyen el prefijo SDT. Los nombres de los tipos internos pueden conservarlo.
| Recurso | Raíz JSON GET | Raíz JSON POST |
|---|---|---|
| Cliente | Cliente |
Cliente
|
| Objeto de contrato | ObjetoContrato |
ObjetoContrato
|
| Proyecto | ProyectoLista |
No disponible |
El nombre ProyectoLista corresponde a la variable anterior SDTProyectoLista sin el prefijo. El parámetro query continúa llamándose Proyecto y los miembros de cada proyecto continúan siendo PryCod, PryNom y Compania.
- Respetar exactamente las mayúsculas y minúsculas de los nombres externos y parámetros query.
- Los códigos y documentos se envían como cadenas para conservar ceros iniciales.
- Las fechas se expresan como
YYYY-MM-DD. Omitir las fechas opcionales que no se utilicen; su aceptación depende de las validaciones del servicio. - Los booleanos se envían sin comillas:
trueyfalse. - Los números se envían sin comillas, con punto decimal y sin separadores de miles.
- Los ejemplos son orientativos: sustituir los códigos y datos por valores válidos en la compañía y ambiente de destino.
- Los campos que el YAML declara opcionales pueden estar sujetos a validaciones funcionales. No se puede deducir del YAML qué combinaciones de filtros permiten una búsqueda válida.
El YAML adjunto, versión 20261106132434, todavía declara las variables con prefijo SDT. Esta página utiliza los nombres externos indicados para la implementación actual. La estructura de mensajes y los códigos HTTP adicionales deben contrastarse con el servicio: el YAML solo enumera 200 y 404 y no declara la seguridad JWT, aunque la integración requiere el token.
Los GET no requieren cuerpo. En los POST se debe enviar Content-Type: application/json; Accept: application/json solicita una respuesta JSON.
Endpoints de la API
1. /Cliente (Verificar Existencia)
GET {{URL de Lazarvs}}/elementos/Cliente?Documentopersonajuridica=219999990099
- Descripción
- Verifica la existencia de un cliente mediante su documento.
- Método
- GET
- URL
- /Cliente
- Parámetros de Consulta
- Documentopersonafisica (string, opcional): Documento de persona física.
- Documentopersonajuridica (string, opcional): Identificación fiscal de persona jurídica.
- Códigos de Respuesta
- 200 OK: La solicitud fue exitosa, devuelve un JSON con la estructura de Cliente_getOutput.
- 404 Not Found: Cliente no encontrado.
- 401 Unauthorized: Token JWT inválido o ausente.
- Ejemplo de Respuesta Exitosa
{
"Cliente": {
"Nombre": "Corporate YYY",
"TipoPersona": "J",
"Localizacion": "N",
"IdentificacionFiscal": "219999990099"
},
"Mensajes": [
{
"Id": "MSG001",
"Type": 2,
"Description": "Cliente encontrado"
}
]
}
2. /Cliente (Insertar)
- Descripción
- Inserta un nuevo cliente en el sistema.
- Método
- POST
- URL
- /Cliente
- Cuerpo de la Solicitud (JSON)
- Cliente (object): Datos del cliente a insertar.
- Plantilla de cuerpo de solicitud
{
"Cliente": {
"Codigo": "<string>",
"Nombre": "<string>",
"NombreFantasia": "<string>",
"NumeroFidelizacion": "<string>",
"Direccion": "<string>",
"Ciudad": "<string>",
"CodigoPostal": "<string>",
"EstadoProvincia": "<string>",
"Pais": "<string>",
"Telefono": "<string>",
"Celular": "<string>",
"Email": "<string>",
"EmailFacturacion": "<string>",
"DatosFacturacion": "<string>",
"TipoCliente": "<string>",
"TipoPersona": "<string>",
"Territorio": "<string>",
"DocumentoTipo": "<string>",
"DocumentoNumero": "<string>",
"Nacimiento": "2026-11-06",
"TrabajoNombre": "<string>",
"TrabajoDireccion": "<string>",
"TrabajoTelefono": "<string>",
"Localizacion": "<string>",
"IdentificacionFiscal": "<string>",
"Contacto": "<string>",
"LimiteCredito": 0,
"Moneda": "<string>",
"Condicion": "<string>",
"PresentacionDia": "<string>",
"PagoDia": "<string>",
"PagoContacto": "<string>",
"PagoTelefono": "<string>",
"PagoEmail": "<string>",
"PagoEmailSeEnvia": "<boolean>",
"PagoEmailEnvioDia": 0,
"Situacion": "<string>",
"Estado": "<string>"
}
}
- Ejemplo de Cuerpo de Solicitud
{
"Cliente": {
"Nombre": "Corporate YYY",
"NombreFantasia": "YYY",
"NumeroFidelizacion": "",
"Direccion": "Calle y Número",
"Ciudad": "Ciudad X",
"CodigoPostal": "12345",
"EstadoProvincia": "Montevideo",
"Pais": "UY",
"Telefono": "12345678",
"Celular": "012345678",
"Email": "aa@bb.com",
"EmailFacturacion": "cc@bb.com",
"DatosFacturacion": "N/A",
"TipoCliente": "CN",
"TipoPersona": "J",
"Territorio": "01",
"TrabajoNombre": "",
"TrabajoDireccion": "",
"TrabajoTelefono": "",
"Localizacion": "N",
"IdentificacionFiscal": "219999990099",
"Contacto": "Persona X",
"LimiteCredito": 10000.0,
"Moneda": "USD",
"Condicion": "",
"PresentacionDia": "",
"PagoDia": "",
"PagoContacto": "",
"PagoTelefono": "",
"PagoEmail": "",
"PagoEmailSeEnvia": true,
"PagoEmailEnvioDia": 0,
"Situacion": "A",
"Estado": "A"
}
}
- Códigos de Respuesta
- 200 OK: Cliente insertado exitosamente, devuelve los mensajes de la operación, con la estructura de Mensajes.
- 404 Not Found: Respuesta declarada por el YAML; no identifica de forma general todos los errores de inserción.
- 401 Unauthorized: Token JWT inválido o ausente.
- Ejemplo de Respuesta Exitosa
La envoltura de mensajes debe comprobarse en la respuesta efectiva del servicio. El YAML declara el esquema GeneXus.Common.Messages, con la propiedad Messages; no debe suponerse que la respuesta sea un arreglo sin objeto contenedor.
3. /ObjetoContrato (Verificar Existencia)
GET {{URL de Lazarvs}}/elementos/ObjetoContrato?Documpersonajuridica=219999990099&Modelo=MODELO&Serie=SERIE
- Descripción
- Verifica la existencia de un objeto de contrato mediante datos de cliente y objeto.
- Método
- GET
- URL
- /ObjetoContrato
- Parámetros de Consulta
- Documpersonafisica (string, opcional): Documento de persona física.
- Documpersonajuridica (string, opcional): Identificación fiscal de persona jurídica.
- Modelo (string, opcional): Modelo del objeto.
- Serie (string, opcional): Serie del objeto.
- Códigos de Respuesta
- 200 OK: La solicitud fue exitosa, devuelve un JSON con la estructura de ObjetoContrato_getOutput.
- 404 Not Found: Objeto de contrato no encontrado.
- 401 Unauthorized: Token JWT inválido o ausente.
- Ejemplo de Respuesta Exitosa
{
"ObjetoContrato": {
"Cliente": "00001",
"Codigo": "123456",
"Nombre": "Nombre Apellido"
},
"Mensajes": [
{
"Id": "MSG003",
"Type": 2,
"Description": "Objeto de contrato encontrado"
}
]
}
4. /ObjetoContrato (Insertar)
- Descripción
- Inserta un nuevo objeto de contrato en el sistema.
- Método
- POST
- URL
- /ObjetoContrato
- Cuerpo de la Solicitud (JSON)
- ObjetoContrato (object, opcional): Datos del objeto de contrato a insertar. Ver Esquema ObjetoContratoInsertarInput.
- Plantilla de cuerpo de solicitud
{
"ObjetoContrato": {
"Cliente": "<string>",
"Codigo": "<string>",
"Nombre": "<string>",
"FechaInicio": "2026-11-06",
"FechaFin": "2026-11-06",
"Tipo": "<string>",
"DocumentoTipo": "<string>",
"DocumentoNumero": "<string>",
"FechaNacimiento": "2026-11-06",
"Telefono": "<string>",
"Email": "<string>",
"EmailFacturacion": "<string>",
"Localizacion": "<string>",
"IdentificacionFiscal": "<string>",
"Contacto": "<string>",
"Modelo": "<string>",
"Serie": "<string>",
"Ubicacion": "<string>",
"Responsable": "<string>",
"Plan": "<string>",
"Poliza": "<string>",
"DatoAdicional": "<string>",
"Estado": "<string>"
}
}
- Ejemplo de Cuerpo de Solicitud
{
"ObjetoContrato": {
"Cliente": "00001",
"Codigo": "123456",
"Nombre": "Nombre Apellido",
"FechaInicio": "2024-01-01",
"Tipo": "F",
"DocumentoTipo": "C",
"DocumentoNumero": "1234567890",
"FechaNacimiento": "1980-06-30",
"Telefono": "12345678",
"Email": "aa@bb.com",
"EmailFacturacion": "cc@bb.com",
"Localizacion": "",
"IdentificacionFiscal": "",
"Contacto": "Nombre y apellido",
"Modelo": "",
"Serie": "",
"Ubicacion": "",
"Responsable": "",
"Plan": "Plan X",
"Poliza": "Póliza Y",
"DatoAdicional": "Otra información",
"Estado": "A"
}
}
- Códigos de Respuesta
- 200 OK: Objeto de contrato insertado exitosamente, devuelve los mensajes de la operación, con la estructura de Mensajes.
- 404 Not Found: Respuesta declarada por el YAML; no identifica de forma general todos los errores de inserción.
- 401 Unauthorized: Token JWT inválido o ausente.
- Ejemplo de Respuesta Exitosa
La envoltura de mensajes debe comprobarse en la respuesta efectiva del servicio. El YAML declara el esquema GeneXus.Common.Messages, con la propiedad Messages; no debe suponerse que la respuesta sea un arreglo sin objeto contenedor.
5. /Proyecto (Verificar Existencia)
GET {{URL de Lazarvs}}/elementos/Proyecto?Proyecto=PRJ001
- Descripción
- Verifica la existencia de un proyecto mediante su código.
- Método
- GET
- URL
- /Proyecto
- Parámetros de Consulta
Proyecto (string, opcional): Código del proyecto.
- Códigos de Respuesta
- 200 OK: La solicitud fue exitosa, devuelve un JSON con la estructura de ProyectoOutput.
- 404 Not Found: Proyecto no encontrado.
- 401 Unauthorized: Token JWT inválido o ausente.
- Ejemplo de Respuesta Exitosa
{
"ProyectoLista": [
{
"PryCod": "PRJ001",
"PryNom": "Proyecto Alpha",
"Compania": "Empresa X"
}
],
"Mensajes": [
{
"Id": "MSG005",
"Type": 2,
"Description": "Proyecto encontrado"
}
]
}
Esquemas de Respuesta
Esquema Cliente_getOutput
- Cliente (object, opcional): Información detallada del cliente. Ver Esquema ClienteInsertarInput.
- Mensajes (array, opcional): Mensajes relacionados con la operación. Ver Mensajes.
Esquema ObjetoContrato_getOutput
- ObjetoContrato (object, opcional): Información detallada del objeto de contrato. Ver Esquema ObjetoContratoInsertarInput.
- Mensajes (array, opcional): Mensajes relacionados con la operación. Ver Mensajes.
Esquema ProyectoOutput
- ProyectoLista (array, opcional): Lista de proyectos.
- PryCod (string): Código del proyecto.
- PryNom (string): Nombre del proyecto.
- Compania (string): Compañía asociada.
- Mensajes (array, opcional): Mensajes relacionados con la operación. Ver Mensajes.
Esquema Mensajes
- Id (string): ID del mensaje.
- Type (integer, format: int32): Tipo de mensaje: 0 = Advertencia (Warning), 1 = Error (Error), 2 = Información (Info), 3 = Depuración (Debug).
- Description (string): Descripción del mensaje.
Esquema ClienteInsertarInput
- Cliente (object, opcional): Información detallada del cliente a insertar.
- Codigo (string, opcional): Código de Cliente.
- Nombre (string, opcional): Nombre de Cliente.
- NombreFantasia (string, opcional): Nombre Fantasía.
- NumeroFidelizacion (string, opcional): Número de Fidelización.
- Direccion (string, opcional): Dirección de Cliente.
- Ciudad (string, opcional): Ciudad del Cliente.
- CodigoPostal (string, opcional): Código Postal.
- EstadoProvincia (string, opcional): Estado/Provincia.
- Pais (string, opcional): País (ejemplo: "UY").
- Telefono (string, opcional): Teléfono del Cliente.
- Celular (string, opcional): Celular.
- Email (string, opcional): E-mail del Cliente.
- EmailFacturacion (string, opcional): E-mail facturación.
- DatosFacturacion (string, opcional): Datos Facturación.
- TipoCliente (string, opcional): Tipo de Cliente (ejemplo: "CN").
- TipoPersona (string, opcional): Tipo de Persona (ejemplo: "J" para jurídica, "F" para física).
- Territorio (string, opcional): Código de Territorio.
- DocumentoTipo (string, opcional): Tipo de Documento (ejemplo: "N").
- DocumentoNumero (string, opcional): Número de Documento.
- Nacimiento (string, format: date, opcional): Fecha de Nacimiento (formato: YYYY-MM-DD).
- TrabajoNombre (string, opcional): Trabajo del Cliente.
- TrabajoDireccion (string, opcional): Dirección del Trabajo del Cliente.
- TrabajoTelefono (string, opcional): Teléfono del Trabajo del Cliente.
- Localizacion (string, opcional): Localización.
- IdentificacionFiscal (string, opcional): Id Tributaria.
- Contacto (string, opcional): Contacto en el Cliente.
- LimiteCredito (number, format: double, opcional): Límite de Crédito.
- Moneda (string, opcional): Moneda (ejemplo: "USD").
- Condicion (string, opcional): Condición.
- PresentacionDia (string, opcional): Días de presentación de facturas.
- PagoDia (string, opcional): Días de pago a proveedores.
- PagoContacto (string, opcional): Contacto pago a proveedores.
- PagoTelefono (string, opcional): Teléfono pago a proveedores.
- PagoEmail (string, opcional): E-mail pago a proveedores.
- PagoEmailSeEnvia (boolean, opcional): ¿Se envían mails recordatorios?
- PagoEmailEnvioDia (integer, format: int32, opcional): Día de envío.
- Situacion (string, opcional): Situación (ejemplo: "A").
- Estado (string, opcional): Estado del Cliente (ejemplo: "A").
Esquema ObjetoContratoInsertarInput
- ObjetoContrato (object, opcional): Información detallada del contrato a insertar.
- Cliente (string, opcional): Código de Cliente.
- Codigo (string, opcional): Código.
- Nombre (string, opcional): Nombre.
- FechaInicio (string, format: date, opcional): Fecha de inicio (formato: YYYY-MM-DD).
- FechaFin (string, format: date, opcional): Fecha de fin (formato: YYYY-MM-DD).
- Tipo (string, opcional): Tipo (ejemplo: "F").
- DocumentoTipo (string, opcional): Tipo de Documento (ejemplo: "C").
- DocumentoNumero (string, opcional): Número de Documento.
- FechaNacimiento (string, format: date, opcional): Fecha de Nacimiento (formato: YYYY-MM-DD).
- Telefono (string, opcional): Teléfono.
- Email (string, opcional): E-mail.
- EmailFacturacion (string, opcional): E-mail facturación.
- Localizacion (string, opcional): Localización.
- IdentificacionFiscal (string, opcional): Identificación Fiscal.
- Contacto (string, opcional): Contacto.
- Modelo (string, opcional): Modelo.
- Serie (string, opcional): Serie.
- Ubicacion (string, opcional): Ubicación.
- Responsable (string, opcional): Responsable.
- Plan (string, opcional): Plan.
- Poliza (string, opcional): Póliza.
- DatoAdicional (string, opcional): Dato Adicional.
- Estado (string, opcional): Estado (ejemplo: "A").
Valores enumerados
| Campo | Valores |
|---|---|
Cliente.TipoPersona |
F = Fisico, J = Juridico
|
Cliente.DocumentoTipo |
C = CI, D = DNI, P = Pasaporte, N = NIE, O = Otros
|
Cliente.Localizacion |
N = Nacional, E = Exterior
|
Cliente.Situacion |
A = Activo, H = Suspendido, C = Clearing
|
Cliente.Estado |
A = Abierto, C = Cerrado
|
ObjetoContrato.Tipo |
F = PersonaFisica, J = PersonaJuridica, B = BienFisico, I = BienIntangible
|
ObjetoContrato.DocumentoTipo |
C = CI, D = DNI, P = Pasaporte, N = NIE, O = Otros
|
ObjetoContrato.Localizacion |
N = Nacional, E = Exterior
|
ObjetoContrato.Estado |
A = Abierto, C = Cerrado
|
En clientes, DocumentoTipo y DocumentoNumero identifican a la persona física; Localizacion e IdentificacionFiscal corresponden a la identificación fiscal de la persona jurídica. Los valores de los ejemplos deben cumplir las reglas del país y de la compañía.