Diferencia entre revisiones de «API AgendarReporte»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
(Página creada con «La API '''AgendarReporte''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de agendar un Reporte Programado el c…»)
 
 
(No se muestran 9 ediciones intermedias del mismo usuario)
Línea 1: Línea 1:
 
La API '''AgendarReporte''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de agendar un Reporte Programado el cual el sistema se encargara de agendarlo para ser descargado en un lapso de tiempo no mayor a 24 horas. Luego se podrá descargar el reporte de los documentos emitidos en un formato csv/archivo plano para convertirlo en formato Excel. El reporte programado le permitirá traer todos los registros hechos en el periodo seleccionado. El periodo máximo por reporte es de 35 días, para obtener reportes de distintos meses pueden realizar la solicitud por mes, es decir un reporte a la vez. Esta funcionalidad se puede utilizar en el ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api <u>AgendarReporte</u>.
 
La API '''AgendarReporte''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de agendar un Reporte Programado el cual el sistema se encargara de agendarlo para ser descargado en un lapso de tiempo no mayor a 24 horas. Luego se podrá descargar el reporte de los documentos emitidos en un formato csv/archivo plano para convertirlo en formato Excel. El reporte programado le permitirá traer todos los registros hechos en el periodo seleccionado. El periodo máximo por reporte es de 35 días, para obtener reportes de distintos meses pueden realizar la solicitud por mes, es decir un reporte a la vez. Esta funcionalidad se puede utilizar en el ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api <u>AgendarReporte</u>.
 
<br>
 
<br>
−
 
+
<br>
−
 
 
 
<font color="red">'''@IMPORTANTE:'''</font> Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:
 
<font color="red">'''@IMPORTANTE:'''</font> Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:
 
<br>
 
<br>
Línea 8: Línea 7:
  
 
'''Para mayor información pude consultas las URL en la siguiente sección:'''
 
'''Para mayor información pude consultas las URL en la siguiente sección:'''
−
  '''[[Tips_Urls_de_Emisión #AgendarReporte|AgendarReporte]]'''
+
  '''[[Tips_Urls_de_Emisión #AgendarReporteProgramado|AgendarReporteProgramado]]'''
  
−
 
+
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio <u>AgendarReporte</u> y de esta forma garantizar la implementación de este nuevo método:
−
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''AgendarReporte'''y de esta forma garantizar la implementación de este nuevo método:
 
  
  
Línea 29: Línea 27:
 
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
 
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
 
|-
 
|-
−
|TokenPassword
+
|TokenClave
 
|-
 
|-
 
|String
 
|String
 
|ClaveSecreta
 
|ClaveSecreta
−
|Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción <u>'''PROXIMAMENTE'''</u>
+
|Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción.
 +
|-
 +
|Array <Reporte>
 +
|Reporte
 +
|Parámetros que conforman la cabecera del reporte a agendar
 +
|-
 +
|String
 +
|CantidadDecimales
 +
|Se envía la cantidad de decimales a utilizar (mínimo 0, máximo 6)
 +
|-
 +
|String
 +
|Correo
 +
|Debe identificar el correo al que desea llegue el reporte
 +
|-
 +
|String
 +
|EstadoLegal
 +
|Se muestra el estado legal de los documentos este solamente es visible cuando el codigo de reporte es igual a 2
 +
|-
 +
|Array <Filtro>
 +
|Filtros
 +
|Parametros que identifican las caracteristicas del reporte.
 +
|-
 +
|String
 +
|CodigoReporte
 +
|Existen dos opciones para agendar el reporte:
 +
: 2= Reporte General Programado Facturación
 +
|-
 +
|String
 +
|FechaInicio
 +
|Describe la fecha inicial desde en que desea agendar el reporte.
 +
|-
 +
|String
 +
|FechaFin
 +
|Describe la fecha final hasta la que deseaa agendar el reporte.
 +
|-
 +
|String
 +
|TipoIdentificacionAdquiriente
 +
|Describe el Tipo de Identificación del adquiriente
 +
:Si el contenido de este atributo no corresponde a uno de los valores de la  [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 3|Tabla 3]]
 +
|-
 +
|String
 +
|NumeroIdentificacionAdquiriente
 +
|Describe Número del Documento o Identificación Fiscal del adquirente
 +
|-
 +
|String
 +
|EstatusDian
 +
|p
 +
|-
 +
|String
 +
|EstatusAcuseRecibo
 +
|p
 +
|-
 +
|String
 +
|EstatusCorreoElectronico
 +
|p
 +
|-
 +
|String
 +
|EstatusHka
 +
|Se debe indicar el codigo de respuesta del servicio de TFHKA
 +
: 200= Documento Exitoso
 +
: 208= Documento de contingencia recibido, se enviará más tarde a la DIAN
 +
: 99= Documento fue rechazado por la DIAN
 +
|-
 +
|String
 +
|TipoDocumento
 +
|Se debe indicar el codigo de respuesta del servicio de TFHKA
 +
: 01= Factura Electronica de Venta
 +
: 91= Nota Credito
 +
: 92= Nota Debito
 +
: 03= Nota Contingencia
 +
|-
 +
|String
 +
|RangoMontoInicial
 +
|Valores iniciales en los que desea se agende el reporte, se requiere punto(.) como separadores de miles
 
|-
 
|-
−
|Array <Productos>
+
|String
−
|Productos
+
|RangoMontoFinal
−
|Parámetros que conforman la clase '''DetalleDeFactura''' del Objeto Factura'</u>
+
|Valores finales en los que desea se agende el reporte, se requiere punto(.) como separadores de miles
 +
|-
 +
|String
 +
|OrigenFacturacion
 +
|Define el servicio por el cual se genero la emision de los documentos electronicos. Existen las siguientes opciones:
 +
: 1= Portal
 +
: 2= Servicio de Integración
 +
: 3= App Móvil
 +
: 4= Masivo
 +
: 5= App Tili
 +
|-
 +
|String
 +
|Prefijo
 +
|Corresponde al prefijo de la numeracion con la que se genero la emision de los documentos electronicos.
 +
|-
 +
|String
 +
|NumeracionFacturaInicial
 +
|Corresponde corresponde al rango inicial de la numeracion a consultar con la que se genero la emision de los documentos electronicos.
 +
|-
 +
|String
 +
|NumeracionFacturaFinal
 +
|Corresponde corresponde al rango final de la numeracion a consultar con la que se genero la emision de los documentos electronicos.
 +
|-
 +
|String
 +
|CodigoSucursal
 +
|Corresponde al codigo del estableciiento al que corresponde la numeración.
 +
|-
 +
|String
 +
|Ambiente
 +
|Corresponde al ambiente en el que se realizo la emision de los documentos electroncos. '''Este campo debe enviarse null'''
 
|}
 
|}
 
<br>
 
<br>
 +
<br>
 +
<center>'''Ejemplo  Request AgendarReporte Programado'''</center>
 +
[[Archivo:RequestAgendarReporteProgramado.png|800px|sinmarco|centro|Request AgendarReporte Programado]]
 +
<br />
 +
 +
; RESPONSE: Parámetros a Recibir al consumir la Api AgendarReporte
 +
{| 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
 +
|El Reporte Programado ha sido agendado satisfactoriamente
 +
|-
 +
|String
 +
|Resultado
 +
|Resultado del consumo del método:
 +
: “Procesado” ó “Error”
 +
|-
 +
|String
 +
|IdReporte
 +
|Codigo identificador del Reporte agendado
 +
|-
 +
|String
 +
|EstadoLegal
 +
|Codigo indica si el reporte agendado viene con estado Legal
 +
|-
 +
|String
 +
|Errores
 +
|Indica la descripcion de los posibles errores al momento de agendar el reporte.
 +
|}
 +
{{clear}}
 +
<br>
 +
<br>
 +
 +
<center>'''Ejemplo  Response AgendarReporte'''</center>
 +
[[Archivo:AgendarReporteProgramado.png|800px|sinmarco|centro|Agendar Reporte Programado]]
 +
<br />
 +
<br />

Revisión actual del 03:41 13 jul 2024

La API AgendarReporte es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de agendar un Reporte Programado el cual el sistema se encargara de agendarlo para ser descargado en un lapso de tiempo no mayor a 24 horas. Luego se podrá descargar el reporte de los documentos emitidos en un formato csv/archivo plano para convertirlo en formato Excel. El reporte programado le permitirá traer todos los registros hechos en el periodo seleccionado. El periodo máximo por reporte es de 35 días, para obtener reportes de distintos meses pueden realizar la solicitud por mes, es decir un reporte a la vez. Esta funcionalidad se puede utilizar en el ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api AgendarReporte.

@IMPORTANTE: Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:


Para mayor información pude consultas las URL en la siguiente sección: 

AgendarReporteProgramado

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio AgendarReporte y de esta forma garantizar la implementación de este nuevo método:


REQUEST
Parámetros a Enviar
Tipo Identificador Descripción
String Nit Número de documento del contribuyente emisor.
String TokenEmpresa Suministrado por The Factory HKA Colombia según el ambiente a consultar
TokenClave
String ClaveSecreta Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción.
Array <Reporte> Reporte Parámetros que conforman la cabecera del reporte a agendar
String CantidadDecimales Se envía la cantidad de decimales a utilizar (mínimo 0, máximo 6)
String Correo Debe identificar el correo al que desea llegue el reporte
String EstadoLegal Se muestra el estado legal de los documentos este solamente es visible cuando el codigo de reporte es igual a 2
Array <Filtro> Filtros Parametros que identifican las caracteristicas del reporte.
String CodigoReporte Existen dos opciones para agendar el reporte:
2= Reporte General Programado Facturación
String FechaInicio Describe la fecha inicial desde en que desea agendar el reporte.
String FechaFin Describe la fecha final hasta la que deseaa agendar el reporte.
String TipoIdentificacionAdquiriente Describe el Tipo de Identificación del adquiriente
Si el contenido de este atributo no corresponde a uno de los valores de la Tabla 3
String NumeroIdentificacionAdquiriente Describe Número del Documento o Identificación Fiscal del adquirente
String EstatusDian p
String EstatusAcuseRecibo p
String EstatusCorreoElectronico p
String EstatusHka Se debe indicar el codigo de respuesta del servicio de TFHKA
200= Documento Exitoso
208= Documento de contingencia recibido, se enviará más tarde a la DIAN
99= Documento fue rechazado por la DIAN
String TipoDocumento Se debe indicar el codigo de respuesta del servicio de TFHKA
01= Factura Electronica de Venta
91= Nota Credito
92= Nota Debito
03= Nota Contingencia
String RangoMontoInicial Valores iniciales en los que desea se agende el reporte, se requiere punto(.) como separadores de miles
String RangoMontoFinal Valores finales en los que desea se agende el reporte, se requiere punto(.) como separadores de miles
String OrigenFacturacion Define el servicio por el cual se genero la emision de los documentos electronicos. Existen las siguientes opciones:
1= Portal
2= Servicio de Integración
3= App Móvil
4= Masivo
5= App Tili
String Prefijo Corresponde al prefijo de la numeracion con la que se genero la emision de los documentos electronicos.
String NumeracionFacturaInicial Corresponde corresponde al rango inicial de la numeracion a consultar con la que se genero la emision de los documentos electronicos.
String NumeracionFacturaFinal Corresponde corresponde al rango final de la numeracion a consultar con la que se genero la emision de los documentos electronicos.
String CodigoSucursal Corresponde al codigo del estableciiento al que corresponde la numeración.
String Ambiente Corresponde al ambiente en el que se realizo la emision de los documentos electroncos. Este campo debe enviarse null



Ejemplo Request AgendarReporte Programado
Request AgendarReporte Programado


RESPONSE
Parámetros a Recibir al consumir la Api AgendarReporte
Tipo Identificador Descripción
int Código Indica el estado de la operación retornado por el servicio
String Mensaje El Reporte Programado ha sido agendado satisfactoriamente
String Resultado Resultado del consumo del método:
“Procesado” ó “Error”
String IdReporte Codigo identificador del Reporte agendado
String EstadoLegal Codigo indica si el reporte agendado viene con estado Legal
String Errores Indica la descripcion de los posibles errores al momento de agendar el reporte.



Ejemplo Response AgendarReporte
Agendar Reporte Programado



Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_AgendarReporte&oldid=5973»