Diferencia entre revisiones de «API UltimoConsecutivo»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
(Página creada con «La API '''UltimoConsecutivo''' es un desarrollo elaborado por el equipo de The Factory HKA el cual tiene como objetivo permitir la creación de numeraciones o secuenciales…»)
 
Línea 28: Línea 28:
 
|String
 
|String
 
|IdNumeracion
 
|IdNumeracion
−
|Numero identificador del secuencial que se desea consultar  
+
|Numero identificador del secuencial que se desea consultar
 +
'''@IMPORTANTE:'''Puede obtenerlo al consumir la '''Api ConsultaNumeraciones'''
 
|}
 
|}
 
<br>
 
<br>
Línea 49: Línea 50:
 
|String
 
|String
 
|Mensaje
 
|Mensaje
−
|Este mensaje está asociado al codigo, útil para identificación de errores
+
|Este mensaje está asociado a la consulta realizada, "Consulta Exitosa" o "Mensaje de error"
 
|-
 
|-
 
|String
 
|String
Línea 56: Línea 57:
 
|-
 
|-
 
|String
 
|String
−
|Plataforma
+
|IdEmpresa
−
|Nombre de la plataforma a consultar numeración TFHKA o DIAN
+
|Identificador interno del Contribuyente emisor ante TFHKA
 
|-
 
|-
−
|Array <Numeraciones>
+
|Array <Secuencial>
−
|Numeraciones
+
|Secuenciales
 
|Histórico de las numeraciones configuradas en TFHKA o asociadas en la DIAN
 
|Histórico de las numeraciones configuradas en TFHKA o asociadas en la DIAN
 +
|-
 +
|String
 +
|Errores
 +
|Listo de errores en caso que inconsistencias en el consumo de la Api
 
|-
 
|-
 
|}  
 
|}  
Línea 68: Línea 73:
 
Donde Class.Numeraciones contiene la siguiente información:
 
Donde Class.Numeraciones contiene la siguiente información:
  
−
; RESPONSE: Parámetros a Recibir Array Numeraciones
+
; RESPONSE: Parámetros a Recibir Array Secuenciales
 
{| class="mw-collapsible wikitable"  
 
{| class="mw-collapsible wikitable"  
 
! style="background:#f2f2f2; text-align:center;"|Tipo
 
! style="background:#f2f2f2; text-align:center;"|Tipo
Línea 76: Línea 81:
 
|-
 
|-
 
|String
 
|String
−
|IdNumeracion
+
|Id
−
|Identificador del secuencial configurado. <u>'''Uso interno TFHKA'''</u>.
+
|Identificador del secuencial configurado en los portales de TFHKA
−
|-
 
−
|String
 
−
|NumeroResolucion
 
−
|Numero de resolución asignado por la DIAN para esta numeración
 
 
|-
 
|-
 
|String
 
|String
−
|FechaResolucion
+
|UltimoConsecutivo
−
|Fecha en la que se solicito la resolución ante la DIAN, en formato: AAAA-MM-DD
+
|Numero del ultimo documento emitido con el secuencial indicado
 
|-
 
|-
−
|String
 
−
|Prefijo
 
−
|Combinación de cifras alfanuméricas que establece al momento de solicitar la numeración o resolución
 
−
|-
 
−
|String
 
−
|NumeroDesde
 
−
|Valor desde donde se da inicio a la numeración solicitada.
 
−
|-
 
−
|String
 
−
|NumeroHasta
 
−
|Valor hasta donde finaliza la numeración solicitada.
 
−
|-
 
−
|String
 
−
|NumeroInicial
 
−
|Valor desde donde se da inicio a la numeración solicitada. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|FechaDesde
 
−
|Fecha en la que se da inicio a la resolución solicitada ante la DIAN, en formato: AAAA-MM-DD
 
−
|-
 
−
|String
 
−
|FechaHasta
 
−
|Fecha en la que finaliza la resolución solicitada ante la DIAN, en formato: AAAA-MM-DD
 
−
|-
 
−
|String
 
−
|ClaveTecnica
 
−
|Cadena alfanumérica establecida por la DIAN para la numeración o resolución solicitada. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|TipoDocumento
 
−
|Código para Invoice, CreditNote, DebitNote. 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 1|Tabla 1]]. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|IdEstablecimiento
 
−
|Identificador del establecimiento configurado por el contribuyente en el portal web. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|CodigoEstablecimiento
 
−
|Código del establecimiento configurado por el contribuyente en el portal web. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|DescripcionEstablecimiento
 
−
|Descripción del establecimiento configurado por el contribuyente en el portal web. <u>'''Uso interno TFHKA'''</u>.. Ejemplo: Principal, Oficina
 
−
|-
 
−
|String
 
−
|DireccionEstablecimiento
 
−
|Dirección del establecimiento configurado por el contribuyente en el portal web. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|TipoServicio
 
−
|Código que Define si el secuencial fue configurado para '''Portal''' o '''Servicio de Integración'''. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|Modalidad
 
−
|Código que Define si el secuencial fue configurado para '''1: Automática''' o '''2: Manual con Prefijo ''', '''3: Manual sin prefijo''', <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|TipoAmbienteSecuencial
 
−
|Código que Define si el ambiente en el cual se configuro el secuencial en el portal de TFHKA '''2: Producción 2.1''' o '''3: Habilitación 2.1'''. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|TestSetId
 
−
|Cadena alfanumérica establecida por la DIAN en la resolución de habilitación para realizar las pruebas solicitadas.'''Uso interno TFHKA'''.
 
−
|-
 
−
|String
 
−
|EnvioDian
 
−
|Código que Define si el secuencial se encuentra generando envíos directo a la DIAN. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|String
 
−
|Activo
 
−
|Código que indica el estatus actual del secuencial en la plataforma de web''' 0: Inactivo''' o '''1: Activo'''. <u>'''Uso interno TFHKA'''</u>.
 
−
|-
 
−
|}
 
 
{{clear}}
 
{{clear}}
 
<br />
 
<br />
  
−
<center>'''Ejemplo  Response Numeración TFHKA'''</center>
+
<center>'''Ejemplo  Request UltimoConsecutivo '''</center>
 
[[Archivo:NumeracionTFHKA.png|800px|sinmarco|centro|NumeracionTFHKA]]
 
[[Archivo:NumeracionTFHKA.png|800px|sinmarco|centro|NumeracionTFHKA]]
 
<br />
 
<br />
 
<br />
 
<br />
−
<center>'''Ejemplo  Response Numeración DIAN'''</center>
+
<center>'''Ejemplo  Response UltimoConsecutivo '''</center>
 
[[Archivo:NumeracionDIAN.png|800px|sinmarco|centro|Numeracion DIAN]]
 
[[Archivo:NumeracionDIAN.png|800px|sinmarco|centro|Numeracion DIAN]]

Revisión del 16:27 1 feb 2024

La API UltimoConsecutivo es un desarrollo elaborado por el equipo de The Factory HKA el cual tiene como objetivo permitir la creación de numeraciones o secuenciales para poder emitir documentos electronicos para el ambiente demo o el ambiente de producción.

@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 visitar la siguiente sección: 

UltimoConsecutivo

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio UltimoConsecutivo 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 a consultar
String TokenEmpresa Suministrado por The Factory HKA Colombia según el ambiente a consultar
TokenPassword
String IdNumeracion Numero identificador del secuencial que se desea consultar

@IMPORTANTE:Puede obtenerlo al consumir la Api ConsultaNumeraciones


RESPONSE
Parámetros a Recibir al consultar el Método ConsultarNumeraciones
Tipo Identificador Descripción
int Código Indica el estado de la operación retornado por el servicio
String Resultado Resultado del consumo del método:
“Exitoso” ó “Error”
String Mensaje Este mensaje está asociado a la consulta realizada, "Consulta Exitosa" o "Mensaje de error"
String Nit Número de documento del contribuyente consultado
String IdEmpresa Identificador interno del Contribuyente emisor ante TFHKA
Array <Secuencial> Secuenciales Histórico de las numeraciones configuradas en TFHKA o asociadas en la DIAN
String Errores Listo de errores en caso que inconsistencias en el consumo de la Api

Donde Class.Numeraciones contiene la siguiente información:

RESPONSE
Parámetros a Recibir Array Secuenciales


Ejemplo Request UltimoConsecutivo
NumeracionTFHKA



Ejemplo Response UltimoConsecutivo
Numeracion DIAN
Tipo Identificador Descripción
String Id Identificador del secuencial configurado en los portales de TFHKA
String UltimoConsecutivo Numero del ultimo documento emitido con el secuencial indicado
Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_UltimoConsecutivo&oldid=5288»