Diferencia entre revisiones de «API CrearNumeracion»
(No se muestran 3 ediciones intermedias del mismo usuario) | |||
Línea 25: | Línea 25: | ||
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar | |rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar | ||
|- | |- | ||
− | | | + | |TokenClave |
|- | |- | ||
|String | |String | ||
Línea 31: | Línea 31: | ||
|Definida por el contribuyente emisor a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción. | |Definida por el contribuyente emisor a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción. | ||
|- | |- | ||
− | | | + | |Objeto |
|Numeraciones | |Numeraciones | ||
− | | | + | |Campos que conforman la creacion de la numeracion |
|- | |- | ||
|} | |} | ||
Línea 48: | Línea 48: | ||
|String | |String | ||
|Id | |Id | ||
− | |Identificador interno autogestionado por el Contribuyente emisor ante TFHKA | + | |Identificador interno autogestionado por el Contribuyente emisor ante TFHKA, una vez creado el secuencial el servicio de TFHKA le asignara un Id propio el cual se puede consultar al consumir la '''Api ConsultaNumeraciones'' |
|- | |- | ||
|String | |String | ||
Línea 56: | Línea 56: | ||
|String | |String | ||
|IdTipoDocumento | |IdTipoDocumento | ||
− | |Código para Invoice, CreditNote, DebitNote. Corresponde a uno de los valores de la | + | |Código para Invoice, CreditNote, DebitNote. Corresponde a uno de los valores de la tabla TipoDocumento al consultar la [[Sección para clientes de Integración - Servicio Gestión Contribuyentes#API ConsultarCatalogo|API ConsultarCatalogo]]. |
|- | |- | ||
|String | |String |
Revisión actual del 13:59 16 oct 2024
La API CrearNumeracion es un desarrollo elaborado por el equipo de The Factory HKA el cual tiene como objetivo permitir la creación de numeraciones o secuenciales para poder emitir documentos electronicos en cualquiera de nuestros ambientes demo o 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:
CrearNumeraciones
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio CrearNumeracion 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 | ClaveSecreta | Definida por el contribuyente emisor a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción. |
Objeto | Numeraciones | Campos que conforman la creacion de la numeracion |
Donde Class.Numeraciones contiene la siguiente información:
Tipo | Identificador | Descripción |
---|---|---|
String | Id | Identificador interno autogestionado por el Contribuyente emisor ante TFHKA, una vez creado el secuencial el servicio de TFHKA le asignara un Id propio el cual se puede consultar al consumir la 'Api ConsultaNumeraciones |
String | IdTipoAmbienteSecuencial | Correspondiente a los dos posibles valores: Demo y Produccion: 2 = Producción / Proceso de Habilitacion 3 = Habilitación 2.1 |
String | IdTipoDocumento | Código para Invoice, CreditNote, DebitNote. Corresponde a uno de los valores de la tabla TipoDocumento al consultar la API ConsultarCatalogo. |
String | IdTipoServicio | Correspondiente a los posibles valores: 1 = Portal / 2 = Servicio de Integración / 3 = App Móvil / 4 = Masivo (Exclusivo Nomina Electronica |
String | IdModalidad | Correspondiente a los posibles valores: 1 = Automática / 2 = Manual Con Prefijo / 3 = Manual Sin Prefijo / 4 = Manual Contingencia |
String | IdEstablecimiento | Numero identificador del secuencial que se desea consultar
@IMPORTANTE: Puede obtenerlo al consumir la Api ConsultarEstablecimiento |
String | NumeroResolucion | Numero de resolución asignado por la DIAN para esta numeraciónEn ambiente Demo deber ser autogestionada por el contribuyente |
String | FechaResolucion | Fecha en la que se solicito la resolución ante la DIAN, en formato: AAAA-MM-DD. En ambiente Demo deber ser autogestionada por el contribuyente |
String | Prefijo | Combinación de cifras alfanuméricas que establece al momento de solicitar la numeración o resolución. En ambiente Demo deber ser autogestionada por el contribuyente |
String | NumeroDesde | Valor desde donde se da inicio a la numeración solicitada. En ambiente Demo deber ser autogestionada por el contribuyente |
String | NumeroHasta | Valor hasta donde finaliza la numeración solicitada. En ambiente Demo deber ser autogestionada por el contribuyente |
String | NumeroInicial | Valor desde donde se da inicio a la numeración solicitada. En ambiente Demo deber ser autogestionada por el contribuyente |
String | FechaDesde | Fecha en la que se da inicio a la resolución solicitada ante la DIAN, en formato: AAAA-MM-DD En ambiente Demo deber ser autogestionada por el contribuyente |
String | FechaHasta | Fecha en la que finaliza la resolución solicitada ante la DIAN, en formato: AAAA-MM-DD En ambiente Demo deber ser autogestionada por el contribuyente |
String | ClaveTecnica | Cadena alfanumérica establecida por la DIAN para la numeración o resolución solicitada En ambiente Demo deber ser autogestionada por el contribuyente |
String | TestSetId | Cadena alfanumérica establecida por la DIAN en la resolución de habilitación para realizar las pruebas solicitadas. |
- RESPONSE
- Parámetros a Recibir al consultar el Método CrearNumeracion
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 a la consulta realizada, "Creacion Exitosa" o "Mensaje de error" |
String | Nit | Número de documento del contribuyente al cual se crea Numeración |
String | IdEmpresa | Identificador interno del Contribuyente emisor ante TFHKA |
String | IdNumeracion | Identificadorautogestinado por el contribuyente emisor al crear la numeracion el servicio de TFHKA asignara un nuevo ID el cual se puede obtenerlo al consumir la Api ConsultaNumeraciones |
String | Errores | Listo de errores en caso que inconsistencias en el consumo de la Api |