Buscar clientes por nombre o RUT

GET

/api/v1/billing/clientes/search

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.simplo.cl/api/v1/billing/clientes/search?q=example&limit=10"),
    Headers =
    {
        { "X-Api-Key", "<X-Api-Key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.simplo.cl/api/v1/billing/clientes/search?q=example&limit=10"))
    .header("X-Api-Key", "<X-Api-Key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'https://api.simplo.cl/api/v1/billing/clientes/search?q=example&limit=10';
const options = {method: 'GET', headers: {'X-Api-Key': '<X-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.simplo.cl/api/v1/billing/clientes/search?q=example&limit=10' \
  --header 'X-Api-Key: <X-Api-Key>'

Búsqueda rápida de clientes por razón social o RUT.

Autenticación

ApiKeyAuth
BearerAuth

Parámetros

Parámetros de consulta

requerido

string

Texto de búsqueda (nombre o RUT)

limit

integer

default: 10

Cantidad máxima de resultados

Respuestas

200

Resultados de búsqueda

application/json

Array<object>

object

string format: uuid

rut

string

razon_social

string

giro

string

direccion

string

comuna

string

ciudad

string

email

string

telefono

string

contacto

string

notas

string

created_at

string format: date-time

updated_at

string format: date-time

Example

[
  {
    "rut": "76543210-K",
    "razon_social": "Empresa Ejemplo SpA"
  }
]

400

Parámetro q requerido

application/json

object

code

requerido

Código de error máquina-legible

string

message

requerido

Mensaje descriptivo del error. Este es el campo canónico para clientes nuevos.

string

error

Alias de compatibilidad de message mantenido hacia atrás.

string

details

Array<object>

object

field

requerido

Campo con error (dot notation para nested)

string

code

requerido

Código de validación

string

message

requerido

Mensaje descriptivo

string

action

Acción recomendada para el cliente

string

severity

Severidad opcional del error

string

Valores permitidos: critical error warning info

context

Contexto estructurado opcional para debugging

object

key

additional properties

any

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Error de validacion en los campos enviados",
  "details": [
    {
      "field": "receptor.rut",
      "code": "INVALID_RUT",
      "message": "RUT invalido: digito verificador no coincide"
    }
  ],
  "severity": "critical"
}

401

Token o API key inválido o ausente

application/json

object

code

requerido

Código de error máquina-legible

string

message

requerido

Mensaje descriptivo del error. Este es el campo canónico para clientes nuevos.

string

error

Alias de compatibilidad de message mantenido hacia atrás.

string

details

Array<object>

object

field

requerido

Campo con error (dot notation para nested)

string

code

requerido

Código de validación

string

message

requerido

Mensaje descriptivo

string

action

Acción recomendada para el cliente

string

severity

Severidad opcional del error

string

Valores permitidos: critical error warning info

context

Contexto estructurado opcional para debugging

object

key

additional properties

any

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Error de validacion en los campos enviados",
  "details": [
    {
      "field": "receptor.rut",
      "code": "INVALID_RUT",
      "message": "RUT invalido: digito verificador no coincide"
    }
  ],
  "severity": "critical"
}