Clientes

NOTA: El resultado de los clientes puede variar dependiendo el tipo de usuario que realiza la consulta, por ejemplo si el token de autenticación pertenece a un empleado que es repartidor solamente verá los clientes de las entregas que tenga asignadas pero si el token pertenece a un vendedor verá el listado completo de clientes.

Agregar cliente

POST https://{clave}.admintotal.com/api/v2/clientes/

Headers

Name

Type

Description

Api-key

string

Toke de autenticacion

Request Body

Name

Type

Description

activo

boolean

True: activo False: inactivo

tipo_cliente

number

1: Nacional 2: Extranjero 3: Nacional Relacionado 4: Extranjero relacionadoA

razon_social

string

La razon social del cliente

codigo

string

Codigo del clienteR

referencia

string

Referencia del cliente

nombre_comercial

string

Nombre comercial del cliente

sitio_web

string

Sitio web del cliente

rfc

string

RFC del cliente

limite_credito

number

Limite de credito

direccion

object

Objeto de relacion con una direccion por ejemplo: { "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 }

dias_credito

number

Cantidad de días de límite de crédito

{
    "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
}

Obtener listado de clientes

GET https://{clave}.admintotal.com/api/v2/clientes/

Retorna listado de clientes

Query Parameters

Name

Type

Description

saldo

number

Especifica si se requieren solamente los clientes con saldo pendiente o no, los posibles valores son: 1 - Obtener clientes con saldo pendiente 0 - Obtener clientes sin saldo pendiente

string

Texto que se usará para filtrar el listado de clientes en los siguientes campos: - Razón social - Nombre comercial - RFC - Código

Headers

Name

Type

Description

Api-key

string

Token de autenticación

{
    "count": 722,
    "next": "https://{clave}.admintotal.com/api/v2/clientes/",
    "previous": null,
    "results": [
        {
            "id": 2426,
            "activo": true,
            "razon_social": "CLIENTE DE EJEMPLO",
            "codigo": null,
            "referencia": "",
            "nombre_comercial": "",
            "rfc": "...",
            "curp": null,
            "limite_credito": "0.00",
            "modificado": "2020-04-04T00:30:00.603155-07:00",
            "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": ""
            },
            "saldo_pendiente": "0"
        },
        ...
    ]
}

Obtener un cliente

GET https://{clave}.admintotal.com/api/v2/clientes/:id/

Path Parameters

Name

Type

Description

number

ID de cliente

Headers

Name

Type

Description

Api-key

string

Token de autenticación

{
    "id": 2426,
    "activo": true,
    "razon_social": "CLIENTE DE EJEMPLO",
    "codigo": null,
    "referencia": "",
    "nombre_comercial": "",
    "rfc": "...",
    "curp": null,
    "limite_credito": "0.00",
    "modificado": "2020-04-04T00:30:00.603155-07:00",
    "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": ""
    },
    "saldo_pendiente": "0"
}

Obtener direcciones de entrega de un cliente

GET https://{clave}.admintotal.com/api/v2/clientes/:id/direcciones_entrega/

Path Parameters

Name

Type

Description

integer

ID de cliente

Headers

Name

Type

Description

Api-key

string

Token de autenticación

{
    "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
            }
        },
        ...
    ]
}

Obtener contactos de un cliente

GET https://{clave}.admintotal.com/api/v2/clientes/:id/contactos/

Path Parameters

Name

Type

Description

integer

ID de cliente

Headers

Name

Type

Description

Api-key

string

Token de autenticación

Obtener clientes cercanos

GET https://{clave}.admintotal.com/api/v2/clientes/geolocalizaciones/

Query Parameters

Name

Type

Description

longitud

number

Latitud del punto de partida

latitud

number

Longitud del punto de partida

radio

number

Radio en km, valor por defecto es 10.

Headers

Name

Type

Description

Api-key

string

Token de autenticación

{
    "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
        },
        ...
    ]
}

AnteriorAnticipos de clientes SiguienteConsumo Interno

Última actualización hace 1 mes

hashtagAgregar cliente

hashtagHeaders

hashtagRequest Body

hashtagObtener listado de clientes

hashtagQuery Parameters

hashtagHeaders

hashtagObtener un cliente

hashtagPath Parameters

hashtagHeaders

hashtagObtener direcciones de entrega de un cliente

hashtagPath Parameters

hashtagHeaders

hashtagObtener contactos de un cliente

hashtagPath Parameters

hashtagHeaders

hashtagObtener clientes cercanos

hashtagQuery Parameters

hashtagHeaders

Agregar cliente

Headers

Request Body

Obtener listado de clientes

Query Parameters

Headers

Obtener un cliente

Path Parameters

Headers

Obtener direcciones de entrega de un cliente

Path Parameters

Headers

Obtener contactos de un cliente

Path Parameters

Headers

Obtener clientes cercanos

Query Parameters

Headers