Diferencia entre revisiones de «API ConsultarFolios»
Ir a la navegación
Ir a la búsqueda
Ejemplo Request ConsultarFolios
Ejemplo Response Folios
(Página creada con «La API '''ConsultarFolios''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar los folios, comprados,…») |
|||
| Línea 54: | Línea 54: | ||
|String | |String | ||
|Mensaje | |Mensaje | ||
| − | | | + | |Resumen de folios insertado exitosamente en la Redis Caché |
|- | |- | ||
|String | |String | ||
| Línea 64: | Línea 64: | ||
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) | |Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) | ||
|- | |- | ||
| − | | | + | |String |
| − | | | + | |Errores |
| − | | | + | |Identificador hace referencia a los errores que se puedan presentar |
|- | |- | ||
| − | | | + | |Folios<Folios> |
| − | | | + | |Folios |
| − | | | + | |Contiene al informacion referente a los proceso de carga de folios del contribuyente. |
|} | |} | ||
{{clear}} | {{clear}} | ||
| − | Donde | + | Donde Folios contiene la siguiente información: |
| − | ; RESPONSE: Parámetros a Recibir Array | + | ; RESPONSE: Parámetros a Recibir Array Folios |
{| class="mw-collapsible wikitable" | {| class="mw-collapsible wikitable" | ||
! style="background:#f2f2f2; text-align:center;"|Tipo | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
| Línea 84: | Línea 84: | ||
|- valign="center" | |- valign="center" | ||
|- | |- | ||
| − | | | + | |String |
| − | | | + | |Comprados |
| − | | | + | |Informa el valor de folios adquiridos por el contribuyente |
| + | |- | ||
| + | |String | ||
| + | |Consumidos | ||
| + | |Informa el valor de folios utilizados por el cliente | ||
| + | |- | ||
| + | |String | ||
| + | |ConsumidosValidacionPosterior | ||
| + | |Informaba el valor de folios utilizados en para validacion posterior | ||
| + | |- | ||
| + | |String | ||
| + | |Restantes | ||
| + | |Informa el valor de folios dospinibles para emision de documentos | ||
|- | |- | ||
| + | |String | ||
| + | |Fuente | ||
| + | |Informa Basede Datos | ||
|} | |} | ||
{{clear}} | {{clear}} | ||
| Línea 93: | Línea 108: | ||
<br> | <br> | ||
| − | <center>'''Ejemplo Response | + | <center>'''Ejemplo Response Folios'''</center> |
| − | [[Archivo: | + | [[Archivo:ResponseConsultarFolios.png|800px|sinmarco|centro|Response Consultar Folios]] |
<br /> | <br /> | ||
<br /> | <br /> | ||
Revisión del 15:59 8 oct 2024
La API ConsultarFolios es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar los folios, comprados, consumidos y restantes adquiridos con el servicio de The Factory HKA para el 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:
ConsultarFolios
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarFolios 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 |
- RESPONSE
- Parámetros a Recibir al consultar el Método ConsultarFolios
| 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 | Resumen de folios insertado exitosamente en la Redis Caché |
| String | Nit | Número de documento del contribuyente consultado |
| String | IdEmpresa | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |
| String | Errores | Identificador hace referencia a los errores que se puedan presentar |
| Folios<Folios> | Folios | Contiene al informacion referente a los proceso de carga de folios del contribuyente. |
Donde Folios contiene la siguiente información:
- RESPONSE
- Parámetros a Recibir Array Folios
| Tipo | Identificador | Descripción |
|---|---|---|
| String | Comprados | Informa el valor de folios adquiridos por el contribuyente |
| String | Consumidos | Informa el valor de folios utilizados por el cliente |
| String | ConsumidosValidacionPosterior | Informaba el valor de folios utilizados en para validacion posterior |
| String | Restantes | Informa el valor de folios dospinibles para emision de documentos |
| String | Fuente | Informa Basede Datos |
