Diferencia entre revisiones de «API CearCliente»
Sin resumen de edición |
Sin resumen de edición |
||
| 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 | ||
|- | |- | ||
| | |Class | ||
|Cliente | |Cliente | ||
|Parámetros que conforman la clase Cliente del Objeto Factura'</u> | |Parámetros que conforman la clase Cliente del Objeto '''Factura'''</u> | ||
|} | |} | ||
<br> | <br> | ||
Donde Class.Cliente contiene la siguiente información: | |||
{| 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 | |||
|IdCliente | |||
|Código con el que se identifica el cliente. | |||
|- | |||
|String | |||
|Activo | |||
|Indica el estatus actual del cliente a actualizar | |||
|- | |||
|String | |||
|TipoPersona | |||
|Identificador de tipo de persona. El contenido de este atributo 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 5|Tabla 5]] | |||
|- | |||
|String | |||
|DescripcionTipoPersona | |||
|Indica si es Natural o Jurídica según catalogo | |||
|- | |||
|String | |||
|RazonSocial | |||
|Nombre o Razón Social del adquirente | |||
|- | |||
|String | |||
|NombreComercial | |||
|Nombre Comercial del adquiriente | |||
|- | |||
|String | |||
|Nombres | |||
|Nombre de Contacto | |||
|- | |||
|String | |||
|Apellido de Contacto | |||
|Nombre de Contacto | |||
|- | |||
|String | |||
|IdTipoIdentificacion | |||
|Id que identifica el tipo de identificación del adquiriente | |||
|- | |||
|String | |||
|TipoIdentificacion | |||
|Tipo de Identificación del adquiriente. El contenido de este atributo debe corresponder a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 3|Tabla 3]] | |||
|- | |||
|String | |||
|DescripcionTipoIdentificacion | |||
|Indica el tipo de documento del adquiriente | |||
|- | |||
|String | |||
|NumeroIdentificacion | |||
|Número del Documento o Identificación Fiscal del adquirente | |||
|- | |||
|String | |||
|NumeroIdentificacionDv | |||
|Digito de verificación NIT del adquiriente. Si tipoIdentificacion = 31. | |||
|- | |||
|String | |||
|IdRegimen | |||
|Código con el que se indica el régimen registrado. | |||
|- | |||
|String | |||
|Regimen | |||
|Régimen del adquiriente | |||
|- | |||
|String | |||
|Correo | |||
|Correo Electrónico del adquiriente que irá al XML/UBL fiscalRégimen del adquiriente | |||
|- | |||
|String | |||
|Teléfono | |||
|Teléfono del adquiriente | |||
|- | |||
|String | |||
|Fax | |||
|Telefax | |||
|- | |||
|String | |||
|Referencia | |||
|Registro de referencia del adquiriente | |||
|- | |||
|String | |||
|NombreContacto | |||
|Nombre de Contacto. | |||
|- | |||
|String | |||
|Nota | |||
| Nota adicional de contacto | |||
|- | |||
|String | |||
|Notificar | |||
| Activa el envío de email al adquirente. Valores posibles: “SI” o “NO”. | |||
|} | |||
<br> | |||
Donde Class.Cliente contiene la siguiente información: | |||
{| 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" | |||
|- | |||
|Class | |||
|DireccionCliente | |||
|Información donde se detalle la dirección de recepción del adquiriente | |||
|- | |||
|Class | |||
|DireccionFiscal | |||
|Dirección fiscal del adquiriente. | |||
|- | |||
|Class | |||
|DetallesTributarios | |||
|Detalles tributarios del adquirente | |||
|- | |||
|Class | |||
|Responsabilidades | |||
|Obligaciones y régimen del adquiriente | |||
|- | |||
|Class | |||
|ActividadesEconomicas | |||
|Corresponde a las actividades económica CIIU. | |||
|- | |||
|Class | |||
|CategoriasProducto | |||
|Corresponde al iD de la categoria a la que se desea agregar el cliente | |||
|} | |||
<br> | |||
{{clear}} | |||
<br> | <br> | ||
Revisión del 21:33 9 jun 2025
La API CrearCliente es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de crear todo el catalogo de clientes a los cuales debe realizarles algún documento electrónico, y posteriormente los podrá visualizar en el portal de HKA Factura en ambiente demo y en ambiente de producción o a realizar el consumo del servicio a través de la Api ConsultarCliente.
@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:
CrearCliente
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio CrearClientey 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 emisor. |
| 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 |
| Class | Cliente | Parámetros que conforman la clase Cliente del Objeto Factura |
Donde Class.Cliente contiene la siguiente información:
| Tipo | Identificador | Descripción |
|---|---|---|
| String | IdCliente | Código con el que se identifica el cliente. |
| String | Activo | Indica el estatus actual del cliente a actualizar |
| String | TipoPersona | Identificador de tipo de persona. El contenido de este atributo corresponde a uno de los valores de la Tabla 5 |
| String | DescripcionTipoPersona | Indica si es Natural o Jurídica según catalogo |
| String | RazonSocial | Nombre o Razón Social del adquirente |
| String | NombreComercial | Nombre Comercial del adquiriente |
| String | Nombres | Nombre de Contacto |
| String | Apellido de Contacto | Nombre de Contacto |
| String | IdTipoIdentificacion | Id que identifica el tipo de identificación del adquiriente |
| String | TipoIdentificacion | Tipo de Identificación del adquiriente. El contenido de este atributo debe corresponder a uno de los valores de la Tabla 3 |
| String | DescripcionTipoIdentificacion | Indica el tipo de documento del adquiriente |
| String | NumeroIdentificacion | Número del Documento o Identificación Fiscal del adquirente |
| String | NumeroIdentificacionDv | Digito de verificación NIT del adquiriente. Si tipoIdentificacion = 31. |
| String | IdRegimen | Código con el que se indica el régimen registrado. |
| String | Regimen | Régimen del adquiriente |
| String | Correo | Correo Electrónico del adquiriente que irá al XML/UBL fiscalRégimen del adquiriente |
| String | Teléfono | Teléfono del adquiriente |
| String | Fax | Telefax |
| String | Referencia | Registro de referencia del adquiriente |
| String | NombreContacto | Nombre de Contacto. |
| String | Nota | Nota adicional de contacto |
| String | Notificar | Activa el envío de email al adquirente. Valores posibles: “SI” o “NO”. |
Donde Class.Cliente contiene la siguiente información:
| Tipo | Identificador | Descripción |
|---|---|---|
| Class | DireccionCliente | Información donde se detalle la dirección de recepción del adquiriente |
| Class | DireccionFiscal | Dirección fiscal del adquiriente. |
| Class | DetallesTributarios | Detalles tributarios del adquirente |
| Class | Responsabilidades | Obligaciones y régimen del adquiriente |
| Class | ActividadesEconomicas | Corresponde a las actividades económica CIIU. |
| Class | CategoriasProducto | Corresponde al iD de la categoria a la que se desea agregar el cliente |
- RESPONSE
- Parámetros a Recibir al consultar el Método CrearCliente
| 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 | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |
| String | IdEmpresa | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |
| String | IdCliente | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |