Dmrodriguez2: Página creada con «La API '''ConsultarDocumento''' ofrece la capacidad de obtener una visión detallada de una transacción específica, facilitando a los integradores la verificación y validación del estado y el contenido de cualquier documento electrónico emitido. Su objetivo principal es proveer acceso granular a la información de una factura o documento en general, permitiendo un control exhaustivo sobre cada transacción. Esta funcionalidad se puede utilizar en el ambiente demo…»

2025-09-26T17:51:27Z

Página creada con «La API '''ConsultarDocumento''' ofrece la capacidad de obtener una visión detallada de una transacción específica, facilitando a los integradores la verificación y validación del estado y el contenido de cualquier documento electrónico emitido. Su objetivo principal es proveer acceso granular a la información de una factura o documento en general, permitiendo un control exhaustivo sobre cada transacción. Esta funcionalidad se puede utilizar en el ambiente demo…»

Página nueva

La API '''ConsultarDocumento''' ofrece la capacidad de obtener una visión detallada de una transacción específica, facilitando a los integradores la verificación y validación del estado y el contenido de cualquier documento electrónico emitido. Su objetivo principal es proveer acceso granular a la información de una factura o documento en general, permitiendo un control exhaustivo sobre cada transacción. Esta funcionalidad se puede utilizar en el ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api ConsultarDocumento.
 
 
'''@IMPORTANTE:''' La API ConsultarDocumento está construida en método POST. 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:'''
'''[[Tips_Urls_de_Emisión #ConsultarDocumento|ConsultarDocumento]]'''

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarDocumento y de esta forma garantizar la implementación de este nuevo método:

; REQUEST: Parámetros a Enviar
{| 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"
|-
|String
|Nit
|Número de identificación tributaria (NIT) del contribuyente emisor del documento a consultar.
|-
|rowspan="2"|String
|TokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|TokenClave
|-
|String
|ClaveSecreta
|Clave definida por el contribuyente emisor desde el usuario root en el portal HKA Factura Electrónica (aplicable tanto en ambientes de demo como de producción) para autorizar esta acción y asegurar la confidencialidad de la consulta.
|-
|Object
|Documento
|Encapsula la información de identificación del documento electrónico a consultar. Este objeto es obligatorio
|-
|}
 

Donde Object. Documento contiene la siguiente información:

; Request: Parámetros a Recibir Object Documento
{| 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"
|-
|String
|Prefijo
|Es una cadena de caracteres alfanuméricos (letras, números o una combinación) que se utiliza para clasificar y agrupar documentos dentro de un mismo tipo o serie.
|-
|String
|Correlativo
|Es el número consecutivo y único asignado a un documento dentro de un Prefijo determinado. Es una cadena numérica que identifica de forma exclusiva el documento dentro de su serie.
|-
|}
 

; RESPONSE: Parámetros a Recibir al consumir la Api ConsultarDocumento
{| 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
|Código HTTP de la respuesta. 200 para éxito, otros valores indican errores.
|-
|String
|Mensaje
|Mensaje descriptivo del resultado de la operación.
|-
|String
|Resultado
|Estado general de la operación (ej. "Exitoso", "Fallido").
|-
|String
|Nit
|Número de identificación tributaria (NIT) del contribuyente al que pertenece el documento consultado.
|-
|String
|IdEmpresa
|Identificador interno de la empresa en el sistema.
|-
|Int
|TotalDocumentos
|Número total de documentos encontrados que coinciden con la consulta
|-
|Array (Documento)
|Documentos
|Lista de objetos Documento encontrados. Cada objeto contiene el detalle completo de un documento electrónico.
|-
|Object
|Errores
|Objeto que contiene detalles de errores en caso de que la consulta no haya sido exitosa. Será null si no hay errores.
|}
{{clear}}

API ConsultarDocumento - Historial de revisiones