Diferencia entre revisiones de «API ConsultarEstablecimiento»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
(Página creada con «La API '''ConsultarEstablecimiento''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente consultar los clientes que…»)
 
Línea 28: Línea 28:
 
|}
 
|}
 
<br>
 
<br>
 +
<br>
 +
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarEstablecimiento
 +
{| 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
 +
|Establecimientos
 +
|
 +
|-
 +
|}
 +
{{clear}}
 +
<br>
 +
 +
<br>
 +
; RESPONSE: Parámetros a Recibir array Establecimientos
 +
{| 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
 +
|id
 +
|
 +
|-
 +
|int
 +
|Codigo
 +
|Tipo de persona de contribuyente.
 +
|-
 +
|String
 +
|Nombre
 +
|Nombre oficial del establecimiento
 +
|-
 +
|String
 +
|Descripcion
 +
|
 +
|-
 +
|String
 +
|Tipo
 +
|
 +
|-
 +
|String
 +
|PrimerContacto
 +
|
 +
|-
 +
|String
 +
|TercerContacto
 +
|
 +
|-
 +
|String
 +
|Dirección
 +
|
 +
|-
 +
|String
 +
|Lenguaje
 +
|
 +
|-
 +
|String
 +
|Municipio
 +
|
 +
|-
 +
|String
 +
|Pais
 +
|
 +
|-
 +
|String
 +
|ZonaPostal
 +
|
 +
|-
 +
|String
 +
|Activo
 +
|
 +
|-
 +
|}
 +
{{clear}}
 +
<br>
 +
 +
 +
<br>
 +
; RESPONSE: Parámetros a Recibir array Tipo
 +
{| 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
 +
|Id
 +
|
 +
|-
 +
|int
 +
|Codigo
 +
|
 +
|-
 +
|String
 +
|Nombre
 +
|Nombre oficial
 +
|-
 +
|String
 +
|Descripcion
 +
|Identificador del contribuyente.
 +
|-
 +
|String
 +
|Direccion
 +
|
 +
|-
 +
|String
 +
|Lenguaje
 +
|
 +
|-
 +
|String
 +
|Municipio
 +
|
 +
|-
 +
|String
 +
|ZonaPostal
 +
|
 +
|-
 +
|String
 +
|Pais
 +
|
 +
|-
 +
|}
 +
{{clear}}
 +
<br>
 +
<center>'''Ejemplo  Response ConsultarEstablecimiento '''</center>
 +
[[Archivo:ConsultarEstablecimiento.png|800px|sinmarco|centro|ConsultarEstablecimiento]]
 +
<br />
 +
<br />

Revisión del 16:57 8 feb 2024

La API ConsultarEstablecimiento es 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.

@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: 

ConsultarEstablecimiento

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



RESPONSE
Parámetros a Recibir al consultar el Método ConsultarEstablecimiento
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 Establecimientos



RESPONSE
Parámetros a Recibir array Establecimientos
Tipo Identificador Descripción
int id
int Codigo Tipo de persona de contribuyente.
String Nombre Nombre oficial del establecimiento
String Descripcion
String Tipo
String PrimerContacto
String TercerContacto
String Dirección
String Lenguaje
String Municipio
String Pais
String ZonaPostal
String Activo




RESPONSE
Parámetros a Recibir array Tipo
Tipo Identificador Descripción
int Id
int Codigo
String Nombre Nombre oficial
String Descripcion Identificador del contribuyente.
String Direccion
String Lenguaje
String Municipio
String ZonaPostal
String Pais


Ejemplo Response ConsultarEstablecimiento
ConsultarEstablecimiento



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