Ver el código de «Métodos servicio adjuntos web soap - Indice Manual Integración Directa»

<includeonly>=</includeonly>==<font color="blue">Métodos servicio adjuntos web soap</font>==<includeonly>=</includeonly>
El Servicio Adjuntos Web SOAP, expone un único método que se utilizará n veces por documento electrónico generado, donde n es la cantidad de archivos adjuntos que tenga la factura electrónica que se está procesando (tener en cuenta que al ser un correo en donde se envía la factura con su representación gráfica y los adjuntos, entonces existe un límite de adjuntos basándose en el peso (en KB) de los mismos).

===<font color="blue"> Método “CargarAdjuntos”</font> ===
Permite adjuntar o enviar archivos (anexos) por email durante la emisión del documento electrónico. Este método se ejecuta después de consumir el método '''Enviar''' con el parámetro adjuntos en “1” o en “11”. A continuación, se presenta el flujo del método:
<br>
<br>

[[Archivo:DiagramadeEnviódeadjuntos.png|800px|center|Diagrama de Envío de adjuntos]]
<br>

<font color="red">@IMPORTANTE:</font> El método '''CargarAdjuntos''' recibe entre sus parámetros un campo para indicar el envío del correo, es decir, si el campo o propiedad '''enviar''' recibe un “0” entonces el documento sigue a la espera por más adjuntos y si recibe “1” se realiza el envío con los adjuntos que se hayan cargado hasta ese momento.

<br>
<br>
<br>

; REQUEST: Parámetros a Enviar
{| class="mw-collapsible wikitable" 
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|rowspan="2"|String
|tokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia
|-
|tokenPassword
|-
|Adjunto	
|Adjunto	
|Datos de control del documento que se desea adjuntar
|}
Donde Class.Adjunto contiene la siguiente información:
{| class="mw-collapsible wikitable" 
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|byte[]	
|Archivo	
|Arreglo de bytes del archivo que se desea adjuntar
|-
|Array <string>	
|email 	
|Correo al cual se desea enviar el XML (AttachedDocument) con todos los adjuntos cargados hasta el momento (se activa envío cuando enviar es “1”)
|-
|String	
|Enviar	 
|
: "0" Adjunta archivo y lo asocia al documento electrónico sin enviar el email al Adquiriente
:  "1" Adjunta archivo al documento electrónico y envía email de manera inmediata al Adquiriente
|-
|String	
|Formato	
|Extensión del archivo adjunto, formatos permitidos:
: (png, bmp, jpg, pdf, doc, docx, xls, xlsx, ppt, pptx,rar)
|-
|String	
|Nombre	
|Nombre que tomará el archivo adjunto
|-
|String	
|numeroDocumento	
|Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212”
|-
|String	
|Tipo	
| 1: Representación gráfica generada por el ERP 2: Tipo de documento anexo o adjuntos
|}
; RESPONSE: Parámetros a Recibir
{| class="mw-collapsible wikitable" 
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int	
|Código	
|Indica el Estado de la operación retornado por el servicio
|-
|String	
|Mensaje	
|Este mensaje de identificación de errores
|-
|Array <String>	
|mensajesValidacion	
|Mensajes de validación en caso de rechazo
|-
|String	
|resultado	
|Resultado
|}
{{clear}}

===<font color="blue">'''ESCENARIOS EMISIÓN DE DOCUMENTOS CON REPRESENTACIÓN GRÁFICA'''</font>===

===<font color="Blue">Representación gráfica estándar (Uso del parámetro adjuntos del método Enviar en ‘0’ o ‘1’)</font>===

Bajo este escenario, el emisor de documentos electrónicos cuenta con la representación gráfica estándar generada por TFHKA, la cual será entregada al adquiriente en el correo de notificación del documento electrónico.
Durante la emisión del documento, pueden incluirse en la representación gráfica estándar campos extras reservados por TFHKA, los cuales incluirán etiquetas predeterminadas en la misma con el fin de brindarle al lector de la representación, claridad sobre los montos e información
reportada. A continuación se detallan los campos extras reservados por TFHKA en la representación gráfica estándar:

{| class="wikitable" style="width: 100%;"
|+ 
|- valign="center" 	
|-style="text-align:center;" 
|colspan="2"|CAMPOS EXTENSIBLES RESERVADOS POR TFHKA
{| class="wikitable" style="width: 100%;" style="margin: auto;" 
! style="color:white;background:#2F5496; text-align:center;"|Código 
! style="color:white;background:#2F5496; text-align:center;"|Etiqueta PDF
! style="color:white;background:#2F5496; text-align:center;"|Descripción
! style="color:white;background:#2F5496; text-align:center;"|Etiqueta PDF
! style="color:white;background:#2F5496; text-align:center;"|Observaciones
|- valign="center"
|122333
|Aceptación Física
|Aceptación Física
|AN|100
|
|-
|100200
|Pie de página
|Pie de página
|AN|100
|
|-
|5170000
|Total Base Excluida
|Total Base Excluida
|Formato Libre
|Para totales el R.G
|-
|5170001
|TOTAL Descuento Detalle
|TOTAL Descuento Detalle
|Formato Libre
|Para totales el R.G
|-
|5170002
|TOTAL Retenciones
|TOTAL Retenciones
|Formato Libre
|Para totales el R.G
|-
|5170003
|TOTAL a Pagar
|TOTAL a Pagar
|Formato Libre
|Para totales el R.G
|-
|5170004
|TOTAL A PAGAR en Letras
|TOTAL A PAGAR en Letras
|Formato Libre
|Para totales el R.G
|}
|}
[[Archivo:CamposExtrasReservados.png|centro|CamposExtrasReservados]]
[[Archivo:EtiquetasRG.png|centro|EtiquetasRG]]

