Diferencia entre revisiones de «API ConsultarEmpresa»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
(Página creada con «<includeonly>=</includeonly>== <font color="Blue"> API ConsultarEmpresa</font> ==<includeonly>=</includeonly> La API ConsultarEmpresaes un desarrollo elaborado por el equip…»)
 
 
(No se muestran 10 ediciones intermedias de 3 usuarios)
Línea 1: Línea 1:
−
<includeonly>=</includeonly>== <font color="Blue"> API ConsultarEmpresa</font> ==<includeonly>=</includeonly>
+
La API '''ConsultarEmpresa''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar los datos fiscales que tiene registrados en el portal de factura electrónica en ambiente demo y en ambiente de producción.
−
La API ConsultarEmpresaes un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente consultar los clientes que tiene registrados en el portal de factura electrónica en ambiente demo y en ambiente de producción.
 
 
<br>
 
<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>
  
−
:Para mayor información pude visitar la siguiente sección:
+
'''Para mayor información pude consultas las URL en la siguiente sección'''
−
  '''[[Tips_Urls_de_Emisión| Tips Urls de Emisión]]'''
+
  '''[[Tips_Urls_de_Emisión #ConsultarEmpresas|ConsultarEmpresas]] '''
−
<br>
 
  
−
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarEmpresa 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 '''ConsultarEmpresa''' 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 26: Línea 25:
 
|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
 
|Plataforma
 
|Plataforma
−
|Nombre de la plataforma a consultar numeración TFHKA o DIAN
+
|Nombre de la plataforma corresponde a TFHKA
 
|}
 
|}
 
<br>
 
<br>
 +
<br>
 +
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarEmpresa
 +
{| 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
 +
|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
 +
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
 +
|-
 +
|String
 +
|idEmpresa
 +
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
 +
|-
 +
|String
 +
|Plataforma
 +
|Nombre de la plataforma corresponde a TFHKA
 +
|-
 +
|String
 +
|Contribuyente
 +
|Representante de la empresa
 +
|-
 +
|}
 +
{{clear}}
 +
<br>
 +
 +
<br>
 +
; RESPONSE: Parámetros a Recibir array Contribuyente
 +
{| 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
 +
|Tipo
 +
|
 +
|-
 +
|String
 +
|DescripciónTipo
 +
|Tipo de persona de contribuyente.
 +
|-
 +
|String
 +
|RazonSocial
 +
|Nombre oficial del contribuyente
 +
|-
 +
|String
 +
|NombreComercial
 +
|Identificador del contribuyente.
 +
|-
 +
|String
 +
|NumeroIdentificación
 +
|
 +
|-
 +
|String
 +
|NumeroIdentificaciónDV
 +
|
 +
|-
 +
|String
 +
|TipoIdentificacion
 +
|
 +
|-
 +
|String
 +
|DescripcionTipoIdentificacion
 +
|
 +
|-
 +
|String
 +
|Activo
 +
|
 +
|-
 +
|String
 +
|DireccionFiscal
 +
|
 +
|-
 +
|}
 +
{{clear}}
 +
<br>
 +
 +
 +
<br>
 +
; RESPONSE: Parámetros a Recibir array DireccopmFiscal
 +
{| 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
 +
|TipoDireccion
 +
|
 +
|-
 +
|String
 +
|Ciudad
 +
|Tipo de persona de contribuyente.
 +
|-
 +
|String
 +
|CodigoDepartamento
 +
|Nombre oficial del contribuyente
 +
|-
 +
|String
 +
|Departamento
 +
|Identificador del contribuyente.
 +
|-
 +
|String
 +
|Direccion
 +
|
 +
|-
 +
|String
 +
|Lenguaje
 +
|
 +
|-
 +
|String
 +
|Municipio
 +
|
 +
|-
 +
|String
 +
|ZonaPostal
 +
|
 +
|-
 +
|String
 +
|Pais
 +
|
 +
|-
 +
|}
 +
{{clear}}
 +
<br>
 +
<center>'''Ejemplo  Response ConsultarEmpresa '''</center>
 +
[[Archivo:ConsultarEmpresa.png|800px|sinmarco|centro|ConsultarEmpresa]]
 +
<br />
 +
<br />

Revisión actual del 03:34 13 jul 2024

La API ConsultarEmpresa es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar los datos fiscales que tiene registrados 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 consultas las URL en la siguiente sección 

ConsultarEmpresas

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarEmpresa 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 corresponde a TFHKA



RESPONSE
Parámetros a Recibir al consultar el Método ConsultarEmpresa
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 Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
String idEmpresa Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
String Plataforma Nombre de la plataforma corresponde a TFHKA
String Contribuyente Representante de la empresa



RESPONSE
Parámetros a Recibir array Contribuyente
Tipo Identificador Descripción
int Tipo
String DescripciónTipo Tipo de persona de contribuyente.
String RazonSocial Nombre oficial del contribuyente
String NombreComercial Identificador del contribuyente.
String NumeroIdentificación
String NumeroIdentificaciónDV
String TipoIdentificacion
String DescripcionTipoIdentificacion
String Activo
String DireccionFiscal




RESPONSE
Parámetros a Recibir array DireccopmFiscal
Tipo Identificador Descripción
int TipoDireccion
String Ciudad Tipo de persona de contribuyente.
String CodigoDepartamento Nombre oficial del contribuyente
String Departamento Identificador del contribuyente.
String Direccion
String Lenguaje
String Municipio
String ZonaPostal
String Pais


Ejemplo Response ConsultarEmpresa
ConsultarEmpresa



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