GET api/erp/Clientes?clave={clave}&idEjecutivo={idEjecutivo}&zona={zona}&nombre={nombre}&nombreComercial={nombreComercial}&rfc={rfc}&idCliente={idCliente}&buscar={buscar}&fields={fields}&incluirPersonasRelacionadas={incluirPersonasRelacionadas}&incluirDomicilios={incluirDomicilios}
Regresa una lista con los clientes.
Si se omiten los parámetros regresa todos los clientes.
Si se incluyen parámetros, se aplican los filtros de cada parámetro indicado
Si no tiene permiso para ver clientes de otros ejecutivos, solo regresa los del ejecutivo
Información de la solicitud (Request)
Parámetros URI
| Nombre | Descripción | Tipo | Información adicional |
|---|---|---|---|
| clave |
Si se indica buscará al cliente con la clave correspondiente |
texto | |
| idEjecutivo |
Si se indica el identificador de ejecutivo se obtendrán solo clientes del ejecutivo |
GUID | |
| zona |
Si se indica buscará clientes que correspondan a dicha Zona |
texto | |
| nombre |
Si se indica un nombre buscará clientes donde corresponda dicho nombre en la razón social |
texto | |
| nombreComercial |
Si se indica un nombre buscará clientes donde corresponda dicho nombre comercial |
texto | |
| rfc |
Si se indica buscará clientes donde corresponda dicho RFC |
texto | |
| idCliente |
Si se indica obtendrá al cliente que corresponde el identificador dado. |
GUID | |
| buscar |
Si se indica buscará por Nombre, Nombre comercial, RFC y código de cliente |
texto | |
| fields |
Lista de los campos a incluir, separado por comas. |
texto | |
| incluirPersonasRelacionadas |
Indica si debe regresar la información de personas relacionadas de los clientes |
boleano |
Valor por omisión: False |
| incluirDomicilios |
Indica si debe regresar los domicilios de cada cliente |
boleano |
Valor por omisión: False |
Parámetros cuerpo (Body)
Ninguno
Respuesta
Modelo
SQL: webAPI.Clientes OverrideId: api/erp/Clientes/ClientesControllerHelper Header: Incluye la etiqueta: X-Clientes-TotalRecordCount con el número de clientes encontrados
Collección de ICliente| Nombre | Descripción | Tipo | Información adicional |
|---|---|---|---|
| idCliente | GUID | ||
| Clave | texto | ||
| RazonSocial | texto | ||
| NombreComercial | texto | ||
| RFC | texto | ||
| idEjecutivo | GUID | ||
| Zona | texto | ||
| Giro | texto | ||
| PrimerContactoFecha | fecha | ||
| PrimerContactoForma | texto | ||
| PrimerContactoReferencia | texto | ||
| Referencia | texto | ||
| URL | texto | ||
| Plazo | entero | ||
| LimiteCredito | número decimal | ||
| ListaPrecio | texto | ||
| Descuento | texto | ||
| DesglosarIEPS | boleano | ||
| TasaIVA | entero | ||
| IVAExento | boleano | ||
| Divisa | texto | ||
| Entregar | boleano | ||
| RegimenFiscal | texto | ||
| SAT_c_UsoCFDI | texto | ||
| SAT_c_Pais | texto | ||
| Observaciones | texto | ||
| PersonasRelacionadas | Collección de PersonaRelacionada | ||
| Domicilios | Collección de Domicilio |
Formatos de respuesta
application/json, text/json, application/xml, text/xml
Ejemplo no disponible.