Consulta servicio de deuda sud restricciones · 2019. 4. 17. · AFIP - sud_restricciones Versión:...
Transcript of Consulta servicio de deuda sud restricciones · 2019. 4. 17. · AFIP - sud_restricciones Versión:...
1
AFIP
Consulta servicio de deuda
sud_restricciones
Manual para el desarrollador
Versión 1.2
17/04/19
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 11/10/18
Historial de Modificaciones
Ver Fecha Edicion Descripcion
1.0 18/10/2017 DISTRI Versión Inicial del documento
1.1 11/10/2018 DISTRI Se agrega la información de los campos Impuesto-
Período encontrados como deuda como un nuevo
método tieneDeudaV2. 1.2 17/04/2018 DISTRI Modificaciones en el documento. Sin cambios
funcionales ni de firmas.
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
Contenido Indice
1. Introducción .............................................................................................................................. 3
1.1 Alcance ............................................................................................................................. 3
1.2 Definiciones, Siglas y Abreviaturas ............................................................................. 3
2. Web Services ............................................................................................................................ 4
2.1. Sitio de consulta y canal de atención............................................................................... 4
2.2. Autenticación ......................................................................................................................... 4
2.3. URLs: ...................................................................................................................................... 4
2.4. ID del Servicio ....................................................................................................................... 1
3. Métodos ...................................................................................................................................... 1
3.1. dummy (Verificación del servicio) ................................................................................ 1
3.1.1. Solicitud: .................................................................................................................... 1
3.1.2. Respuesta: ................................................................................................................. 1
3.1.3. Ejemplo: ................................................................................................................. 2
3.2. Método tieneDeudaV2 ........................................................................................................ 21
3.2.1. Solicitud Esquema ................................................................................................. 21
3.2.2. Respuesta Esquema .................................................................................................. 22
3.2.3. Ejemplo ..................................................................................................................... 22
3.3 Método tieneDeuda ............................................................................................................. 24
3.3.1. Solicitud Esquema ................................................................................................. 24
3.3.1. Respuesta Esquema .................................................................................................. 25
3.3.1. Ejemplo ..................................................................................................................... 25
4. Definiciones de tipos de datos ...................................................................................... 26
4.1. Tipos de datos simples .............................................................................................. 26
4.2. Tipos de Datos Complejos ......................................................................................... 27
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
1. Introducción
El servicio de consulta de deuda por CUIT permite que un organismo externo verificar si el contribuyente tiene o no deuda y en qué impuesto/s-periodo/s la registra.
La consulta se realiza mediante un webService SOAP que
básicamente recibe como parámetro una CUIT y responde con un true o false dependiendo si el contribuyente tiene o no deuda.
Este documento está dirigido a quienes tengan la misión de probar
y utilizar este webService.
Para tener acceso a este webService el organismo usuario debe obtener un ticket de
acceso. El proceso de obtención del ticket de acceso esta fuera del alcance de este
documento.
1.1 Alcance
Este WS se puede utilizar para conocer si un contribuyente tiene o no deuda alguna con el organismo y en que impuesto/s-período/s la registra.
1.2 Definiciones, Siglas y Abreviaturas
SOAP Simple Object Acces Protocolo
WSDL Web Services Definition Language
WSAA Web Service de Autenticación y Autorización de AFIP
CE Cliente externo usuario de los webServices de AFIP
CUIT Clave Unica de Identificación Tributaria. Campo numérico de 11 dígitos que identificada unívocamente a un contribuyente.
SSO Ticket para poder acceder a los webServices de AFIP. Son generados por WSAA.
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
2. Web Services
2.1. Sitio de consulta y canal de atención
Para consultas acerca de la arquitectura de Web Services,
autenticación y autorización dirigirse a http://www.afip.gob.ar/ws/.
Las consultas sobre aspectos técnicos del WebService deberán ser remitidas a la
cuenta [email protected]. Para su mejor tratamiento, se solicita detallar en el asunto la
denominación del WebService y ambiente de que se trate (Producción y Homologación),
como así también adjuntar request y response.
Para consultar propias del negocio o normativas, contactarse mediante el sitio www.afip.gob.ar/consultas.
2.2. Autenticación
Para la utilización de los métodos el WebService, a excepción del dummy, se
debe enviar en cada solicitud, el token y el sign, información que es obtenida del
WSAA (Web Service de Autenticación y Autorización), en respuesta a una solicitud
de ticket de acceso.
2.3. URLs:
Descripción URL
Conexión al servicio
en ambiente
de Testing
https://sud-ws.cloudhomo.afip.gob.ar/sud_restricciones
WSDL del servicio
en ambiente
de Testing
https://sud-ws.cloudhomo.afip.gob.ar/sud_restricciones?wsdl
Conexión al servicio
en ambiente
de Producción
https://sud-ws.cloud.afip.gob.ar/sud_restricciones
WSDL del servicio
en ambiente
de Producción
https://sud-ws.cloud.afip.gob.ar/sud_restricciones?wsdl
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
1
2.4. ID del Servicio
El id del servicio es sud_restricciones. El mismo es el nombre de servicio que se deberá usar al solicitar a WSAA el Ticket de Acceso.
3. Métodos
3.1. dummy (Verificación del servicio)
Nombre método: dummy
Descripción: El método dummy permite realizar pruebas al
servicio.
3.1.1. Solicitud:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sud="http://afip.gob.ar/ws/sud_restricciones"> <soapenv:Header/> <soapenv:Body> <sud:dummyRequest/> </soapenv:Body> </soapenv:Envelope>
3.1.2. Respuesta:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:dummyResponse xmlns:ns2="http://afip.gob.ar/ws/sud_restricciones"> <ns2:return> <ns2:appserver>?</ns2:appserver> <ns2:authserver>?</ns2:authserver> <ns2:dbserver>?</ns2:dbserver> </ns2:return> </ns2:dummyResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Donde dummyResponse es del tipo dummyResponse definido en el WSDL y contiene la etiqueta return del tipo dummyReturn.
Los valores de los atributos appserver, authserver y dbserver pueden ser OK o, en caso de falla, ERROR.
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
2
3.1.3. Ejemplo:
Invocación al método:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sud="http://afip.gob.ar/ws/sud_restricciones">
<soapenv:Header/>
<soapenv:Body>
<sud:dummyRequest/>
</soapenv:Body>
</soapenv:Envelope>
Respuesta del método:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:dummyResponse xmlns:ns2="http://afip.gob.ar/ws/sud_restricciones">
<ns2:return>
<ns2:appserver>OK</ns2:appserver>
<ns2:authserver>OK</ns2:authserver>
<ns2:dbserver>OK</ns2:dbserver>
</ns2:return>
</ns2:dummyResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
3.2. Método tieneDeudaV2
3.2. Método tieneDeudaV2
Nombre método: tieneDeudaV2 Descripción: el servicio devuelve TRUE si la CUIT solicitada registra deuda
en el organismo o FALSE si no registra deuda o el faultstring “CUIT sud:cuit INVALIDA” en el caso de ingresar un número de CUIT que no corresponde. Como dato adicional también el servicio informa el Impuesto y el Período que encontró como deuda.
3.2.1. Solicitud Esquema
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sud="http://afip.gob.ar/ws/sud">
<soapenv:Header/>
<soapenv:Body>
<sud:tieneDeudaV2Request>
<sud:cuit>?</sud:cuit>
<sud:cuitRepresentado>?</sud:cuitRepresentado>
<sud:token>?</sud:token>
<sud:sign>?</sud:sign>
</sud:tieneDeudaV2Request>
</soapenv:Body>
</soapenv:Envelope>
Donde sud:tieneDeudaRequest engloba los parámetros de entrada: sud:token y sud:sign: Los mismos son devueltos por el web service de autenticación WSAA.
sud:cuitRepresentada: Debe coincidir con alguna de las CUITS listadas en la
sección relations del token enviado. Debe ser en representación de qué
organismo se solicita la operación.
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
3.2.2. Respuesta Esquema
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:tieneDeudaV2Response xmlns:ns2="http://afip.gob.ar/ws/sud">
<ns2:tieneDeuda>?</ns2:tieneDeuda>
<ns2:deudas>
<ns2:deuda>
<ns2:impuesto>?</ns2:impuesto>
<ns2:periodoFiscal>?</ns2:periodoFiscal>
</ns2:deuda>
<ns2:deudas>
<ns2:consultaId>?</ns2:consultaId>
<ns2:metadata>
<ns2:fechaHora>?</ns2:fechaHora>
<ns2:servidor>?</ns2:servidor>
</ns2:metadata>
</ns2:tieneDeudaV2Response>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Donde tieneDeudaV2Response es del tipo del mismo nombre, definidos e n el WSDL del servici o.
3.2.3. Ejemplo
Invocación del método:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sud="http://afip.gob.ar/ws/sud">
<soapenv:Header/>
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
<soapenv:Body>
<sud:tieneDeudaV2Request>
<sud:cuit>20000000004</sud:cuit>
<sud:cuitRepresentado>20000000006</sud:cuitRepresentado>
<sud:token>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHNzbyB2ZXJzaW9uP
SIyLjAiPgogIDxpZCBzcmM9IkNOPXdzYWFob21vLCBPPUFGSVAsIEM9QVIsIFNFUklBTE5VTUJFUj1
DVUlUIDMzNjkzNDUwMjM5IiBkc3Q9IndzX2JhbmNvcyIgdW5pcXVlX2lkPSI0MTYzODg3NjIzIiBnZW5f
dGltZT0iMTUwNjM1MDYwMiIgZXhwX3RpbWU9IjE4MjE4ODU2OTgiLz4KICA8b3BlcmF0aW9uIHR5c
GU9ImxvZ2luIiB2YWx1ZT0iZ3JhbnRlZCI</sud:token>
<sud:sign>BZYCAR/+XLUW0HLsk4T02XwLXnmU4g+HoY+5nKvekw3aZ7LlKWT1PBFduZxGsxKaltUr
uFyRpu8FjCfSqOyqIrVqHKae8P1Xl+8H2cyHR4+Q3P7HR9h8pFUw3OfP/siEoyITaUHzJuUJxhdDQfb1
P4pRvaSU5rYUzJgAj61SB9g=</sud:sign>
</sud:tieneDeudaV2Request>
</soapenv:Body>
</soapenv:Envelope>
Respuesta del método:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:tieneDeudaV2Response xmlns:ns2="http://afip.gob.ar/ws/sud_restricciones">
<ns2:tieneDeuda>true</ns2:tieneDeuda>
<ns2:deudas>
<ns2:deuda>
<ns2:impuesto>301</ns2:impuesto>
<ns2:periodoFiscal>201201</ns2:periodoFiscal>
</ns2:deuda>
<ns2:deuda>
<ns2:impuesto>301</ns2:impuesto>
<ns2:periodoFiscal>201202</ns2:periodoFiscal>
</ns2:deuda>
<ns2:deuda>
<ns2:impuesto>301</ns2:impuesto>
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
<ns2:periodoFiscal>201203</ns2:periodoFiscal>
</ns2:deuda>
<ns2:deuda>
<ns2:impuesto>301</ns2:impuesto>
<ns2:periodoFiscal>201204</ns2:periodoFiscal>
</ns2:deuda>
</ns2:deudas>
<ns2:consultaId>214454</ns2:consultaId>
<ns2:metadata>
<ns2:fechaHora>2018-10-10T15:41:08-0300</ns2:fechaHora>
<ns2:servidor>servicios-externos</ns2:servidor>
</ns2:metadata>
</ns2:tieneDeudaV2Response>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
3.3 Método tieneDeuda
Nombre método: tieneDeuda Descripción: devuelve TRUE si la CUIT solicitada registra deuda en el
organismo o FALSE si no registra deuda o el faultstring “CUIT sud:cuit INVALIDA” en el caso de ingresar un número de CUIT que no corresponde.
3.3.1. Solicitud Esquema
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sud="http://afip.gob.ar/ws/sud">
<soapenv:Header/>
<soapenv:Body>
<sud:tieneDeudaRequest>
<sud:cuit>?</sud:cuit>
<sud:cuitRepresentado>?</sud:cuitRepresentado>
<sud:token>?</sud:token>
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
<sud:sign>?</sud:sign>
</sud:tieneDeudaRequest>
</soapenv:Body>
</soapenv:Envelope>
Donde sud:tieneDeudaRequest engloba los parámetros de entrada: sud:token y sud:sign: Los mismos son devueltos por el web service de autenticación WSAA.
sud:cuitRepresentada: Debe coincidir con alguna de las CUITS listadas en la
sección relations del token enviado. Debe ser en representación de qué
organismo se solicita la operación.
3.3.1. Respuesta Esquema
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:tieneDeudaResponse xmlns:ns2="http://afip.gob.ar/ws/sud">
<ns2:tieneDeuda>?</ns2:tieneDeuda>
<ns2:consultaId>?</ns2:consultaId>
</ns2:tieneDeudaResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Donde tieneDeudaResponse es del tipo del mismo nombre, definidos e n el WSDL del servici o.
3.3.1. Ejemplo
Invocación del método:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sud="http://afip.gob.ar/ws/sud">
<soapenv:Header/>
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
<soapenv:Body>
<sud:tieneDeudaRequest>
<sud:cuit>20000000004</sud:cuit>
<sud:cuitRepresentado>20000000006</sud:cuitRepresentado>
<sud:token>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHNzbyB2ZXJzaW9uP
SIyLjAiPgogIDxpZCBzcmM9IkNOPXdzYWFob21vLCBPPUFGSVAsIEM9QVIsIFNFUklBTE5VTUJFUj1
DVUlUIDMzNjkzNDUwMjM5IiBkc3Q9IndzX2JhbmNvcyIgdW5pcXVlX2lkPSI0MTYzODg3NjIzIiBnZW5f
dGltZT0iMTUwNjM1MDYwMiIgZXhwX3RpbWU9IjE4MjE4ODU2OTgiLz4KICA8b3BlcmF0aW9uIHR5c
GU9ImxvZ2luIiB2YWx1ZT0iZ3JhbnRlZCI</sud:token>
<sud:sign>BZYCAR/+XLUW0HLsk4T02XwLXnmU4g+HoY+5nKvekw3aZ7LlKWT1PBFduZxGsxKaltUr
uFyRpu8FjCfSqOyqIrVqHKae8P1Xl+8H2cyHR4+Q3P7HR9h8pFUw3OfP/siEoyITaUHzJuUJxhdDQfb1
P4pRvaSU5rYUzJgAj61SB9g=</sud:sign>
</sud:tieneDeudaRequest>
</soapenv:Body>
</soapenv:Envelope>
Respuesta del método:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:tieneDeudaResponse xmlns:ns2="http://afip.gob.ar/ws/sud">
<ns2:tieneDeuda>false</ns2:tieneDeuda>
<ns2:consultaId>2005</ns2:consultaId>
</ns2:tieneDeudaResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
4. Definiciones de tipos de datos
4.1. Tipos de datos simples
Los datos simples tienen una longitud determinada. Según el tipo base
se pueden dar los siguientes casos:
• Longitud N: El campo tiene longitud fija de N dígitos o caracteres.
• Longitud M-N: El campo tiene longitud variable de tamaño M a N, siendo M<N.
Tipo Dato Base Longitud Notas
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
TieneDeuda Boolean TRUE o FALSE
Impuesto Long
El código de impuesto que reviste
deuda.
peridodoFiscal String 6 El formato responde a: YYYYMM.
Los primeros 4 el año, los dos
siguientes el mes. Es el período del
impuesto que reviste deuda.
consultaId Long
fechaHora Date
Servidor string
4.2. Tipos de Datos Complejos
Los campos dentro de un tipo complejo tienen una multiplicidad (M)
determinada, esto es, cuantas veces puede o debe aparecer la etiqueta de
dicho campo. Las distintas variantes son:
• 0..1: Campo opcional que se especifica como máximo una sola vez.
• 0..*: Campo opcional que se especifica cero, una o muchas veces.
• 1..1: Campo obligatorio que se especifica una vez.
• 1..*: Campo obligatorio que se especifica una o más veces.
El tipo de dato simple y la multiplicidad que define a un atributo tiene
relevancia dentro de los tipos complejos utilizados en los request o solicitud.
El principal objetivo es ordenar y restringir el ingreso de datos por parte del
usuario.
En el response o respuesta, los tipos simple y multiplicidad son ignorados en la
documentación, ya que es la respuesta por parte de los servidores de AFIP. Por
simplicidad, en los tipos de datos complejos pertenecientes exclusivamente a
datos de respuesta, se declaran los atributos con multiplicidad opcional (0..1 o
0..*) y se definen con los tipos base (string, float, int, etc.).
Campo Descripción Mult. Tipo
Tipo tieneDeuda : Información asociada a la autenticación y autorización requerida
para la utilización del WS, más los parámetros propios del mismo.
token Token devuelto por el WSAA. 1..1 String
sign Firma devuelta por el WSAA 1..1 String
cuitRepresentada CUIT del contribuyente emisor o
representado. 1..1 CUIT
AFIP- sud_restricciones
Versión: 1.2
Especificaciones técnicas de Servicios Web
Fecha: 17/04/19
CUIT CUIT del cual se solicitan los
datos 1..1 CUIT