===<font color="Blue">Representación gráfica personalizada por TFHKA</font>===

Para el caso en que el emisor contrate un servicio de representación gráfica con TFHKA, se debe tener en cuenta que el mismo es un proyecto de desarrollo el cual conlleva tiempos y costos asociados.
Adicional al tiempo asociado al desarrollo del template personalizado por parte TFHKA, se debe tener en cuenta la adaptación del desarrollo en el sistema contable, el cual debe ser realizado por la casa de software o desarrollador del mismo, con el fin de reportar los campos extras en los cuales se reflejará la información que se desea visualizar.

Los campos extras mencionados anteriormente son suministrados por el equipo de representaciones gráficas de TFHKA, una vez se cuente con una versión aprobada por el contribuyente para su uso.

<font color="red">'''@IMPORTANTE:'''</font>Como se observa, este escenario involucra desarrollo de ambas partes (ERP y TFHKA), por lo tanto antes de contratar este servicio se deben dimensionar el alcance y costos de personalización.

===<font color="Blue">Representación gráfica enviada como adjunto desde el sistema administrativo o ERP (Uso del parámetro adjuntos del método Enviar en ‘11’)</font>===

Para el caso en que el emisor contrate un servicio de representación gráfica con la casa de software, desarrollador o encargado de realizar los ajustes correspondientes en el software contable o ERP para la emisión de documentos electrónicos, se deben tener en cuenta los siguientes aspectos:
* The Factory HKA es responsable de la generación del UBL y su transmisión a la DIAN.
* Una vez se compruebe la correcta validación y generación del UBL la casa de software puede proceder a generar una representación gráfica que debe cumplir con:
* Los elementos de ley exigidos por la DIAN: inclusión del código QR y de la cadena del CUFE ó CUDE en los documentos, según corresponda.
* Los elementos de ley exigidos por cualquier entidad supervisora al emisor de los documentos.
* Los elementos visuales y de representación de marca exigidos por el propio cliente: logos, información bancaria, leyendas referentes a las responsabilidades tributarias del emisor, etc.
* La Casa de Software, en este escenario, asume la responsabilidad junto con el propio contribuyente de cualquier incidente de fraude por evasión, malinterpretación, error u omisión de información relevante y obligatoria por parte de la normativa.
* TFHKA no resguarda esta representación en sus sistemas y deja claro que su participación como proveedor tecnológico se limita a la generación del UBL y su validación ante la DIAN.

'''Durante la sincronización de los archivos adjuntos se deben tener en cuenta los siguientes aspectos:'''

* Los archivos a sincronizar deben ser codificados en Base64.
* Se recomienda indicar como correos de destinatarios los emails reportados en el array Class.Destinatario.email[]
* Los nombres de los archivos adjuntos a sincronizar deben ser diferentes.
* Solo se admite la sincronización de un (1) archivo con el parámetro tipo = ‘1’, correspondiente a la representación gráfica del documento electrónico.
* Para los adjuntos comunes a sincronizar, los cuales no corresponden a la representación gráfica del documento, se deberá indicar el parámetro tipo del método CargarAdjuntos en ‘2’, correspondiente a Anexos o adjuntos comunes.
* Todos los adjuntos a ser sincronizados no deben superar el peso de 1.8 MB, esto con el fin de dar cumplimiento a lo establecido en el Anexo Técnico de la DIAN con respecto al peso máximo de 2MB del archivo .ZIP entregado en la notificación de correo electrónico.

<includeonly>=</includeonly>==<font color="blue">Método servicio Eliminar Adjuntos web soap</font>==<includeonly>=</includeonly>
Permite eliminar los archivos adjuntos(anexos) a la factura electrónica, cuando el parámetro adjuntos del método enviar se encuentra en  “1” u “11. Este método se ejecuta después de consumir el método '''CargarAdjuntos''' (Servicio Adjuntos Web SOAP)'''. Cada vez que se consuma este método se eliminaran los últimos adjuntos anexados a la factura enviada.
<br>
<br>
<font color="red">'''@IMPORTANTE:'''</font> El consumo de este método esta contemplado solamente con la versión url V4 del servicio a través de Web Service.

:Para mayor información pude visitar la siguiente sección:
 '''[[Tips_Urls_de_Emisión| Tips Urls de Emisión]]'''
{{clear}}

<br>
; REQUEST: Parámetros a Enviar
{| class="mw-collapsible wikitable" 
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|rowspan="2"|String
|tokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia
|-
|tokenPassword
|-
|String
|numeroDocumento
|Numero o consecutivo del documento al cual se desea eliminar los adjuntos enviados
|}
<br>
; RESPONSE: Parámetros a Recibir
{| class="mw-collapsible wikitable" 
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int	
|Código	
|Indica el Estado de la operación retornado por el servicio
|-
|String	
|Mensaje	
|Este mensaje de identificación de errores o estado de la transaccion realizada
|-
|Array <String>	
|mensajesValidacion	
|Mensajes de validación en caso de rechazo o aceptacion de borrado del ultimo adjunto
|-
|String	
|resultado	
|Resultado
|}
{{clear}}

<br>