Diferencia entre revisiones de «API ConsultarCatalogo»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
Línea 34: Línea 34:
 
|}
 
|}
 
<br>
 
<br>
 +
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarCatalogo
 +
{| 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
 +
|-
 +
|Array <Catalogos>
 +
|Catalogos
 +
|Histórico de las Catalogos con figuradas en los portales de HKA Factura existentes
 +
|-
 +
|}
 +
{{clear}}
 +
<br />

Revisión del 21:45 26 ene 2024

La API ConsultarCatalogo es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar todos los catálogos creados en el portal de factura electrónica en ambiente demo y en ambiente de producción, entre los catálogos se encuentran Clientes, Unidades de Medida Establecimiento entre otros.

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

ConsultarCatalogo


A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarCatalogo 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 Identificador Nombre del Catalogo a consultar Ejemplo: UnidadesMedida.


RESPONSE
Parámetros a Recibir al consultar el Método ConsultarCatalogo
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
Array <Catalogos> Catalogos Histórico de las Catalogos con figuradas en los portales de HKA Factura existentes