Síntesis del concepto
Sigec: Acuerdo de servicio de interoperabilidad WS PAGO
En resumen
DESCRIPCIÓN Servicio REST para el consumo por medio de la plataforma X-ROAD o por el Gateway de SIGEC, el cual permitirá la carga de los datos asociados al pago de las estampillas. ID NOMBRE DATO DESCRIPCIÓN NOMBRE TIPO PAGO VALIDACIÓN MENSAJE OBSERVACIONES El valor del parámetro payedValueId para la anulación de pago debe existir en el sistema. 15 Identificador Pago Identificador generado por el sistema de la entidad que determina la unicidad del pago dentro del proceso paidValueId texto X 1. 16 Valor Pagado Valor efectivamente pagado por concepto de estampilla valuePaid número X 1.
Extracto literal del documento, seleccionado automáticamente. El texto completo está en el documento oficial.
Puntos que trata
- Guías y Manuales CCE
- SIGEC
- Manuales y Guías
Esta síntesis se arma automáticamente a partir del documento oficial. La selección de la regla, los fundamentos y las citas puede omitir matices: no sustituye la lectura del fallo completo.
Texto del documento 10.676 caracteres
Título: Acuerdo de servicio de interoperabilidad WS PAGO
Corporación: Colombia Compra Eficiente
Descriptores: Guías y Manuales CCE, SIGEC, Manuales y Guías
Acuerdo de servicio de interoperabilidad WS PAGO
SERVICIOS DE REPORTE/ANULACIÓN DE PAGOS SOBRE LIQUIDACIONES DE ESTAMPILLAS
DESCRIPCIÓN Servicio REST para el consumo por medio de la plataforma X-ROAD o por el Gateway de SIGEC, el cual permitirá la carga de los datos asociados al pago de las estampillas. (Registro/Anulación)
URL X-ROAD http://{IP_SERVIDOR_XROAD}/r1/CO-PRE/GOB/CCE-8033/ESTAMPILLA/WS-PAGO/registrar
URL GATEWAY SIGEC https://preprosigec.colombiacompra.gov.co/gateway/stamp/v1/stamp/interoperabilityPago/registrar
MÉTODO POST
SERVICIOS DE REPORTE/ANULACIÓN DE PAGOS SOBRE LIQUIDACIONES DE ESTAMPILLAS
DESCRIPCIÓN Servicio REST para el consumo por medio de la plataforma X-ROAD o por el Gateway de SIGEC, el cual permitirá la carga de los datos asociados al pago de las estampillas. (Registro/Anulación)
URL X-ROAD http://{IP_SERVIDOR_XROAD}/r1/CO/GOB/CCE-8033/ESTAMPILLA/WS-PAGO/registrar
URL GATEWAY SIGEC https://sigec.colombiacompra.gov.co/gateway/stamp/v1/stamp/interoperabilityPago/registrar
MÉTODO POST
ID NOMBRE DATO DESCRIPCIÓN NOMBRE TIPO PAGO VALIDACIÓN MENSAJE OBSERVACIONES
0 Token Valor del token suministrado a la entidad para el proceso de autenticación en el sistema. Authorization texto X 1. Parámetro obligatorio y único.
2. Tipo: Texto.
3. Este parámetro va en el header del Request. Si no es correcto:
- Devuelve el mensaje “Error. Token inválido” 1. Si la información que se reporta corresponde a:
- Entidad Territorial: El token enviado deberá corresponder con el que se generó para el registro de la entidad territorial.
- Entidad Descentralizada: El token enviado deberá corresponder con el que se generó para el registro de la entidad descentralizada que depende de la entidad territorial solicitante. Si las entidades descentralizadas que dependen de la territorial solicitante son varias, para cada una de ellas debe existir su respectivo token para el reporte particular de su información.
2. Estos tokens son gestionados por el usuario Administrador Articulador, siempre será el mismo mientras no sea generado nuevamente y es suministrado a la Entidad por medio del procedimiento definido para tal fin.
11 Tipo de Acción Tipo de registro que se reporta:
Valor 1 para reportar un registro
Valor 0 para anulación de un registro type número X Para Pagos:
1. Parámetro Obligatorio y que esté dentro de los valores {1,0}:
- Para registro: 1
- Para anulación: 0
2. Tipo: Número.
3. Si el valor es igual a 1:
a. Verifica el valor “Identificador Pago” (payedValueId) para determinar que el registro no fue cargado con anterioridad en la tabla asociada a los pagos.
4. Si el valor es igual a 0:
a. Verifica el valor “Identificador Pago” (payedValueId) para determinar que el registro que se piensa anular existe en la tabla asociada a los pagos.
b. Verifica que los valores: “Identificador Liquidación” (liquidatedValueId), “Valor Pagado” (valuePayed), “Fecha Pago” (paymentDate) sean iguales al registro existente.
c. Verifica el valor “Identificador Pago” (payedValueId)) para determinar que el registro que se piensa anular no haya sido anulado con anterioridad. Para Pagos:
- Si falla en 1: Devuelve el mensaje: “Error. El valor del parámetro type es obligatorio y dentro de los códigos válidos.”
- Si falla en 3a: Devuelve el mensaje: “Error. El valor del parámetro payedValueId para el registro de pago debe ser único.”
- Si falla en 4a: Devuelve el mensaje: “Error. El valor del parámetro payedValueId para la anulación de pago debe existir en el sistema.”
- Si falla en 4b: Devuelve el mensaje: “Error. El registro de anulación con el parámetro payedValueId suministrado no es idéntico al registrado en el sistema.”
- Si falla en 4c: Devuelve el mensaje: “Error. Ya existe la anulación para este pago”
12 Identificador Liquidación Identificador generado por el sistema de la entidad que determina la unicidad de la liquidación dentro del proceso. liquidatedValueId texto X Para Pago:
1. Parámetro Obligatorio.
2. Tipo: Texto.
3. Se valida que el identificador de la liquidación ya se encuentre creado en el sistema.
4. Se valida que el identificador de la liquidación no tenga registros de anulación. Para Pago:
Si no es exitoso:
- Devuelve el mensaje: “Error. El valor del parámetro liquidatedValueId es obligatorio, debe estar creado en el sistema y no debe estar anulado”
15 Identificador Pago Identificador generado por el sistema de la entidad que determina la unicidad del pago dentro del proceso paidValueId texto X 1. Parámetro obligatorio.
2. Tipo: Texto. Si no es exitoso:
- Devuelve el mensaje: “Error. El valor del parámetro payedValueId es obligatorio.” N/A
16 Valor Pagado Valor efectivamente pagado por concepto de estampilla valuePaid número X 1. Parámetro obligatorio.
2. Tipo: Número.
3. Numérico y con máximo dos dígitos decimales. Si no es exitoso:
- Devuelve el mensaje: “Error. El valor del parámetro valuePayed es obligatorio y debe ser un número con dos decimales máximo” N/A
17 Fecha Pago Fecha en que se realizó el pago paymentDate fecha X 1. Parámetro obligatorio.
2. Tipo: Fecha
3. Formato fecha (yyyy-MM-dd) Si no es exitoso:
- Devuelve el mensaje: “Error. El valor del parámetro paymentDate es obligatorio y debe tener el formato (yyyy-MM-dd)” N/A
N/A
RESPUESTAS DEL SISTEMA
EVENTO HTTPSTATUS MENSAJE
ERROR EN LA VALIDACIÓN DEL TOKEN 401 Error. Token inválido
ERROR EN LA VALIDACION DEL CODIGO DEL ACTO/DOCUMENTO DURANTE EL REGISTRO DEL ACTO/DOCUMENTO 400 Error. El valor del parámetro actDocumentCode es obligatorio y único.
ERROR EN LA VALIDACIÓN DEL CÓDIGO DEL ACTO/DOCUMENTO DURANTE EL REGISTRO DE LA LIQUIDACIÓN 400 Error. El valor del parámetro actDocumentCode es obligatorio y debe existir en el sistema.
ERROR EN LA VALIDACIÓN DE LA PLATAFORMA 400 Error. El valor del parámetro platform es obligatorio y debe estar dentro de los códigos válidos.
ERROR EN LA VALIDACIÓN DEL VALOR DEL ACTO/DOCUMENTO 400 Error. El valor del parámetro generatorFactValue es obligatorio y debe ser un número con dos decimales máximo
ERROR EN LA VALIDACIÓN DE LA FECHA DE INICIO DEL ACTO/DOCUMENTO 400 Error. El valor del parámetro generatorFactStartDate es obligatorio y debe tener el formato (yyyy-MM-dd HH:mm:ss)
ERROR EN LA VALIDACIÓN DE LA FECHA DE FIN DEL ACTO/DOCUMENTO 400 Error. El valor del parámetro generatorFactEndDate es obligatorio y debe tener el formato (yyyy-MM-dd HH:mm:ss)
ERROR EN LA VALIDACIÓN DEL ACTO/DOCUMENTO 400 Error. El parámetro parametricActDocumentCodeType es obligatorio y debe estar dentro de los códigos válidos
ERROR EN LA VALIDACIÓN DEL TRÁMITE 400 Error. El parámetro parametricprocedureCode es obligatorio y debe estar dentro de los códigos válidos
ERROR EN LA VALIDACIÓN DEL TIPO DE IDENTIFICACIÓN DEL SUJETO PASIVO 400 Error. El parámetro payerDocumentParametricTypeCode es obligatorio y debe estar dentro de los códigos válidos
ERROR EN LA VALIDACIÓN NÚMERO DE IDENTIFICACIÓN DEL SUJETO PASIVO 400 Error. El parámetro taxpayerDocumentNumber es obligatorio
ERROR EN LA VALIDACION DE LOS NOMBRES Y APELLIDOS DEL SUJETO PASIVO O RAZÓN SOCIAL 400 Error. El parámetro taxpayerName es obligatorio.
ERROR EN LA VALIDACIÓN DEL IDENTIFICADOR DE LIQUIDACIÓN DURANTE EL REGISTRO DE UNA LIQUIDACIÓN 400 Error. El valor del parámetro liquidatedValueId es obligatorio
ERROR EN LA VALIDACIÓN DEL IDENTIFICADOR DE LIQUIDACIÓN DURANTE EL REGISTRO DE UN PAGO 400 Error. El valor del parámetro liquidatedValueId es obligatorio, debe estar creado en el sistema y no debe estar anulado
ERROR EN LA VALIDACIÓN DEL CÓDIGO DE ESTAMPILLA 400 Error. El valor del parámetro stampNumber es obligatorio y debe existir en el sistema
ERROR EN LA VALIDACIÓN DEL VALOR LIQUIDADO 400 Error. El valor del parámetro liquidatedValue es obligatorio y debe ser un número con dos decimales máximo
ERROR EN LA VALIDACIÓN DEL IDENTIFICADOR DE PAGO 400 Error. El valor del parámetro payedValueId es obligatorio.
ERROR EN LA VALIDACIÓN DEL VALOR PAGADO 400 Error. El valor del parámetro valuePayed es obligatorio y debe ser un número con dos decimales máximo
ERROR EN LA VALIDACIÓN DE LA FECHA DE PAGO 400 Error. El valor del parámetro paymentDate es obligatorio y debe tener el formato (yyyy-MM-dd)
ERROR DE LA VALIDACIÓN DEL TIPO DE ACCIÓN DURANTE EL REGISTRO DE LA LIQUIDACIÓN 400 Error. El valor del parámetro type es obligatorio y debe estar dentro de los códigos válidos
ERROR SI EL REGISTRO YA SE ENCUENTRA CARGADO DURANTE EL REGISTRO DE UNA LIQUIDACIÓN 400 Error. El valor del parámetro liquidatedValueId para el registro de liquidación debe ser único.
ERROR SI EL REGISTRO NO SE ENCUENTRA CARGADO DURANTE LA ANULACIÓN DE UNA LIQUIDACIÓN 400 Error. El valor del parámetro liquidatedValueId para la anulación de liquidación debe existir en el sistema.
ERROR SI EL REGISTRO TIENE ASOCIADOS PAGOS SIN ANULAR DURANTE LA ANULACIÓN DE UNA LIQUIDACIÓN 400 Error. El valor del parámetro liquidatedValueId para la anulación de liquidación no debe tener pagos asociados sin anular.
ERROR SI EL REGISTRO QUE SE PIENSA ANULAR NO ES IGUAL AL REGISTRADO DURANTE LA ANULACIÓN DE UNA LIQUIDACIÓN 400 Error. El registro de anulación con el parámetro liquidatedValueId suministrado no es idéntico al registrado en el sistema.
ERROR SI EL REGISTRO YA CUENTA CON UNA ANULACIÓN DURANTE LA ANULACIÓN DE UNA LIQUIDACIÓN 400 Error. Ya existe la anulación para esta liquidación
ERROR DE LA VALIDACIÓN DEL TIPO DE ACCIÓN DURANTE EL REGISTRO DE UN PAGO 400 Error. El valor del parámetro type es obligatorio y dentro de los códigos válidos.
ERROR SI EL REGISTRO YA SE ENCUENTRA CARGADO DURANTE EL REGISTRO DE UN PAGO 400 Error. El valor del parámetro payedValueId para el registro de pago debe ser único.
ERROR SI EL REGISTRO NO SE ENCUENTRA CARGADO DURANTE LA ANULACIÓN DE UN PAGO 400 Error. El valor del parámetro payedValueId para la anulación de pago debe existir en el sistema.
ERROR SI EL REGISTRO QUE SE PIENSA ANULAR NO ES IGUAL AL REGISTRADO DURANTE LA ANULACIÓN DE UN PAGO 400 Error. El registro de anulación con el parámetro payedValueId suministrado no es idéntico al registrado en el sistema.
ERROR SI EL REGISTRO YA CUENTA CON UNA ANULACIÓN DURANTE LA ANULACIÓN DE UN PAGO 400 Error. Ya existe la anulación para este pago
CARGA DE INFORMACIÓN ALMACENADA DURANTE EL REGISTRO DE UN ACTO/DOCUMENTO 200 Carga del hecho generador almacenada
CARGA DE INFORMACIÓN ALMACENADA DURANTE EL REGISTRO DE UNA LIQUIDACIÓN 200 Carga de la liquidación almacenada
CARGA DE INFORMACIÓN ALMACENADA DURANTE EL REGISTRO DE UN PAGO 200 Carga del pago almacenada