Clientes

Un Cliente es un consumidor del producto o servicio que ofrece tu organización y por lo tanto estará asociado a tu facturación.

Probar desde el explorador de API

Buscar clientes

GET https://api.peakly.co/api/Ventas/Clientes/Page

Busca todos los Clientes que estén activos (no hayan sido eliminados), que coincidan con el criterio de búsqueda en el campo where. El campo rows indica la cantidad de registros por pagina y el campo page la pagina recuperar. La respuesta devuelve la cantidad de registros totales y la cantidad de paginas.

Query Parameters

Name	Type	Description
where	string	Texto a buscar
page	number	Número de página
rows	number	Tamaño de página

200 Clientes recuperados

{
  "totalPages": 1,
  "page": 1,
  "totalRecords": 1,
  "userdata": null,
  "records":[
    {
      "id": 16207,
      "activo": true,
      "razonSocial": "Consumidor Final sin identificar",
      "domicilio": null,
      "codigoPostal": null,
      "localidad": null,
      "localizacion_id": null,
      "localizacion_value": null,
      "telefono": null,
      "email": null,
      "categoriaIva_id": 8,
      "categoriaIva_value": "Consumidor Final",
      "cuit": null,
      "condicionVenta_id": 10,
      "condicionVenta_value": "Contado",
      "master_id": null,
      "master_nombre": null,
      "tipoDocumento_id": 182,
      "observaciones": null
    }
  ]
}

Buscar cliente por id

GET https://api.peakly.co/api/Ventas/Clientes/:id

Busca el cliente por el identificador enviado como parametro.

Path Parameters

Name	Type	Description
id	number	Identificador del cliente

200 Cliente encontrado

{
  "id": 140,
  "activo": true,
  "razonSocial": "Mi nuevo cliente",
  "domicilio": "Av. Santa Fe 1234",
  "codigoPostal": "1400",
  "localidad": "Palermo",
  "localizacion_id": 2,
  "localizacion_value": "Buenos Aires",
  "telefono": "string",
  "email": null,
  "categoriaIva_id": 1,
  "categoriaIva_value": "Responsable Inscripto",
  "cuit": "20-35961444-7",
  "condicionVenta_id": 13,
  "condicionVenta_value": "30 Dias",
  "master_id": null,
  "master_nombre": null,
  "tipoDocumento_id": 180,
  "observaciones": "Observaciones sobre cliente"
}

404 Cliente no encontrado

Crear Cliente

POST https://api.peakly.co/api/Ventas/Clientes

Crea el Cliente enviado en el body Para los valores de Localizacion_id y Localizacion_value utilizar el endpoint de información de Localizaciones. Para los valores de CategoriaIVA_id y CategoriaIVA_value utilizar el endpoint de información de Categorías. Para los valores de CondicionVenta_id y CondicionVenta_value utilizar el endpoint de información de ComboItems, el combo CondicionCompraVenta.

Request Body

Name	Type	Description
tipoDocumento_id	number	Tipo de documento
cuit	string	CUIT / DNI, documento legal
razonSocial	string	Razón Social / Nombre legal
domicilio	string	Domicilio, dirección principal
localidad	string	Localidad, dirección principal
codigoPostal	string	Código postal, dirección principal
telefono	string	Telefono principal
email	string	Email del cliente. Pueden ser multiples separados por ;
condicionVenta_id	number	Condición de Venta, id
condicionVenta_value	string	Condición de Venta, valor
localizacion_id	number	Localización, id
localizacion_value	string	Localización, valor
categoriaIVA_id	number	Categoria de IVA, id
categoriaIVA_value	string	Categoria de IVA, valor

200 Cliente creado correctamente

{
  "id": 140,
  "activo": true,
  "razonSocial": "Mi nuevo cliente",
  "domicilio": "Av. Santa Fe 1234",
  "codigoPostal": "1400",
  "localidad": "Palermo",
  "localizacion_id": 2,
  "localizacion_value": "Buenos Aires",
  "telefono": "string",
  "email": null,
  "categoriaIva_id": 1,
  "categoriaIva_value": "Responsable Inscripto",
  "cuit": "20-35961444-7",
  "condicionVenta_id": 13,
  "condicionVenta_value": "30 Dias",
  "master_id": null,
  "master_nombre": null,
  "tipoDocumento_id": 180,
  "observaciones": "Observaciones sobre cliente"
}

400 Algún campo es invalido

404 No se encontró algún dato relacionado.

Crear cliente

POST https://api.peakly.co/api/Ventas/Clientes/CUIT/:cuit

Crea si no existe en base al CUIT enviado, solo soporta el envío de CUIT cualquier otro documento no se reconocerá. Se cargaran los datos traídos desde AFIP para la creación del cliente y luego podrá ser personalizado realizando actualizaciones.

Path Parameters

Name	Type	Description
cuit	string	CUIT del contribuyente

200 Cliente creado correctamente

{
  "id": 140,
  "activo": true,
  "razonSocial": "Mi nuevo cliente",
  "domicilio": "Av. Santa Fe 1234",
  "codigoPostal": "1400",
  "localidad": "Palermo",
  "localizacion_id": 2,
  "localizacion_value": "Buenos Aires",
  "telefono": "string",
  "email": null,
  "categoriaIva_id": 1,
  "categoriaIva_value": "Responsable Inscripto",
  "cuit": "20-35961444-7",
  "condicionVenta_id": 13,
  "condicionVenta_value": "30 Dias",
  "master_id": null,
  "master_nombre": null,
  "tipoDocumento_id": 180,
  "observaciones": "Observaciones sobre cliente"
}

404 CUIT no encontrado en AFIP

Actualizar cliente

PUT https://api.peakly.co/api/Ventas/Clientes

Actualiza el Cliente enviado en el body Para los valores de Localizacion_id y Localizacion_value utilizar el endpoint de información de Localizaciones. Para los valores de CategoriaIVA_id y CategoriaIVA_value utilizar el endpoint de información de Categorías. Para los valores de CondicionVenta_id y CondicionVenta_value utilizar el endpoint de información de ComboItems, el combo CondicionCompraVenta.

Path Parameters

Name	Type	Description
	string

200

Eliminar cliente

DELETE https://api.peakly.co/api/Ventas/Clientes/{id}

Elimina el cliente indicado por id en la solicitud. El borrado es lógico por lo cual se puede recuperar en caso de haber sido borrado.

Path Parameters

Name	Type	Description
id	number	Cliente Id

200 Cliente eliminado correctamente