- Print
- DarkLight
Radicar una correspondencia entrante
Este endpoint permite radicar una correspondencia entrante, proporcionando la información necesaria en formato JSON. A continuación, se describen los pasos y los campos requeridos para realizar la radicación.
POST /Correspondencia/Entrante/Radicar
Encabezados
Authorization (string): Token de autorización necesario para acceder al recurso
Cuerpo de la solicitud (JSON)
Campos del DTO
- CodTipoCorrespondencia (string): Código válido y obligatorio de un tipo de correspondencia. Utilice el endpoint: /TipoCorrespondencia/entrante para seleccionar un tipo de correspondencia para radicar.
- IdSucursalCorrespondencia (int): Número obligatorio del ID de la sucursal. Utilice el endpoint /Sucursal/Obtener para obtener las sucursales disponibles y seleccione una sucursal.
- Asunto (String): Descripción obligatoria de máximo 200 caracteres.
- Contacto: Siga los siguientes pasos:
- Consulte la información general del tipo de correspondencia con el endpoint: /TipoCorrespondencia/entrante/{codigoTipoCorrespondencia}, y valide si la propiedad CamposBasicos es true.
- Si CamposBasicos es true, consulte el endpoint: /Contactos/Nit/{nit}”, y debe buscar un contacto por nit o número documento para obtener la siguiente información :
2.1. Id
2.2 Direccion
2.3 Ciudad => Id - Genere un JSON de contacto en el siguiente formato:
Si CamposBasicos es False, deje Contacto como null
- UsuariosCorrespondencia: Lista de id de usuarios existentes y activos en SINCO ERP, se debe llenar mínimo un usuario siempre y cuándo CamposBasicos es true.
Si CamposBasicos es False, se debe enviar UsuariosCorrespondencia=[]
Anexos (opcional, String): cadena de texto alfanumérico.
RadicadoTercero (opcional,string): Campo de texto opcional alfanumérico de máximo 50 caracteres.
Si CamposBasicos es true, puede ir con información o null.
IdUsuarioAutorizado (int): por defecto siempre va el número entero 0.
DescriptoresValores (List
): Array que contiene la información de los datos a guardar de los descriptores que han sido configurados a un tipo de correspondencia y se debe seguir los siguientes pasos:- Consultar la configuración de los descriptores con base al código tipo de correspondencia: /TipoCorrespondencia/EntranteInterna/{idTipoCorrespondencia}/Descriptores
- Validar respuesta del endpoint.
2.1. Si la respuesta trae información de descriptores debe tomar la propiedad id de todos los descriptores.
Algunos descriptores pueden ser obligatorios y otros no, se identifican porque la propiedad Obligatorio es true, significa que al momento de radicar una correspondencia, deben enviar el array de descriptores con su id y valor a guardar. Ejemplo:
El descriptor "Descripcion": "Proveedor", debe utilizar el endpoint /Contactos/Nit/{nit}. Buscarlo y obtener el id para ingresarlo en el json de la propiedad
Valor.
2.2. Si el retorno del endpoint no trae información por defecto debe enviar "DescriptoresValores": []
IdUsuarioFlujo (int): Por defecto se debe enviar el número 0.
CorrespondenciasSaliente (opcional,List
): Array de id de correspondencias salientes que fueron radicadas en SINCO SGD. Por lo tanto, se debe tener en cuenta que los id enviados sean existentes en SINCO SGD y de tipo Saliente. Ejemplo: CorrespondenciasSaliente: [1,2,3].
Por defecto, si no se requiere relacionar nada en esta propiedad, se debe enviar así: CorrespondenciasSaliente: []
- UsuariosNotificar (opcional,List
): Array de id de usuarios activos en SINCO ERP, a los cuales se requiere enviar notificación cuando se radica una correspondencia entrante. Ejemplo : UsuariosNotificar :[50,48].
Por defecto, si no se requiere relacionar nada en esta propiedad, se debe enviar así: UsuariosNotificar :[]
Respuestas
- Código 200:
Correspondencia creada. - Código 400:
No se encontró una estrategia de radicación. - Código 404:
Retorna string error por:- Usuario no existe
- Tipo correspondencia no existe
- Id ciudad no existe
- Correspondencias salientes no existen
- El descriptor {Id} no contiene registros con el valor {valor}
- El id usuario {id}, no se encuentra en el cargo {cargo}.
- Código 409:
Retorna string error por :- Tipo correspondencia no es de tipo entrante o interna
- Tipo correspondencia no está activa
- Usuario no está activo
- Descriptores obligatorios pendientes por información
- El número de factura ya existe para el proveedor
- La actividad {Descripcion}, no tiene usuarios asignados en el cargo {Descripcion}
- Usuario autorizado por no está activo o no está asignado en el cargo.
- Código 500:
Retorna string de error no controlado.