API EliminarCliente

De tfhkacolwiki
Revisión del 03:34 13 jul 2024 de Dmrodriguez2 (discusión | contribuciones)
(dif) ← Revisión anterior | Revisión actual (dif) | Revisión siguiente → (dif)
Ir a la navegación Ir a la búsqueda

La API EliminarCliente es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de eliminar de el catalogo de clientes algún registrados 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 EliminarCliente.

@IMPORTANTE: La Api EliminarCliente tiene es construida en método PUT. 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:

EliminarCliente

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio EliminarClientey 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 Cliente a Registrar.
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 PROXIMAMENTE
Array <Cliente> 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 va a identificar el cliente.



RESPONSE
Parámetros a Recibir al consultar el Método EliminarCliente
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 idEmpresa Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)


Ejemplo Response EliminarCliente
EliminarClientee