Diferencia entre revisiones de «API ConsultarNumeraciones»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
 
(No se muestran 17 ediciones intermedias de 2 usuarios)
Línea 1: Línea 1:
−
<includeonly>=</includeonly>== <font color="Blue"> API ConsultarNumeraciones </font> ==<includeonly>=</includeonly>
+
La API '''ConsultarNumeracion''' es un desarrollo elaborado por el equipo de The Factory HKA el cual tiene como objetivo conocer las resoluciones que tiene cada contribuyente convalidadas en el portal de la DIAN y a su vez poder validar los secuenciales que tiene el contribuyente configurados en el portal de factura electrónica en ambiente demo y en ambiente de producción.
−
La API ConsultarNumeracion es un desarrollo elaborado por el equipo de The Factory HKA el cual tiene como objetivo conocer las resoluciones que tiene cada contribuyente convalidadas en el portal de la DIAN y a su vez poder validar los secuenciales que tiene el contribuyente configurados en el portal de factura electrónica en ambiente demo y en ambiente de producción.
+
<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:
  
−
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarNumeracion y de esta forma garantizar la implementación de este nuevo método:
+
'''Para mayor información pude visitar la siguiente sección:'''
 +
'''[[Tips_Urls_de_Emisión #ConsultarNumeraciones|ConsultarNumeraciones]]'''
 +
 
 +
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''ConsultarNumeracion''' y de esta forma garantizar la implementación de este nuevo método:
  
 
; REQUEST: Parámetros a Enviar
 
; REQUEST: Parámetros a Enviar
Línea 19: Línea 24:
 
|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
Línea 25: Línea 30:
 
|Nombre de la plataforma a consultar numeración TFHKA o DIAN
 
|Nombre de la plataforma a consultar numeración TFHKA o DIAN
 
|}
 
|}
−
 
+
<br>
−
; RESPONSE: Parámetros a Recibir
+
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarNumeraciones
 
{| class="mw-collapsible wikitable"  
 
{| class="mw-collapsible wikitable"  
 
! style="background:#f2f2f2; text-align:center;"|Tipo
 
! style="background:#f2f2f2; text-align:center;"|Tipo
Línea 35: Línea 40:
 
|int
 
|int
 
|Código
 
|Código
−
|Indica el Estado de la operación retornado por el servicio
+
|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 al codigo, útil para identificación de errores
 +
|-
 +
|String
 +
|Nit
 +
|Número de documento del contribuyente consultado
 +
|-
 +
|String
 +
|Plataforma
 +
|Nombre de la plataforma a consultar numeración TFHKA o DIAN
 +
|-
 +
|Array <Numeraciones>
 +
|Numeraciones
 +
|Histórico de las numeraciones configuradas en TFHKA o asociadas en la DIAN
 +
|-
 +
|}
 +
{{clear}}
 +
 
 +
Donde Class.Numeraciones contiene la siguiente información:
 +
 
 +
; RESPONSE: Parámetros a Recibir Array Numeraciones
 +
{| 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"
 
|-
 
|-
 
|String
 
|String
−
|Mensaje
+
|IdNumeracion
−
|Este mensaje de identificación de errores o estado de la transacción realizada
+
|Identificador interno autogestionado por el Contribuyente emisor ante TFHKA
 
|-
 
|-
−
|Array <String>
+
|String
−
|mensajesValidacion
+
|NumeroResolucion
−
|Mensajes de validación en caso de rechazo o aceptación de borrado del último adjunto
+
|Numero de resolución asignado por la DIAN para esta numeración
 +
|-
 +
|String
 +
|FechaResolucion
 +
|Fecha en la que se solicito la resolución ante la DIAN, en formato: AAAA-MM-DD
 +
|-
 +
|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
 
|String
−
|resultado
+
|NumeroHasta
−
|Resultado
+
|Valor hasta donde finaliza la numeración solicitada.
−
|}
+
|-
 +
|String
 +
|NumeroInicial
 +
|Valor desde donde se da inicio a la numeración solicitada.
 +
|-
 +
|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.
 +
|-
 +
|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]].
 +
|-
 +
|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'''.
 +
