Diferencia entre revisiones de «API ConsultarCatalogoAsociado»
Línea 30: | Línea 30: | ||
|- | |- | ||
|String | |String | ||
− | | | + | |Plataforma |
|Este parámetro es Opcional, si este es enviado corresponde al nombre TFHKA. | |Este parámetro es Opcional, si este es enviado corresponde al nombre TFHKA. | ||
|- | |- |
Revisión del 16:45 22 ago 2024
La API ConsultarCatalogoAsociado es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar todos los catálogos asociados a los CatalogoFacturacion en el portal de factura electrónica en ambiente demo y en ambiente de producción, en el momento solo se encuentra la posibilidad de visualizar el catalogo de unidadesMedidas, proximamente se ilustraran más catalogos.
@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:
ConsultarCatalogoAsociado
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarCatalogoAsociado 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 | Este parámetro es Opcional, si este es enviado corresponde al nombre TFHKA. |
String | Identificador | Este parámetro es Opcional, corresponde al nombre del catalogo que desea consultar. |
- RESPONSE
- Parámetros a Recibir al consultar el Método ConsultarCatalogoAsociado
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 |
String | Nit | Número de documento del contribuyente consultado |
String | IdEmpresa | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |
Array <CatalogosAsociados> | CatalogosAsociados | Histórico de las CatalogosAsociados configuradas en TFHKA para los diferentes Catalogos 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 |