Diferencia entre revisiones de «API ConsultarCatalogo»
| Línea 31: | Línea 31: | ||
|String | |String | ||
|Identificador | |Identificador | ||
| − | | | + | |Parametro Opcional corresponde al nombre del Catalogo a consultar Ejemplo: UnidadesMedida. |
|} | |} | ||
<br> | <br> | ||
| Línea 58: | Línea 58: | ||
|Histórico de las Catalogos con figuradas en los portales de HKA Factura existentes | |Histórico de las Catalogos con figuradas en los portales de HKA Factura existentes | ||
|- | |- | ||
| + | |String | ||
| + | |Array <Errores> | ||
| + | |Lista de errores en caso de error al consumo del servicio | ||
|} | |} | ||
{{clear}} | {{clear}} | ||
| + | |||
| + | |||
| + | Donde CatalogosAsociados contiene la siguiente información: | ||
| + | |||
| + | ; RESPONSE: Parámetros a Recibir Array CatalogosAsociados | ||
| + | {| 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" | ||
| + | |- | ||
| + | |Array <Catalogos> | ||
| + | |Catalogos | ||
| + | |Histórico de las Catalogos configuradas en los portales de HKA Factura existentes | ||
| + | |- | ||
| + | |String | ||
| + | |Id | ||
| + | |Corresponde a la secuencial del Objeto | ||
| + | |- | ||
| + | |String | ||
| + | |Codigo | ||
| + | |Codigo correspondiente a la descripcion del catalogo. | ||
| + | |- | ||
| + | |String | ||
| + | |Nombre | ||
| + | |Nombre del catalogo | ||
| + | |- | ||
| + | |String | ||
| + | |Descripcion | ||
| + | |Descripcion del catalogo | ||
| + | |} | ||
| + | {{clear}} | ||
| + | <br> | ||
| + | <br> | ||
<br /> | <br /> | ||
Revisión del 17:02 22 ago 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 |
| TokenClave | ||
| String | Identificador | Parametro Opcional corresponde al 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:
|
| 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 |
| String | Array <Errores> | Lista de errores en caso de error al consumo del servicio |
Donde CatalogosAsociados contiene la siguiente información:
- RESPONSE
- Parámetros a Recibir Array CatalogosAsociados
| Tipo | Identificador | Descripción |
|---|---|---|
| Array <Catalogos> | Catalogos | Histórico de las Catalogos configuradas en los portales de HKA Factura existentes |
| String | Id | Corresponde a la secuencial del Objeto |
| String | Codigo | Codigo correspondiente a la descripcion del catalogo. |
| String | Nombre | Nombre del catalogo |
| String | Descripcion | Descripcion del catalogo |
