Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones...

13

Transcript of Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones...

Page 1: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE
Page 2: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

Contenido

INTRODUCCIÓN ........................................................................................................................................................................ 3 OBJETIVO Y ALCANCE ................................................................................................................................................................ 3 PRERREQUISITOS ........................................................................................................................................................................ 3 TERMINOLOGÍA Y ACRÓNIMOS .................................................................................................................................................... 3 ESPECIFICACIONES DEL SERVICIO ............................................................................................................................................... 4 PROPIEDADES DE LA ESTRUCTURA AUTENTICACION .................................................................................................................. 5 MANEJO DE LAS TRANSACCIONES ............................................................................................................................................... 5 TABLAS DE REFERENCIA ............................................................................................................................................................. 5

WS DE NEGOCIO ....................................................................................................................................................................... 6 MÉTODOS ................................................................................................................................................................................ 6 CLASES DEL SISTEMA ............................................................................................................................................................... 10 CÓDIGOS Y MENSAJES DE ERROR ............................................................................................................................................. 12

Page 3: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 3 de 13

INTRODUCCIÓN OBJETIVO Y ALCANCE

Presentar los lineamientos para el consumo del WS whelperdeclaracion por parte de los sistemas pertenecientes al Ministerio de Modernización, a fin de informar las siguientes acciones:

• Validación de Agente • Validación de Subregimen / Tipo de Declaración

PRERREQUISITOS

Para poder invocar al WS, AFIP cuenta con otro WS de autenticación donde previamente deberá gestionar el ticket de Conexión con el cual será validado el ingreso al WS de negocio. La información de cómo gestionar el ticket y los certificados correspondientes se encuentran en los siguientes link:

• Consideraciones Generales: http://www.afip.gob.ar/ws/#wes

• WSAA - WebService de Autenticación y Autorización: http://www.afip.gob.ar/ws/#WSAA

Por cualquier consulta referida al proceso de Autenticación y Autorización de WS en el ambiente de homologación dirigir mail a la siguiente dirección de correo: [email protected]

TERMINOLOGÍA Y ACRÓNIMOS

No aplica.

Page 4: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 4 de 13

ESPECIFICACIONES DEL SERVICIO

Nombre whelperdeclaracion NameSpace Ar.Gob.Afip.Dga.whelperdeclaracion URL Testing https://wsaduhomoext.afip.gob.ar/diav2/whelperdeclaracion/whelperdeclaracion.asmx URL Producción A definir

ValidarAgente

Parámetros de Entrada

Parámetro Tipo

argWSAutenticacionEmpresa WSAutenticacionEmpresa

argValidarAgenteParams ValidarAgenteParams

Resultado de Salida ValidarAgenteRta

Verifica si el agente informado se encuentra habilitado para operar

ValidarTipoDeclaracion

Parámetros de Entrada Parámetro Tipo argWSAutenticacionEmpresa WSAutenticacionEmpresa argValidarTipoDeclaracionParams ValidarTipoDeclaracionParams

Resultado de Salida ValidarTipoDeclaracionRta

Verifica si el tipo de declaración (subregimen), el IMEX y el Despachante cumplen con los requisitos necesarios para operar

Dummy Resultado de Salida Estructura WSDummyResponse Devuelve variables que determinan el correcto funcionamiento del web service (conectividad con la base de datos, respuesta desde el servidor y correcto funcionamiento del servidor de tickets).

DIAGRAMA DE CLASES

No aplica.

Page 5: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 5 de 13

PROPIEDADES DE LA ESTRUCTURA AUTENTICACION

A excepción del método Dummy, cada método del web service tiene dos parámetros, uno para la autenticación y autorización y otro con la información propia de cada método en particular. Con respecto al primero, sus características son siempre las mismas y se detallan a continuación:

Autenticacion

Información para la autenticación y autorización.

ATRIBUTO DESCRIPCIÓN TIPO OBL OBSERVACIONES

Token Token retornado por el WSAA - S

Sign Firma retornada por el WSAA - S

CuitEmpresa Conectada Cuit de la empresa que se conecta String(11) S

TipoAgente Código del tipo de agente que se conecta

