> For the complete documentation index, see [llms.txt](https://developers.admintotal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.admintotal.com/api/clientes.md).

# Clientes

Permite consultar, crear y administrar la información de los clientes registrados.

{% hint style="info" %}
**NOTA:** Los clientes disponibles pueden variar dependiendo del usuario utilizado para realizar la consulta. Por ejemplo, un usuario repartidor puede visualizar únicamente los clientes relacionados con sus entregas asignadas.
{% endhint %}

## Endpoints disponibles

<table><thead><tr><th width="117.48046875">Method</th><th>Endpoint</th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>GET</strong></mark></td><td>Obtener listado de clientes<br><code>GET - https://{clave}.admintotal.com/api/v2/clientes/</code></td></tr><tr><td><mark style="color:blue;"><strong>GET</strong></mark></td><td>Obtener un cliente<br><code>https://{clave}.admintotal.com/api/v2/clientes/{id}/</code></td></tr><tr><td><mark style="color:blue;"><strong>GET</strong></mark></td><td>Obtener direcciones de entrega de un cliente<br><code>https://{clave}.admintotal.com/api/v2/clientes/:id/direcciones_entrega/</code></td></tr><tr><td><mark style="color:blue;"><strong>GET</strong></mark></td><td>Obtener contactos de un cliente<br><code>https://{clave}.admintotal.com/api/v2/clientes/:id/contactos/</code></td></tr><tr><td><mark style="color:blue;"><strong>GET</strong></mark></td><td>Obtener clientes cercanos<br><code>https://{clave}.admintotal.com/api/v2/clientes/geolocalizaciones/</code></td></tr><tr><td><mark style="color:green;"><strong>POST</strong></mark></td><td>Crear cliente<br><code>https://{clave}.admintotal.com/api/v2/clientes/</code></td></tr><tr><td><mark style="color:green;"><strong>POST</strong></mark></td><td>Actualizar contacto de cliente<br><code>https://{clave}.admintotal.com/api/v2/clientes/:id/contactos/:id</code></td></tr></tbody></table>

## Obtener listado de clientes

Obtiene el listado de clientes registrados. La consulta puede limitarse utilizando los parámetros de filtrado disponibles.

&#x20;<mark style="color:blue;">**GET**</mark> `https://{clave}.admintotal.com/api/v2/clientes/`

{% tabs %}
{% tab title="Headers" %}

| Name         | Type   | Description           |
| ------------ | ------ | --------------------- |
| Api-key      | string | Toke de autenticacion |
| {% endtab %} |        |                       |

{% tab title="Parámetros GET" %}

<table><thead><tr><th width="112.201416015625">Name</th><th width="111.9600830078125">Type</th><th>Description</th><th>Values</th></tr></thead><tbody><tr><td>saldo</td><td>number</td><td>Estado del saldo pendiente del cliente.</td><td>0: Sin saldo pendiente<br>1: Con saldo pendiente</td></tr><tr><td>q</td><td>string</td><td>Texto utilizado para buscar clientes por razón social, nombre comercial, RFC o código.</td><td>—</td></tr></tbody></table>
{% endtab %}

{% tab title="200 OK" %}

```json
{
    "count": 722,
    "next": "https://{clave}.admintotal.com/api/v2/clientes/",
    "previous": null,
    "results": [
        {
            "id": 2482,
            "activo": true,
            "tipo_cliente": 1,
            "razon_social": "CLIENTE DE EJEMPLO",
            "codigo": "",
            "referencia": "",
            "nombre_comercial": "",
            "sitio_web": null,
            "rfc": "...",
            "curp": null,
            "limite_credito": "0.00",
            "representante_legal": "",
            "direccion": {
                "id": 1241,
                "municipio": "",
                "localidad": "",
                "estado": "",
                "calle": "Uni",
                "colonia": "",
                "cp": "",
                "telefono": "",
                "email": "",
                "numero_e": "",
                "numero_i": "",
                "pais_residencia": "",
                "latitud": "0.00000000",
                "longitud": "0.00000000",
                "referencia": ""
            },
            "bloquear_vencido": true,
            "dias_cortar_credito": 0,
            "dias_credito": 0,
            "regimen_fiscal": null,
            "creado": "2026-02-10T12:00:32.592595-06:00",
            "usuario_creado": null,
            "direccion_txt": "  ",
            "almacen_precios": null,
            "clasificacion": null,
            "segmentacion": null
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

## Obtener un cliente

Obtiene la información detallada de un cliente específico.

&#x20;<mark style="color:blue;">**GET**</mark> `https://{clave}.admintotal.com/api/v2/clientes/{id}/`

{% tabs %}
{% tab title="Headers" %}

| Name         | Type   | Description           |
| ------------ | ------ | --------------------- |
| Api-key      | string | Toke de autenticacion |
| {% endtab %} |        |                       |

{% tab title="200 OK" %}
{% code overflow="wrap" %}

```json
{
    "id": 2482,
    "activo": true,
    "tipo_cliente": 1,
    "razon_social": "CLIENTE DE EJEMPLO",
    "codigo": "",
    "referencia": "",
    "nombre_comercial": "",
    "sitio_web": null,
    "rfc": "...",
    "curp": null,
    "limite_credito": "0.00",
    "representante_legal": "",
    "direccion": {
        "id": 1308,
        "municipio": "",
        "localidad": "",
        "estado": "",
        "calle": "",
        "colonia": "",
        "cp": "",
        "telefono": "",
        "email": "",
        "numero_e": "",
        "numero_i": "",
        "pais_residencia": "",
        "latitud": "0.00000000",
        "longitud": "0.00000000",
        "referencia": ""
    },
    "bloquear_vencido": true,
    "dias_cortar_credito": 0,
    "dias_credito": 0,
    "regimen_fiscal": null,
    "creado": "2026-02-10T12:00:32.592595-06:00",
    "usuario_creado": null,
    "direccion_txt": "  ",
    "almacen_precios": null,
    "clasificacion": null,
    "segmentacion": null,
    "monedero": "0"
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

### Campos principales de respuesta en cliente

<table><thead><tr><th width="191.34814453125">Name</th><th width="108.657958984375">Type</th><th width="240.794677734375">Description</th><th>Values</th></tr></thead><tbody><tr><td><code>id</code></td><td>integer</td><td>Identificador único del cliente.</td><td>—</td></tr><tr><td><code>activo</code></td><td>boolean</td><td>Indica si el cliente se encuentra activo en el sistema.</td><td><code>true</code>: Activo <br><code>false</code>: Inactivo </td></tr><tr><td><code>tipo_cliente</code></td><td>number</td><td>Tipo de cliente.</td><td>—</td></tr><tr><td><code>razon_social</code></td><td>string</td><td>Razón social o nombre fiscal del cliente.</td><td>—</td></tr><tr><td><code>codigo</code></td><td>string</td><td>Código interno utilizado para identificar al cliente.</td><td>—</td></tr><tr><td><code>referencia</code></td><td>string</td><td>Referencia adicional asociada al cliente.</td><td>—</td></tr><tr><td><code>nombre_comercial</code></td><td>string</td><td>Nombre comercial del cliente.</td><td>—</td></tr><tr><td><code>sitio_web</code></td><td>string</td><td>Sitio web del cliente.</td><td>—</td></tr><tr><td><code>rfc</code></td><td>string</td><td>RFC del cliente</td><td>—</td></tr><tr><td><code>curp</code></td><td>string</td><td>CURP del cliente.</td><td>—</td></tr><tr><td><code>limite_credito</code></td><td>number</td><td>Monto máximo de crédito autorizado para el cliente.</td><td>—</td></tr><tr><td><code>representante_legal</code></td><td>string</td><td>Representante legal del cliente.</td><td>—</td></tr><tr><td><code>direccion</code></td><td>object</td><td>Objeto de relacion con una direccion por Información del domicilio principal del cliente.</td><td>—</td></tr><tr><td><code>bloquear_vencido</code></td><td>boolean</td><td>Restringir ventas con facturas vencidas.</td><td>—</td></tr><tr><td><code>dias_cortar_credito</code></td><td>integer</td><td>Días de gracia por defecto para facturas vencidas.</td><td>—</td></tr><tr><td><code>dias_credito</code></td><td>number</td><td>Número de días de crédito otorgados al cliente.</td><td>—</td></tr><tr><td><code>regimen_fiscal</code></td><td>string</td><td>Régimen Fiscal del cliente.</td><td>—</td></tr><tr><td><code>creado</code></td><td>string</td><td>Fecha y hora en que se creó el registro.</td><td>Formato: YYYY-MM-DDTHH:mm:ss±hh:mm</td></tr><tr><td><code>usuario_creado</code></td><td>integer</td><td>Identificador único del usuario que creó al cliente.</td><td>—</td></tr><tr><td><code>direccion_txt</code></td><td>string</td><td>Direccion escrita del cliente.</td><td>—</td></tr><tr><td><code>almacen_precios</code></td><td>object</td><td>Precios por almacén del cliente.</td><td>—</td></tr><tr><td><code>clasificacion</code></td><td>object</td><td>Clasificación del cliente.</td><td>—</td></tr><tr><td><code>segmentacion</code></td><td>object</td><td>Segmentación del cliente.</td><td>—</td></tr><tr><td><code>monedero</code></td><td>decimal</td><td>Monedero disponible del cliente.</td><td>—</td></tr></tbody></table>

<details>

<summary>Dirección <mark style="color:$info;">( <code>direccion</code> )</mark></summary>

<table><thead><tr><th width="177.27685546875">Name</th><th width="129.75958251953125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>municipio</code></td><td>string</td><td>Municipio de la dirección.</td></tr><tr><td><code>localidad</code></td><td>string</td><td>Localidad de la dirección.</td></tr><tr><td><code>estado</code></td><td>string</td><td>Estado o entidad federativa.</td></tr><tr><td><code>calle</code></td><td>string</td><td>Nombre de la calle.</td></tr><tr><td><code>colonia</code></td><td>string</td><td>Colonia de la dirección.</td></tr><tr><td><code>cp</code></td><td>string</td><td>Código postal.</td></tr><tr><td><code>telefono</code></td><td>string</td><td>Número telefónico asociado a la dirección.</td></tr><tr><td><code>email</code></td><td>string</td><td>Correo electrónico asociado a la dirección.</td></tr><tr><td><code>numero_e</code></td><td>string</td><td>Número exterior.</td></tr><tr><td><code>numero_i</code></td><td>string</td><td>Número interior.</td></tr><tr><td><code>pais_residencia</code></td><td>string</td><td>Clave del país de residencia.</td></tr><tr><td><code>latitud</code></td><td>decimal</td><td>Latitud geográfica de la dirección.</td></tr><tr><td><code>longitud</code></td><td>decimal</td><td>Longitud geográfica de la dirección.</td></tr><tr><td><code>referencia</code></td><td>string</td><td>Información adicional para localizar el domicilio.</td></tr></tbody></table>

</details>

***

## Obtener direcciones de entrega de un cliente

Obtiene la dirección de entrega de un cliente específico.

&#x20;<mark style="color:blue;">**GET**</mark>  `https://{clave}.admintotal.com/api/v2/clientes/:id/direcciones_entrega/`

{% tabs %}
{% tab title="Headers" %}

| Name         | Type   | Description           |
| ------------ | ------ | --------------------- |
| Api-key      | string | Toke de autenticacion |
| {% endtab %} |        |                       |

{% tab title="200 OK" %}
{% code overflow="wrap" %}

```json
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 33,
            "nombre": "Oficina",
            "direccion": {
                "id": 482,
                "municipio": "Hermosillo",
                "localidad": "Hermosillo",
                "estado": "Sonora",
                "calle": "A la torre",
                "colonia": "Pitic",
                "cp": "83150",
                "telefono": "",
                "email": "",
                "numero_e": "xxxx",
                "numero_i": "",
                "pais_residencia": "MX",
                "latitud": "xxxx",
                "longitud": "xxxx",
                "referencia": null
            }
            "es_sucursal": false
        },
        ...
    ]
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

### Campos de respuesta para direcciones de entrega de un cliente

<table><thead><tr><th width="139.59375">Name</th><th width="100.25">Type</th><th>Description</th><th>Values</th></tr></thead><tbody><tr><td><code>id</code></td><td>integer</td><td>Identificación única de la direccion de entrega.</td><td>—</td></tr><tr><td><code>nombre</code></td><td>string</td><td>Nombre de la direccion de entrega.</td><td>—</td></tr><tr><td><code>direccion</code></td><td>object</td><td>Direccion de entrega.</td><td>—</td></tr><tr><td><code>es_sucursal</code></td><td>boolean</td><td>Indicador para saber si la dirección es un sucursal</td><td><code>true</code>: Si es una sucursal <br><code>false</code>: No es una sucursal </td></tr></tbody></table>

<details>

<summary>Dirección <mark style="color:$info;">( <code>direccion</code> )</mark></summary>

<table><thead><tr><th width="177.27685546875">Name</th><th width="129.75958251953125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>municipio</code></td><td>string</td><td>Municipio de la dirección.</td></tr><tr><td><code>localidad</code></td><td>string</td><td>Localidad de la dirección.</td></tr><tr><td><code>estado</code></td><td>string</td><td>Estado o entidad federativa.</td></tr><tr><td><code>calle</code></td><td>string</td><td>Nombre de la calle.</td></tr><tr><td><code>colonia</code></td><td>string</td><td>Colonia de la dirección.</td></tr><tr><td><code>cp</code></td><td>string</td><td>Código postal.</td></tr><tr><td><code>telefono</code></td><td>string</td><td>Número telefónico asociado a la dirección.</td></tr><tr><td><code>email</code></td><td>string</td><td>Correo electrónico asociado a la dirección.</td></tr><tr><td><code>numero_e</code></td><td>string</td><td>Número exterior.</td></tr><tr><td><code>numero_i</code></td><td>string</td><td>Número interior.</td></tr><tr><td><code>pais_residencia</code></td><td>string</td><td>Clave del país de residencia.</td></tr><tr><td><code>latitud</code></td><td>decimal</td><td>Latitud geográfica de la dirección.</td></tr><tr><td><code>longitud</code></td><td>decimal</td><td>Longitud geográfica de la dirección.</td></tr><tr><td><code>referencia</code></td><td>string</td><td>Información adicional para localizar el domicilio.</td></tr></tbody></table>

</details>

***

## Obtener contactos de un cliente

Obtiene los contactos de un cliente específico.

&#x20;<mark style="color:blue;">**GET**</mark> `https://{clave}.admintotal.com/api/v2/clientes/:id/contactos/`

{% tabs %}
{% tab title="Headers" %}

| Name         | Type   | Description           |
| ------------ | ------ | --------------------- |
| Api-key      | string | Toke de autenticacion |
| {% endtab %} |        |                       |

{% tab title="200 OK" %}
{% code overflow="wrap" %}

```json
{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 109,
            "nombre": "Contacto de Prueba",
            "celular": "",
            "telefono": "",
            "email": "",
            "puesto": "",
            "extension": "",
            "factura": true,
            "cancelacion_factura": false,
            "remision": false,
            "cotizacion_c": false,
            "cotizacion_p": false,
            "garantia_p": true,
            "orden_compra": false,
            "estado_cuenta": false,
            "auxiliar_movimientos": false,
            "auxiliar_movimientos_cxp": false,
            "devolucion": false,
            "notificaciones_pago": false,
            "sucursal": null,
            "devolucion_cxp": false,
            "recepcion_pago": false
        }
        ...
    ]
}

```

{% endcode %}
{% endtab %}
{% endtabs %}

### Campos de respuesta para contactos de un cliente

<table><thead><tr><th width="247.12109375">Name</th><th width="104.40234375">Type</th><th width="398.26953125">Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>integer</td><td>Identificador único del contacto.</td></tr><tr><td><code>nombre</code></td><td>string</td><td>Nombre del contacto.</td></tr><tr><td><code>celular</code></td><td>string</td><td>Teléfono celular del contacto.</td></tr><tr><td><code>telefono</code></td><td>string</td><td>Teléfono del contacto.</td></tr><tr><td><code>email</code></td><td>string</td><td>Correo del contacto.</td></tr><tr><td><code>puesto</code></td><td>string</td><td>Puesto del contacto</td></tr><tr><td><code>extencion</code></td><td>string</td><td>Extensión del contacto.</td></tr><tr><td><code>factura</code></td><td>boolean</td><td>Envíos de documentos: Facturas.</td></tr><tr><td><code>cancelacion_factura</code></td><td>boolean</td><td>Envíos de documentos: Cancelar facturas.</td></tr><tr><td><code>remision</code></td><td>boolean</td><td>Envíos de documentos: Remisiones.</td></tr><tr><td><code>cotizacion_c</code></td><td>boolean</td><td>Envíos de documentos: Cotizaciones de cliente.</td></tr><tr><td><code>cotizacion_p</code></td><td>boolean</td><td>Envíos de documentos: Cotizaciones de proveedor.</td></tr><tr><td><code>garantia_p</code></td><td>boolean</td><td>Envíos de documentos: Garantía proveedor.</td></tr><tr><td><code>orden_compra</code></td><td>boolean</td><td>Envíos de documentos: Órdenes de compra.</td></tr><tr><td><code>estado_cuenta</code></td><td>boolean</td><td>Envíos de documentos: Estados de cuenta.</td></tr><tr><td><code>auxiliar_movimientos</code></td><td>boolean</td><td>Envíos de documentos: Auxiliar de movimientos de clientes.</td></tr><tr><td><code>auxiliar_movimientos_cxp</code></td><td>boolean</td><td>Envíos de documentos: Auxiliar de movimientos de proveedores.</td></tr><tr><td><code>devolucion</code></td><td>boolean</td><td>Envíos de documentos: Devoluciones, Descuentos y CFDI Egresos.</td></tr><tr><td><code>notificaciones_pago</code></td><td>boolean</td><td>Envíos de documentos: Enviar notificaciones de pago.</td></tr><tr><td><code>sucursal</code></td><td>integer</td><td>Identificador único de la sucursal.</td></tr><tr><td><code>devolucion_cxp</code></td><td>boolean</td><td>Envíos de documentos: Devoluciones de proveedor.</td></tr><tr><td><code>recepcion_pago</code></td><td>boolean</td><td>Envíos de documentos: Recepción de pago.</td></tr></tbody></table>

***

## Obtener clientes cercanos

Obtiene un listado de clientes cercanos.

&#x20;<mark style="color:blue;">**GET**</mark> `https://{clave}.admintotal.com/api/v2/clientes/geolocalizaciones/`&#x20;

Ejemplo:

`https://{clave}.admintotal.com/api/v2/clientes/geolocalizaciones/`<mark style="color:orange;">`?latitud={}&longitud={}`</mark>`/`

{% tabs %}
{% tab title="Headers" %}

| Name         | Type   | Description           |
| ------------ | ------ | --------------------- |
| Api-key      | string | Toke de autenticacion |
| {% endtab %} |        |                       |

{% tab title="Parámetros GET" %}

<table><thead><tr><th width="148.03289794921875">Name</th><th width="216.1180419921875">Type</th><th>Description</th></tr></thead><tbody><tr><td>longitud</td><td>number</td><td>Latitud del punto de partida.</td></tr><tr><td>latitud</td><td>number</td><td>Longitud del punto de partida.</td></tr><tr><td>radio</td><td>number</td><td>Radio en km, el valor por defecto es 10.</td></tr></tbody></table>
{% endtab %}

{% tab title="200 OK" %}
{% code overflow="wrap" %}

```json
{
    "count": 2,
    "next": "https://{clave}.admintotal.com/api/v2/clientes/geolocalizaciones/",
    "previous": null,
    "results": [
        {
            "id": 1940,
            "rfc": "",
            "nombre_comercial": "CLIENTE DE PRUEBA",
            "razon_social": "CLIENTE DE PRUEBA S.A DE C.V",
            "direccion": {
                "id": 546,
                "municipio": "Hermosillo",
                "localidad": "Hermosillo",
                "estado": "Sonora",
                "calle": "campeche",
                "colonia": "San Benito",
                "cp": "83190",
                "telefono": "",
                "email": "",
                "numero_e": "xx",
                "numero_i": "",
                "pais_residencia": "MX",
                "latitud": "xxxx",
                "longitud": "xxxx",
                "referencia": null
            },
            "limite_credito": "10000.00",
            "saldo": 0.0
        },
        ...
    ]
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

### Campos de respuesta de clientes cercanos

<table><thead><tr><th width="193.0390625">Name</th><th width="114.796875">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>integer</td><td>Identificador único del cliente.</td></tr><tr><td><code>rfc</code></td><td>string</td><td>RFC del cliente.</td></tr><tr><td><code>nombre_comercial</code></td><td>string</td><td>Nombre comercial del cliente.</td></tr><tr><td><code>razon_social</code></td><td>string</td><td>Razón social del cliente.</td></tr><tr><td><code>direccion</code></td><td>object</td><td>Dirección del cliente.</td></tr><tr><td><code>limite_credito</code></td><td>decimal</td><td>Límite de crédito del cliente.</td></tr><tr><td><code>saldo</code></td><td>decimal</td><td>Saldo del cliente.</td></tr></tbody></table>

<details>

<summary>Dirección <mark style="color:$info;">( <code>direccion</code> )</mark></summary>

<table><thead><tr><th width="177.27685546875">Name</th><th width="129.75958251953125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>municipio</code></td><td>string</td><td>Municipio de la dirección.</td></tr><tr><td><code>localidad</code></td><td>string</td><td>Localidad de la dirección.</td></tr><tr><td><code>estado</code></td><td>string</td><td>Estado o entidad federativa.</td></tr><tr><td><code>calle</code></td><td>string</td><td>Nombre de la calle.</td></tr><tr><td><code>colonia</code></td><td>string</td><td>Colonia de la dirección.</td></tr><tr><td><code>cp</code></td><td>string</td><td>Código postal.</td></tr><tr><td><code>telefono</code></td><td>string</td><td>Número telefónico asociado a la dirección.</td></tr><tr><td><code>email</code></td><td>string</td><td>Correo electrónico asociado a la dirección.</td></tr><tr><td><code>numero_e</code></td><td>string</td><td>Número exterior.</td></tr><tr><td><code>numero_i</code></td><td>string</td><td>Número interior.</td></tr><tr><td><code>pais_residencia</code></td><td>string</td><td>Clave del país de residencia.</td></tr><tr><td><code>latitud</code></td><td>decimal</td><td>Latitud geográfica de la dirección.</td></tr><tr><td><code>longitud</code></td><td>decimal</td><td>Longitud geográfica de la dirección.</td></tr><tr><td><code>referencia</code></td><td>string</td><td>Información adicional para localizar el domicilio.</td></tr></tbody></table>

</details>

***

## Crear cliente

Crea un nuevo cliente.

&#x20;<mark style="color:green;">**POST**</mark>  `https://{clave}.admintotal.com/api/v2/clientes/`&#x20;

### Request Body

{% tabs %}
{% tab title="Headers" %}

| Name         | Type   | Description           |
| ------------ | ------ | --------------------- |
| Api-key      | string | Toke de autenticacion |
| {% endtab %} |        |                       |

{% tab title="Ejemplo Body" %}
{% code overflow="wrap" %}

```json
{
    "activo": false,
    "tipo_cliente": null,
    "razon_social": "",
    "codigo": "",
    "referencia": "",
    "nombre_comercial": "",
    "sitio_web": "",
    "rfc": "",
    "curp": "",
    "limite_credito": null,
    "representante_legal": "",
    "direccion": {
        "municipio": "",
        "localidad": "",
        "estado": "",
        "calle": "",
        "colonia": "",
        "cp": "",
        "telefono": "",
        "email": "",
        "numero_e": "",
        "numero_i": "",
        "pais_residencia": "",
        "latitud": null,
        "longitud": null,
        "referencia": ""
    },
    "bloquear_vencido": false,
    "dias_cortar_credito": null,
    "dias_credito": null,
    "regimen_fiscal": null,
    "usuario_creado": null
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

### Campos de Request Body

<table><thead><tr><th width="208.30517578125">Name</th><th width="90.385498046875">Type</th><th width="107.4912109375">Required</th><th width="204.515380859375">Description</th><th width="145.3984375"></th></tr></thead><tbody><tr><td><code>activo</code></td><td>boolean</td><td>No</td><td>Indica si el cliente se encuentra activo en el sistema.</td><td><code>true</code>: Activo <br><code>false</code>: Inactivo</td></tr><tr><td><code>tipo_cliente</code></td><td>number</td><td>Si</td><td>Tipo de cliente.</td><td>—</td></tr><tr><td><code>razon_social</code></td><td>string</td><td>Si</td><td>Razón social o nombre fiscal del cliente.</td><td>—</td></tr><tr><td><code>codigo</code></td><td>string</td><td>No</td><td>Código interno utilizado para identificar al cliente.</td><td>—</td></tr><tr><td><code>referencia</code></td><td>string</td><td>No</td><td>Referencia adicional asociada al cliente.</td><td>—</td></tr><tr><td><code>nombre_comercial</code></td><td>string</td><td>No</td><td>Nombre comercial del cliente.</td><td>—</td></tr><tr><td><code>sitio_web</code></td><td>string</td><td>No</td><td>Sitio web del cliente.</td><td>—</td></tr><tr><td><code>rfc</code></td><td>string</td><td>No</td><td>RFC del cliente</td><td>—</td></tr><tr><td><code>curp</code></td><td>string</td><td>No</td><td>CURP del cliente.</td><td>—</td></tr><tr><td><code>limite_credito</code></td><td>number</td><td>Si</td><td>Monto máximo de crédito autorizado para el cliente.</td><td>—</td></tr><tr><td><code>representante_legal</code></td><td>string</td><td>No</td><td>Representante legal del cliente.</td><td>—</td></tr><tr><td><code>direccion</code></td><td>object</td><td>Si</td><td>Objeto de relacion con una direccion por Información del domicilio principal del cliente.</td><td>—</td></tr><tr><td><code>bloquear_vencido</code></td><td>boolean</td><td>No</td><td>Restringir ventas con facturas vencidas.</td><td>—</td></tr><tr><td><code>dias_cortar_credito</code></td><td>integer</td><td>Si</td><td>Días de gracia por defecto para facturas vencidas.</td><td>—</td></tr><tr><td><code>dias_credito</code></td><td>number</td><td>No</td><td>Número de días de crédito otorgados al cliente.</td><td>—</td></tr><tr><td><code>regimen_fiscal</code></td><td>string</td><td>No</td><td>Régimen Fiscal del cliente.</td><td>—</td></tr><tr><td><code>usuario_creado</code></td><td>integer</td><td>No</td><td>Identificador único del usuario que creó al cliente.</td><td>—</td></tr></tbody></table>

<details>

<summary>Tipos de cliente <mark style="color:$info;">( <code>tipo_cliente</code> )</mark></summary>

| Value | Description            |
| ----- | ---------------------- |
| `1`   | Nacional               |
| `2`   | Extranjero             |
| `3`   | Nacional relacionado   |
| `4`   | Extranjero relacionado |

</details>

<details>

<summary>Dirección <mark style="color:$info;">( <code>direccion</code> )</mark></summary>

<table><thead><tr><th width="177.27685546875">Name</th><th width="129.75958251953125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>municipio</code></td><td>string</td><td>Municipio de la dirección.</td></tr><tr><td><code>localidad</code></td><td>string</td><td>Localidad de la dirección.</td></tr><tr><td><code>estado</code></td><td>string</td><td>Estado o entidad federativa.</td></tr><tr><td><code>calle</code></td><td>string</td><td>Nombre de la calle.</td></tr><tr><td><code>colonia</code></td><td>string</td><td>Colonia de la dirección.</td></tr><tr><td><code>cp</code></td><td>string</td><td>Código postal.</td></tr><tr><td><code>telefono</code></td><td>string</td><td>Número telefónico asociado a la dirección.</td></tr><tr><td><code>email</code></td><td>string</td><td>Correo electrónico asociado a la dirección.</td></tr><tr><td><code>numero_e</code></td><td>string</td><td>Número exterior.</td></tr><tr><td><code>numero_i</code></td><td>string</td><td>Número interior.</td></tr><tr><td><code>pais_residencia</code></td><td>string</td><td>Clave del país de residencia.</td></tr><tr><td><code>latitud</code></td><td>decimal</td><td>Latitud geográfica de la dirección.</td></tr><tr><td><code>longitud</code></td><td>decimal</td><td>Longitud geográfica de la dirección.</td></tr><tr><td><code>referencia</code></td><td>string</td><td>Información adicional para localizar el domicilio.</td></tr></tbody></table>

</details>

### Respuesta 201 Created

{% tabs %}
{% tab title="201 Created" %}

```json
{
    "id": 1940,
    "rfc": "",
    "nombre_comercial": "CLIENTE DE PRUEBA",
    "razon_social": "CLIENTE DE PRUEBA S.A DE C.V",
    "direccion": {
        "id": 546,
        "municipio": "Hermosillo",
        "localidad": "Hermosillo",
        "estado": "Sonora",
        "calle": "campeche",
        "colonia": "San Benito",
        "cp": "83190",
        "telefono": "",
        "email": "",
        "numero_e": "xx",
        "numero_i": "",
        "pais_residencia": "MX",
        "latitud": "xxxx",
        "longitud": "xxxx",
        "referencia": null
    },
    "limite_credito": "10000.00",
    "saldo": 0.0
}
```

{% endtab %}
{% endtabs %}

### Campos de respuesta 201 Created

<table><thead><tr><th width="164.28125">Name</th><th width="99.359375">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>integer</td><td>Identificador único del cliente.</td></tr><tr><td>rfc</td><td>string</td><td>RFC del cliente.</td></tr><tr><td>nombre_comercial</td><td>string</td><td>Nombre comercial del cliente.</td></tr><tr><td>razon_social</td><td>string</td><td>Razón social o nombre fiscal del cliente.</td></tr><tr><td>direccion</td><td>object</td><td>Objeto de la dirección del cliente.</td></tr><tr><td>limite_credito</td><td>number</td><td>Monto máximo de crédito autorizado para el cliente.</td></tr><tr><td>saldo</td><td>decimal</td><td>Saldo en monedero del cliente.</td></tr></tbody></table>

<details>

<summary>Dirección <mark style="color:$info;">( <code>direccion</code> )</mark></summary>

<table><thead><tr><th width="177.27685546875">Name</th><th width="129.75958251953125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>municipio</code></td><td>string</td><td>Municipio de la dirección.</td></tr><tr><td><code>localidad</code></td><td>string</td><td>Localidad de la dirección.</td></tr><tr><td><code>estado</code></td><td>string</td><td>Estado o entidad federativa.</td></tr><tr><td><code>calle</code></td><td>string</td><td>Nombre de la calle.</td></tr><tr><td><code>colonia</code></td><td>string</td><td>Colonia de la dirección.</td></tr><tr><td><code>cp</code></td><td>string</td><td>Código postal.</td></tr><tr><td><code>telefono</code></td><td>string</td><td>Número telefónico asociado a la dirección.</td></tr><tr><td><code>email</code></td><td>string</td><td>Correo electrónico asociado a la dirección.</td></tr><tr><td><code>numero_e</code></td><td>string</td><td>Número exterior.</td></tr><tr><td><code>numero_i</code></td><td>string</td><td>Número interior.</td></tr><tr><td><code>pais_residencia</code></td><td>string</td><td>Clave del país de residencia.</td></tr><tr><td><code>latitud</code></td><td>decimal</td><td>Latitud geográfica de la dirección.</td></tr><tr><td><code>longitud</code></td><td>decimal</td><td>Longitud geográfica de la dirección.</td></tr><tr><td><code>referencia</code></td><td>string</td><td>Información adicional para localizar el domicilio.</td></tr></tbody></table>

</details>

***

## Actualizar contacto de cliente

Editar un contacto especifico de un cliente.

&#x20;<mark style="color:green;">**POST**</mark> `https://{clave}.admintotal.com/api/v2/clientes/`<mark style="color:orange;">`{cliente_id}`</mark>`/contactos/`<mark style="color:orange;">`{contacto_id}`</mark> `/`

Ejemplo: \
`https://{clave}.admintotal.com/api/v2/clientes/`<mark style="color:orange;">`1`</mark>`/contactos/`<mark style="color:orange;">`1`</mark>`/`

### Request Body

{% tabs %}
{% tab title="Headers" %}

| Name         | Type   | Description           |
| ------------ | ------ | --------------------- |
| Api-key      | string | Toke de autenticacion |
| {% endtab %} |        |                       |

{% tab title="Ejemplo Body" %}
{% code overflow="wrap" %}

```json
{
    "id": 109,
    "nombre": "Contacto de Prueba",
    "celular": "",
    "telefono": "",
    "email": "",
    "puesto": "",
    "extension": "",
    "factura": true,
    "cancelacion_factura": false,
    "remision": false,
    "cotizacion_c": false,
    "cotizacion_p": false,
    "garantia_p": true,
    "orden_compra": false,
    "estado_cuenta": false,
    "auxiliar_movimientos": false,
    "auxiliar_movimientos_cxp": false,
    "devolucion": false,
    "notificaciones_pago": false,
    "sucursal": null,
    "devolucion_cxp": false,
    "recepcion_pago": false
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

### Respuesta 201 Created

{% tabs %}
{% tab title="201 Created" %}

```json
{
    "nombre": "Juan Pérez",
    "celular": "6623070707",
    "telefono": "",
    "email": "juanperez@admintotal.com",
    "puesto": "",
    "extension": "",
    "factura": false,
    "cancelacion_factura": false,
    "remision": false,
    "cotizacion_c": false,
    "cotizacion_p": false,
    "garantia_p": false,
    "orden_compra": false,
    "estado_cuenta": false,
    "auxiliar_movimientos": false,
    "auxiliar_movimientos_cxp": false,
    "devolucion": false,
    "notificaciones_pago": false,
    "sucursal": null,
    "devolucion_cxp": false,
    "recepcion_pago": false
}
```

{% endtab %}
{% endtabs %}

### Campos para crear y de respuesta para actualizar contacto

<table><thead><tr><th width="247.12109375">Name</th><th width="104.40234375">Type</th><th width="398.26953125">Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>integer</td><td>Identificador único del contacto.</td></tr><tr><td><code>nombre</code></td><td>string</td><td>Nombre del contacto.</td></tr><tr><td><code>celular</code></td><td>string</td><td>Teléfono celular del contacto.</td></tr><tr><td><code>telefono</code></td><td>string</td><td>Teléfono del contacto.</td></tr><tr><td><code>email</code></td><td>string</td><td>Correo del contacto.</td></tr><tr><td><code>puesto</code></td><td>string</td><td>Puesto del contacto</td></tr><tr><td><code>extencion</code></td><td>string</td><td>Extensión del contacto.</td></tr><tr><td><code>factura</code></td><td>boolean</td><td>Envíos de documentos: Facturas.</td></tr><tr><td><code>cancelacion_factura</code></td><td>boolean</td><td>Envíos de documentos: Cancelar facturas.</td></tr><tr><td><code>remision</code></td><td>boolean</td><td>Envíos de documentos: Remisiones.</td></tr><tr><td><code>cotizacion_c</code></td><td>boolean</td><td>Envíos de documentos: Cotizaciones de cliente.</td></tr><tr><td><code>cotizacion_p</code></td><td>boolean</td><td>Envíos de documentos: Cotizaciones de proveedor.</td></tr><tr><td><code>garantia_p</code></td><td>boolean</td><td>Envíos de documentos: Garantía proveedor.</td></tr><tr><td><code>orden_compra</code></td><td>boolean</td><td>Envíos de documentos: Órdenes de compra.</td></tr><tr><td><code>estado_cuenta</code></td><td>boolean</td><td>Envíos de documentos: Estados de cuenta.</td></tr><tr><td><code>auxiliar_movimientos</code></td><td>boolean</td><td>Envíos de documentos: Auxiliar de movimientos de clientes.</td></tr><tr><td><code>auxiliar_movimientos_cxp</code></td><td>boolean</td><td>Envíos de documentos: Auxiliar de movimientos de proveedores.</td></tr><tr><td><code>devolucion</code></td><td>boolean</td><td>Envíos de documentos: Devoluciones, Descuentos y CFDI Egresos.</td></tr><tr><td><code>notificaciones_pago</code></td><td>boolean</td><td>Envíos de documentos: Enviar notificaciones de pago.</td></tr><tr><td><code>sucursal</code></td><td>integer</td><td>Identificador único de la sucursal.</td></tr><tr><td><code>devolucion_cxp</code></td><td>boolean</td><td>Envíos de documentos: Devoluciones de proveedor.</td></tr><tr><td><code>recepcion_pago</code></td><td>boolean</td><td>Envíos de documentos: Recepción de pago.</td></tr></tbody></table>

## Errores HTTP

Posibles códigos de error que puedes encontrar al consumir este recurso.

<table><thead><tr><th width="170.59765625"></th><th width="128.9375"></th><th width="215.58984375"></th><th></th></tr></thead><tbody><tr><td><h4><mark style="color:$warning;"><code>400</code></mark> </h4><p>Solicitud invalida</p></td><td><h4><mark style="color:$danger;"><code>403</code></mark> </h4><p>Sin permiso</p></td><td><h4><mark style="color:$danger;"><code>404</code></mark><br></h4><p>Registro no encontrado</p></td><td><h4><mark style="color:$danger;"><code>500</code></mark> </h4><p>Error interno del servidor</p></td></tr></tbody></table>