|-
 +
|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''' / '''3: Habilitación 2.1'''.
 +
|-
 +
|String
 +
|TestSetId
 +
|Cadena alfanumérica establecida por la DIAN en la resolución de habilitación para realizar las pruebas solicitadas.'''Uso interno TFHKA para proceso de habilitación'''.
 +
|-
 +
|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>
 +
[[Archivo:NumeracionTFHKA.png|800px|sinmarco|centro|NumeracionTFHKA]]
 +
<br />
 +
<br />
 +
<center>'''Ejemplo  Response Numeración DIAN'''</center>
 +
[[Archivo:NumeracionDIAN.png|800px|sinmarco|centro|Numeracion DIAN]]

Revisión actual del 03:36 13 jul 2024

La API ConsultarNumeracion es un desarrollo elaborado por el equipo de The Factory HKA el cual tiene como objetivo conocer las resoluciones que tiene cada contribuyente convalidadas en el portal de la DIAN y a su vez poder validar los secuenciales que tiene el contribuyente configurados en el portal de factura electrónica en ambiente demo y en 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: 

ConsultarNumeraciones

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarNumeracion 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
TokenClave
String Plataforma Nombre de la plataforma a consultar numeración TFHKA o DIAN


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 al codigo, útil para identificación de errores
String Nit Número de documento del contribuyente consultado
String Plataforma Nombre de la plataforma a consultar numeración TFHKA o DIAN
Array <Numeraciones> Numeraciones Histórico de las numeraciones configuradas en TFHKA o asociadas en la DIAN

Donde Class.Numeraciones contiene la siguiente información:

RESPONSE
Parámetros a Recibir Array Numeraciones
Tipo Identificador Descripción
String IdNumeracion Identificador interno autogestionado por el Contribuyente emisor ante TFHKA
String NumeroResolucion Numero de resolución asignado por la DIAN para esta numeración
String FechaResolucion Fecha en la que se solicito la resolución ante la DIAN, en formato: AAAA-MM-DD
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.
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.
String TipoDocumento Código para Invoice, CreditNote, DebitNote. Corresponde a uno de los valores de la Tabla 1.
String IdEstablecimiento Identificador del establecimiento configurado por el contribuyente en el portal web. Uso interno TFHKA.
String CodigoEstablecimiento Código del establecimiento configurado por el contribuyente en el portal web. Uso interno TFHKA.
String DescripcionEstablecimiento Descripción del establecimiento configurado por el contribuyente en el portal web. Uso interno TFHKA.. Ejemplo: Principal, Oficina
String DireccionEstablecimiento Dirección del establecimiento configurado por el contribuyente en el portal web. Uso interno TFHKA.
String TipoServicio Código que Define si el secuencial fue configurado para Portal o Servicio de Integración. Uso interno TFHKA.
String Modalidad Código que Define si el secuencial fue configurado para 1: Automática o 2: Manual con Prefijo , 3: Manual sin prefijo.
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 / 3: Habilitación 2.1.
String TestSetId Cadena alfanumérica establecida por la DIAN en la resolución de habilitación para realizar las pruebas solicitadas.Uso interno TFHKA para proceso de habilitación.
String EnvioDian Código que Define si el secuencial se encuentra generando envíos directo a la DIAN. Uso interno TFHKA.
String Activo Código que indica el estatus actual del secuencial en la plataforma de web 0: Inactivo o 1: Activo. Uso interno TFHKA.


Ejemplo Response Numeración TFHKA
NumeracionTFHKA



Ejemplo Response Numeración DIAN
Numeracion DIAN
Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_ConsultarNumeraciones&oldid=5961»