String(4) S “IMEX” (Importador/Exportador); “IEOC” (Importador/Exportador ocasional); “DESP” (Despachante); “USUD” (Usuarios Directos)

Rol Rol String(4) S “EXTE”

Aduana Número de Aduana String(3) P [NO APLICA]

Lugar Operativo Lugar Operativo String(5) P [NO APLICA]

MANEJO DE LAS TRANSACCIONES No posee.

TABLAS DE REFERENCIA

Aquellos datos que corresponden a códigos incluidos en tablas de referencia deben ser consultados utilizando el webservice wGesTabRef que contiene la información actualizada de los códigos disponibles para cada tabla citada en particular.

Page 6: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 6 de 13

WS DE NEGOCIO MÉTODOS

A) VALIDARAGENTE

Método para validar si una CUIT se corresponde con el Tipo de Agente informado. El método retorna true en el elemento ResultadoValidacion si la validación es correcta, y false en caso de error. Si el resultado es false, se retorna también una lista de los errores detectados por medio del elemento ListaErrores.

public ValidarAgenteRta ValidarAgente(ValidarAgenteParams argValidarAgenteParams)

Estructura del método

<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <WSAutenticacionEmpresa xmlns="http://tempuri.org/"> <CuitEmpresaConectada>string</CuitEmpresaConectada> <TipoAgente>string</TipoAgente> <Rol>string</Rol> <Aduana>string</Aduana> <LugarOperativo>string</LugarOperativo> </WSAutenticacionEmpresa> </soap:Header> <soap:Body> <ValidarAgente xmlns="http://tempuri.org/"> <argValidarAgenteParams> <CuitEmpresa>string</CuitEmpresa> <TipoAgenteEmpresa>string</TipoAgenteEmpresa> </argValidarAgenteParams> </ValidarAgente> </soap:Body> </soap:Envelope> Ejemplo de Respuesta <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ValidarAgenteResponse xmlns="http://tempuri.org/"> <ValidarAgenteResult> <ResultadoValidacion>boolean</ResultadoValidacion> <RazonSocial>string</RazonSocial> </ValidarAgenteResult> </ValidarAgenteResponse> </soap:Body> </soap:Envelope>

Page 7: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 7 de 13

Parámetros de entrada

PARAMETRO DESCRIPCIÓN TIPO CuitEmpresa CUIT a validar String(11) TipoAgenteEmpresa Tipo de Agente asociado a la CUIT String(4)

Respuesta del método

DESCRIPCIÓN TIPO Incluye la información del resultado de la ejecución (código y descripción del error) ValidarAgenteRta

B) VALIDARTIPODECLARACION Método para validar la correcta combinación de los siguientes datos da una declaración:

• Subregimen • Aduana de registro • CUIT declarante • Tipo de agente declarante • CUIT Importador/Exportador

Se realizan las siguientes validaciones:

• El subregimen y la aduana informados deben estar vigentes. • Los CUITs estén habilitados. • La aduana de registro permita operar el subregimen declarado. • Si el subregimen declarado es de zona franca que el CUIT del declarante esté habilitado para dicha

operación. • El CUIT esté declarado como Gran Operador en caso de haber seleccionado un subregimen de Gran

Operador.

public ValidarTipoDeclaracionRta ValidarTipoDeclaracion(ValidarTipoDeclaracionParams argValidarTipoDeclaracionParams)

Estructura del método

<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <WSAutenticacionEmpresa xmlns="http://tempuri.org/"> <CuitEmpresaConectada>string</CuitEmpresaConectada> <TipoAgente>string</TipoAgente> <Rol>string</Rol> <Aduana>string</Aduana> <LugarOperativo>string</LugarOperativo> </WSAutenticacionEmpresa> </soap:Header> <soap:Body> <ValidarTipoDeclaracion xmlns="http://tempuri.org/"> <argValidarTipoDeclaracionParams> <subregimen>string</subregimen> <codigoAduanaRegistro>string</codigoAduanaRegistro>

Page 8: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 8 de 13

