Diferencia entre revisiones de «API ConsultarNumeraciones»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
Línea 25: Línea 25:
 
|Nombre de la plataforma a consultar numeración TFHKA o DIAN
 
|Nombre de la plataforma a consultar numeración TFHKA o DIAN
 
|}
 
|}
−
 
+
<br>
−
; RESPONSE: Parámetros a Recibir
+
; RESPONSE: Parámetros a Recibir Consulta Plataforma TFHKA
 
{| class="mw-collapsible wikitable"  
 
{| class="mw-collapsible wikitable"  
 
! style="background:#f2f2f2; text-align:center;"|Tipo
 
! style="background:#f2f2f2; text-align:center;"|Tipo
Línea 35: Línea 35:
 
|int
 
|int
 
|Código
 
|Código
−
|Indica el Estado de la operación retornado por el servicio
+
|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
 
|-
 
|-
 
|String
 
|String
−
|Mensaje
+
|Nit
−
|Este mensaje de identificación de errores o estado de la transacción realizada
+
|Número de documento del contribuyente consultado
 
|-
 
|-
−
|Array <String>
+
|String
−
|mensajesValidacion
+
|Plataforma
−
|Mensajes de validación en caso de rechazo o aceptación de borrado del último adjunto
+
|Nombre de la plataforma a consultar numeración TFHKA o DIAN
 +
|-
 +
|Array <Numeraciones>
 +
|Numeraciones
 +
|Histórico de las numeraciones configuradas en TFHKA o asociadas en la DIAN
 
|-
 
|-
 
|String
 
|String
−
|resultado
+
|IdNumeracion
−
|Resultado
+
|Identificador del secuencial configurado '''uso interno TFHKA'''.
−
|}
+
|-
 +
|String
 +
|NumeroResolucion
 +
|Numero de resolución asignado por la DIAN para esta numeración
 +
|-
 +
|String
 +
|FechaResolucion
 +
|Fecha en la que se solicito la resolución ante la DIAN, en formato: AAAA-MM-DD
 +
|-
 +
|String
 +
|Prefijo
 +
|Combinación de cifras alfanuméricas que establece al momento de solicitar la numeración o resolución
 +
|-
 +
|String
 +
|NumeroDesde
 +
|Valor desde donde se da inicio a la numeración solicitada.
 +
|-
 +
|String
 +
|NumeroHasta
 +
|Valor hasta donde finaliza la numeración solicitada.
 +
|-
 +
|String
 +
|NumeroInicial
 +
|Valor desde donde se da inicio a la numeración solicitada, '''uso interno TFHKA'''.
 +
|-
 +
|String
 +
|FechaDesde
 +
|Fecha en la que se da inicio a la resolución solicitada ante la DIAN, en formato: AAAA-MM-DD
 +
|-
 +
|String
 +
|FechaHasta
 +
|Fecha en la que finaliza la resolución solicitada ante la DIAN, en formato: AAAA-MM-DD
 +
|-
 +
|String
 +
|ClaveTecnica
 +
|Cadena alfanumérica establecida por la DIAN para la numeración o resolución solicitada
 +
|-
 +
|String
 +
|TipoDocumento
 +
|Código para Invoice, CreditNote, DebitNote '''uso interno TFHKA'''. Corresponde a uno de los valores de la  [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 1|Tabla 1]]
 +
|-
 +
|String
 +
|IdEstablecimiento
 +
|Identificador del establecimiento configurado por el contribuyente en el portal web '''uso interno TFHKA'''.
 +
|-
 +
|String
 +
|CodigoEstablecimiento
 +
|Código del establecimiento configurado por el contribuyente en el portal web '''uso interno TFHKA'''.
 +
|-
 +
|String
 +
|DescripcionEstablecimiento
 +
|Descripción del establecimiento configurado por el contribuyente en el portal web '''uso interno TFHKA'''. Ejemplo: Principal, Oficina
 +
|-
 +
|String
 +
|DireccionEstablecimiento
 +
|Dirección del establecimiento configurado por el contribuyente en el portal web '''uso interno TFHKA'''.
 +
|-
 +
|String
 +
|TipoServicio
 +
|Código que Define si el secuencial fue configurado para '''Portal''' o '''Servicio de Integración''', '''uso interno TFHKA'''.
 +
|-
 +
|String
 +
|Modalidad
 +
|Código que Define si el secuencial fue configurado para '''1: Automática''' o '''2: Manual con Prefijo ''', '''3: Manual sin prefijo''', '''uso interno TFHKA'''.
 +
