Diferencia entre revisiones de «API ConsultarNumeraciones»
Línea 79: | Línea 79: | ||
|String | |String | ||
|IdNumeracion | |IdNumeracion | ||
− | |Identificador del secuencial configurado ''' | + | |Identificador del secuencial configurado. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
Línea 103: | Línea 103: | ||
|String | |String | ||
|NumeroInicial | |NumeroInicial | ||
− | |Valor desde donde se da inicio a la numeración solicitada | + | |Valor desde donde se da inicio a la numeración solicitada. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
Línea 115: | Línea 115: | ||
|String | |String | ||
|ClaveTecnica | |ClaveTecnica | ||
− | |Cadena alfanumérica establecida por la DIAN para la numeración o resolución solicitada | + | |Cadena alfanumérica establecida por la DIAN para la numeración o resolución solicitada. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
|TipoDocumento | |TipoDocumento | ||
− | |Código para Invoice, CreditNote, DebitNote | + | |Código para Invoice, CreditNote, DebitNote. 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]]. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
|IdEstablecimiento | |IdEstablecimiento | ||
− | |Identificador del establecimiento configurado por el contribuyente en el portal web ''' | + | |Identificador del establecimiento configurado por el contribuyente en el portal web. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
|CodigoEstablecimiento | |CodigoEstablecimiento | ||
− | |Código del establecimiento configurado por el contribuyente en el portal web ''' | + | |Código del establecimiento configurado por el contribuyente en el portal web. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
|DescripcionEstablecimiento | |DescripcionEstablecimiento | ||
− | |Descripción del establecimiento configurado por el contribuyente en el portal web ''' | + | |Descripción del establecimiento configurado por el contribuyente en el portal web. <u>'''Uso interno TFHKA'''</u>.. Ejemplo: Principal, Oficina |
|- | |- | ||
|String | |String | ||
|DireccionEstablecimiento | |DireccionEstablecimiento | ||
− | |Dirección del establecimiento configurado por el contribuyente en el portal web ''' | + | |Dirección del establecimiento configurado por el contribuyente en el portal web. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
|TipoServicio | |TipoServicio | ||
− | |Código que Define si el secuencial fue configurado para '''Portal''' o '''Servicio de Integración''' | + | |Código que Define si el secuencial fue configurado para '''Portal''' o '''Servicio de Integración'''. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
|Modalidad | |Modalidad | ||
− | |Código que Define si el secuencial fue configurado para '''1: Automática''' o '''2: Manual con Prefijo ''', '''3: Manual sin prefijo''', ''' | + | |Código que Define si el secuencial fue configurado para '''1: Automática''' o '''2: Manual con Prefijo ''', '''3: Manual sin prefijo''', <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
|TipoAmbienteSecuencial | |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''' | + | |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'''. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
|TestSetId | |TestSetId | ||
− | |Cadena alfanumérica establecida por la DIAN en la resolución de habilitación para realizar las pruebas solicitadas. | + | |Cadena alfanumérica establecida por la DIAN en la resolución de habilitación para realizar las pruebas solicitadas.'''Uso interno TFHKA'''. |
|- | |- | ||
|String | |String | ||
|EnvioDian | |EnvioDian | ||
− | |Código que Define si el secuencial se encuentra generando envíos directo a la DIAN | + | |Código que Define si el secuencial se encuentra generando envíos directo a la DIAN. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|String | |String | ||
|Activo | |Activo | ||
− | |Código que indica el estatus actual del secuencial en la plataforma de web''' 0: Inactivo''' o '''1: Activo''' | + | |Código que indica el estatus actual del secuencial en la plataforma de web''' 0: Inactivo''' o '''1: Activo'''. <u>'''Uso interno TFHKA'''</u>. |
|- | |- | ||
|} | |} |
Revisión del 15:58 24 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.
@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 visitar la siguiente sección:
Tips Urls de Emisió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 al consultar el Método ConsultarNumeraciones
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 | 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 |
Donde Class.Numeraciones contiene la siguiente información:
- RESPONSE
- Parámetros a Recibir Array Numeraciones
Tipo | Identificador | Descripción |
---|---|---|
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. Uso interno TFHKA. |
String | TipoDocumento | Código para Invoice, CreditNote, DebitNote. Corresponde a uno de los valores de la Tabla 1. Uso interno TFHKA. |
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.Uso interno TFHKA. |
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. |