<cuitDeclarante>string</cuitDeclarante> <tipoAgenteDeclarante>string</tipoAgenteDeclarante> <cuitImportadorExportador>string</cuitImportadorExportador> </argValidarTipoDeclaracionParams> </ValidarTipoDeclaracion> </soap:Body> </soap:Envelope> Ejemplo de Respuesta <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ValidarTipoDeclaracionResponse xmlns="http://tempuri.org/"> <ValidarTipoDeclaracionResult> <ResultadoValidacion>boolean</ResultadoValidacion> </ValidarTipoDeclaracionResult> </ValidarTipoDeclaracionResponse> </soap:Body> </soap:Envelope>

Parámetros de entrada

PARAMETRO DESCRIPCIÓN TIPO subregimen El tipo de declaración a validar String(4) codigoAduanaRegistro Código de la Aduana donde se desea validar String(3) cuitDeclarante La CUIT del que declarante de la destinación String(11) tipoAgenteDeclarante Tipo de agente del que declara String(4) cuitImportadorExportador La CUIT del IMEX responsable String(11)

Respuesta del método

DESCRIPCIÓN TIPO Incluye la información del resultado de la ejecución (código y descripción del error) ValidarTipoDeclaracionRta

C) DUMMY

DESCRIPCIÓN Método Dummy para verificación de funcionamiento. Utilizando este método se accede a la verificación del funcionamiento de la infraestructura con respecto a:

• Servidor de Aplicación.

• Servidor de Ticket.

• Servidor de Base de Datos.

El método no recibe parámetros.

Page 9: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 9 de 13

Public Function Dummy() As WsDummyResponse

Parámetros de entrada

<WsDummyResponse> ..<appserver>String</appserver> ..<dbserver>String</dbserver> ..<authserver>String</authserver> </WsDummyResponse>

Respuesta del método

WsDummyResponse Información del estado de la conexión ATRIBUTO DESCRIPCIÓN TIPO

Appserver Respuesta Servidor de Aplicación. “OK” correcto, “NO” en caso contrario

String

Dbserver Respuesta Servidor de Base de Datos. “OK” correcto, “NO” en caso contrario

String

AuthServer Respuesta Servidor de Ticket. “OK” correcto, “NO” en caso contrario

String

Page 10: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 10 de 13

CLASES DEL SISTEMA

Clase: DetalleError Utilizada en el método: ValidarAgente / ValidarTipoDeclaracion

Descripción: detalle de los errores obtenidos en la validación

ATRIBUTO DESCRIPCIÓN TIPO TABLA DE

REFERENCIA EJEMPLO OBL Codigo Código del error obtenido INT - S Descripcion Descripción del error VARCHAR2 (50) - S

DescripcionAdicional Datos adicionales sobre el error y cómo solucionarlo VARCHAR2 (50) - N

Clase: ValidarAgenteParams Utilizada en el método: ValidarAgente Descripción: parámetros para la validación de un Agente/empresa

ATRIBUTO DESCRIPCIÓN TIPO TABLA DE

REFERENCIA EJEMPLO OBL

CuitEmpresa CUIT Importador/Exportador/Despachante

VARCHAR2 (11) - S

TipoAgenteEmpresa Tipo de Agente VARCHAR2 (4) - S

Clase: ValidarAgenteRta Utilizada en el método: ValidarAgente Descripción: respuesta de la validación de un Agente

ATRIBUTO DESCRIPCIÓN TIPO TABLA DE

REFERENCIA EJEMPLO OBL

ResultadoValidacion Resultado de la validación, true si es correcta, si no false

BOOL - S

RazonSocial Razón social correspondiente a la CUIT informada

VARCHAR2 (50) - S

ListaErrores Errores obtenidos durante el proceso de validación DetalleError - S

Clase: ValidarTipoDeclaracionParams Utilizada en el método: ValidarTipoDeclaracion

Descripción: respuesta de la validación de un Agente

ATRIBUTO DESCRIPCIÓN TIPO TABLA DE

REFERENCIA EJEMPLO OBL Subregimen El subregimen a validar VARCHAR2 (4) - S

CodigoAduanaRegistro Código que identifica a la Aduana de trabajo VARCHAR2 (3)

- S

CuitDeclarante CUIT del Declarante VARCHAR2 (11) - S

TipoAgenteDeclarante Tipo de Agente del Declarante VARCHAR2 (4)

- S

CuitImportadorExportador CUIT del Importador/Exportador VARCHAR2 (11)

- S