|-
 +
|String
 +
|TipoAmbienteSecuencial
 +
|Código que Define si el ambiente en el cual se configuro el secuencial en el portal de TFHKA '''2: Producción 2.1''' o '''3: Habilitación 2.1''', '''uso interno TFHKA'''.
 +
|-
 +
|String
 +
|TestSetId
 +
|Cadena alfanumérica establecida por la DIAN en la resolución de habilitación para realizar las pruebas solicitadas.
 +
|-
 +
|String
 +
|EnvioDian
 +
|Código que Define si el secuencial se encuentra generando envíos directo a la DIAN, '''uso interno TFHKA'''.
 +
|-
 +
|String
 +
|Activo
 +
|Código que indica el estatus actual del secuencial en la plataforma de web''' 0: Inactivo''' o '''1: Activo''', '''uso interno TFHKA'''.
 +
|-
 +
|}  
 
{{clear}}
 
{{clear}}
−
 
−
<br>
 

Revisión del 03:51 21 oct 2022

API ConsultarNumeraciones

La API ConsultarNumeracion es un desarrollo elaborado por el equipo de The Factory HKA el cual tiene como objetivo conocer las resoluciones que tiene cada contribuyente convalidadas en el portal de la DIAN y a su vez poder validar los secuenciales que tiene el contribuyente configurados en el portal de factura electrónica en ambiente demo y en ambiente de producción.

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarNumeracion 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 Plataforma Nombre de la plataforma a consultar numeración TFHKA o DIAN


RESPONSE
Parámetros a Recibir Consulta Plataforma TFHKA
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
String Nit Número de documento del contribuyente consultado
String Plataforma Nombre de la plataforma a consultar numeración TFHKA o DIAN
Array <Numeraciones> Numeraciones Histórico de las numeraciones configuradas en TFHKA o asociadas en la DIAN
String IdNumeracion Identificador del secuencial configurado uso interno TFHKA.
String NumeroResolucion Numero de resolución asignado por la DIAN para esta numeración
String FechaResolucion Fecha en la que se solicito la resolución ante la DIAN, en formato: AAAA-MM-DD
String Prefijo Combinación de cifras alfanuméricas que establece al momento de solicitar la numeración o resolución
String NumeroDesde Valor desde donde se da inicio a la numeración solicitada.
String NumeroHasta Valor hasta donde finaliza la numeración solicitada.
String NumeroInicial Valor desde donde se da inicio a la numeración solicitada, uso interno TFHKA.
String FechaDesde Fecha en la que se da inicio a la resolución solicitada ante la DIAN, en formato: AAAA-MM-DD
String FechaHasta Fecha en la que finaliza la resolución solicitada ante la DIAN, en formato: AAAA-MM-DD
String ClaveTecnica Cadena alfanumérica establecida por la DIAN para la numeración o resolución solicitada
String TipoDocumento Código para Invoice, CreditNote, DebitNote uso interno TFHKA. Corresponde a uno de los valores de la Tabla 1
String IdEstablecimiento Identificador del establecimiento configurado por el contribuyente en el portal web uso interno TFHKA.
String CodigoEstablecimiento Código del establecimiento configurado por el contribuyente en el portal web uso interno TFHKA.
String DescripcionEstablecimiento Descripción del establecimiento configurado por el contribuyente en el portal web uso interno TFHKA. Ejemplo: Principal, Oficina
String DireccionEstablecimiento Dirección del establecimiento configurado por el contribuyente en el portal web uso interno TFHKA.
String TipoServicio Código que Define si el secuencial fue configurado para Portal o Servicio de Integración, uso interno TFHKA.
String Modalidad Código que Define si el secuencial fue configurado para 1: Automática o 2: Manual con Prefijo , 3: Manual sin prefijo, uso interno TFHKA.
String TipoAmbienteSecuencial Código que Define si el ambiente en el cual se configuro el secuencial en el portal de TFHKA 2: Producción 2.1 o 3: Habilitación 2.1, uso interno TFHKA.
String TestSetId Cadena alfanumérica establecida por la DIAN en la resolución de habilitación para realizar las pruebas solicitadas.
String EnvioDian Código que Define si el secuencial se encuentra generando envíos directo a la DIAN, uso interno TFHKA.
String Activo Código que indica el estatus actual del secuencial en la plataforma de web 0: Inactivo o 1: Activo, uso interno TFHKA.
Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_ConsultarNumeraciones&oldid=3463»