Lista de Clientes¶

Definición¶

GET https://api.avanto.mx/v2/customers

Información

Los atributos marcados con son requeridos.

Parámetros¶

Parámetro	Tipo	Default	Descripción
q	string		Consulta. Texto a buscar en customer_name (nombre del cliente) o en sic_code (RFC)
fields	string		Campo o lista de campos a obtener
expand	string		Objeto u objetos relacionados a obtener: contacts y/o subsidiaries
page	integer	1	Página de resultados a regresar
limit	string	20	Número del 1 al 20 que representa la cantidad máxima de resultados a regresar por paginación

Ejemplo¶

Petición vía cURL¶

Obtener los clientes cuyo nombre o RFC contenga "FER":

curl --request GET \
  --url 'https://api.avanto.mx/v2/customers?q=FER' \
  --header 'authorization: Bearer [Access-Token]' \

Obtener los siguientes 10 clientes a partir de la página 2:

curl --request GET \
  --url 'https://api.avanto.mx/v2/customers?page=2&limit=10' \
  --header 'authorization: Bearer [Access-Token]' \

Obtener los campos de Nombre de cliente, RFC y sucursales:

curl --request GET \
  --url 'https://api.avanto.mx/v2/customers?fields=customer_name%2Csic_code%2Csubsidiaries.subsidiary_name&expand=subsidiaries' \
  --header 'authorization: Bearer [Access-Token]' \

Ejemplo de Respuesta¶

La respuesta en formato: application/json, text/json.

[
    {
        "id": 1637,
        "receptor_type": 1,
        "fiscal_accountability": 1,
        "sic_code": "AABF800614HI0",
        "customer_name": "FELIX MANUEL ANDRADE BALLADO",
        "business_name": "",
        "email": "[email protected]",
        "phone": "-",
        "mobile": "-",
        "customer_type": "-",
        "assigned_user_id": 2,
        "email_out": 1,
        "description": "-",
        "cfdi_usocfdi": "S01",
        "cfdi_residenciafiscal": "",
        "cfdi_numregidtrib": "",
        "cfdi_regimenfiscalreceptor": "614",
        "credit_limit": "0.0000",
        "created_at": "2022-05-06 11:08:06"
    }
]