Page 11: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 11 de 13

Clase: ValidarTipoDeclaracionRta Utilizada en el método: ValidarTipoDeclaracion Descripción: respuesta de la validación del Tipo de Declaración

ATRIBUTO DESCRIPCIÓN TIPO TABLA DE

REFERENCIA EJEMPLO OBL

ResultadoValidacion Resultado de la validación, true si es correcta, si no false

BOOL - S

ListaErrores Errores obtenidos durante el proceso de validación DetalleError

- S

Page 12: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 12 de 13

CÓDIGOS Y MENSAJES DE ERROR 1) ERRORES DEL NEGOCIO

ValidarAgente

NRO DE ERROR DESCRIPCION DEL MENSAJE OBSERVACIONES 30168 Importador/Exportador inexistente

30169 Despachante inexistente

ValidarTipoDeclaracion

NRO DE ERROR DESCRIPCION DEL MENSAJE OBSERVACIONES

10596 ERROR de DATOS : Anomalia en la tabla

20150 Destinación inexistente

20637 Aduana no habilitada para Grandes Operadores

30163 Código de aduana xxxx inexistente o no vigente

30909 Destinación Prohibida

30910 El particular realizo una operación en el último año

30911 Importador no habilitado a trabajar bajo Régimen de Grandes Operadores

50005 Código inexistente

2) ERRORES DE AUTENTICACIÓN CÓDIGO DESCRIPCIÓN

0 OK Procesado

6003 Validación de conexión no coincide con opciones seleccionadas Validación de usuario registrado.

6005 CUIT,CUIL y/o tipo de agente invalido para el servicio Validación de CUIT/CUIL/Tipo de Agente con respecto al servicio.

6006 Rol invalido para el tipo de agente y el servicio solicitado El rol informado no está permitido para el servicio.

6007 Aduana invalida para el CUIT y el tipo de agente informados. Controla que el usuario tenga domicilio registrado para la aduana informada. Solo aplica para los servicios que controlan aduana.

6008 Lugar Operativo invalido para el CUIT y la Aduana informados. Controla que el lugar operativo informado se corresponda con el CUIT del usuario. Solo aplica para los servicios que controlan lugar operativo.

6009 Aduana invalida para el domicilio registrado del CUIT/Tipo de Agente. Controla que el usuario tenga domicilio registrado para la aduana informada. Solo aplica para los servicios que controlan aduana.

Page 13: Contenido · 2017. 8. 15. · WebService whelperdeclaracion MANUAL DEL DESARROLLADOR Validaciones para la Carátula de una Declaración Página 3 de 13 INTRODUCCIÓN OBJETIVO Y ALCANCE

WebService whelperdeclaracion MANUAL DEL DESARROLLADOR

Validaciones para la Carátula de una Declaración

Página 13 de 13

7004 Error Interno. Error inesperado; en estos casos se requiere informar a Sistemas el código de excepción que se retorna como información adicional.

7005 Token no vigente o caducado. Validación de la vigencia del token

7006 Debe ingresar la firma. Control de validez de la firma informada

7007 Debe ingresar el token. Control de presencia del token

7008 Token Inválido. El token recibido no pudo ser identificado.

7013 El Servicio no se corresponde con el informado en el Token. No existe coincidencia entre el servicio invocado y el informado en el token

7015 Cuit con el que desea operar no informado Control de presencia del campo del CUIT

7016 Tipo Agente con el que desea operar no informado Control de presencia del campo del TIPOAGENTE

7017 Rol con el que desea operar no informado Control de presencia del campo del ROL

10566 Campo xxxxx longitud invalida. Cuando el tamaño de algún campo supera el tamaño máximo esperado.

31351 El campo xxxxx no debe ser inferior a xxxxx. Cuando el dato informado es menor al esperado. Aplica a campos numéricos o fechas.

31352 El campo xxxxx no debe ser superior a xxxxx. Cuando el dato informado es mayor al esperado. Aplica a campos numéricos o fechas.

31353 El campo xxxxx tiene un formato erroneo. Debe ser xxxxx. Cuando el formato informado para el campo es inválido o distinto del esperado.

42034 Falta el dato obligatorio xxxxx Si falta algún atributo/Parámetro obligatorio