Contactos Proyectos Ventas
Contactos
Los contactos representan todas las entidades relacionadas con la empresa, ya sean personas físicas o jurídicas. Un contacto puede representar un cliente, proveedor, prospecto, o cualquier otro ente que mantenga una relación con la empresa.
Uso general

El proceso de autenticación funciona mediante un token de acceso, que se corresponde con unos de los usuarios de tu cuenta.

El nivel de acceso del que dispones con la API dependerá del usuario con el que accedas a ella. Los permisos otorgados según el grupo del usuario a través de la aplicación serán los mismos durante el uso de la API.

Para autenticarse con la API, es necesario enviar el token a través de una cabecera Authorization en cada una de tus solicitudes:

Authorization: Bearer <API_KEY>

Solicitud de ejemplo (PHP)
$data = array(
    "key" => "value",
);

$headers = array(
    "Authorization: Bearer <API_KEY>",
    "Content-Type: application/json",
);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "<API_URL>");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET/POST/PUT/DELETE");
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($curl);
curl_close($curl);
GET Listado de Contactos
Devuelve un listado de elementos.
contact_id
text
ID
ID del contacto
contact_name
text
Nombre
Nombre del contacto
contact_billing_type
select
Tipo de contacto
0
Particular
1
Autónomo
2
Empresa
contact_billing_name
text
Razón Social
EL nombre fiscal del contacto, tanto para empresas como autónomos.
contact_billing_vat
text
NIF
El NIF del contacto, sin guiones ni espacios.
contact_billing_address
text
Dirección
La dirección del contacto, incluyendo el número y piso/puerta.
contact_billing_postal
text
Código postal
contact_billing_city
text
Ciudad
contact_billing_region
text
Provincia
contact_billing_country
text
País
contact_email
text
Email
contact_phone
text
Teléfono
contact_iban
text
Cuenta IBAN
contact_birthdate
date
Fecha de nacimiento
En formato YYYY-MM-DD.
GET https://vendomia.app/api/contacts
Payload de ejemplo
{
    "contact_id": "12345",
    "contact_name": "Mi Cliente",
    "contact_billing_type": "1",
    "contact_billing_name": "Cliente de pruebas SL",
    "contact_billing_vat": "12345678G",
    "contact_billing_address": "Calle de ejemplo 33",
    "contact_billing_postal": "03005",
    "contact_billing_city": "Madrid",
    "contact_billing_region": "123",
    "contact_email": "hola@cliente.com",
    "contact_phone": "653000000",
    "contact_iban": "ES000000000000000000",
    "contact_birthdate": "1990-12-31",
}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "objects": {
            "12345": {
                "contact_id": "12345",
                "contact_name": "Mi Cliente",
                "contact_billing_type": "1",
                "contact_billing_name": "Cliente de pruebas SL",
                "contact_billing_vat": "12345678G",
                "contact_billing_address": "Calle de ejemplo 33",
                "contact_billing_postal": "03005",
                "contact_billing_city": "Madrid",
                "contact_billing_region": "123",
                "contact_email": "hola@cliente.com",
                "contact_phone": "653000000",
                "contact_iban": "ES000000000000000000",
                "contact_birthdate": "1990-12-31",
            }
        }
    }
}
GET Recuperar Contacto
Devuelve un único elemento a través de su identificador primario.
GET https://vendomia.app/api/contacts/{id}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "contact_id": "12345",
            "contact_name": "Mi Cliente",
            "contact_billing_type": "1",
            "contact_billing_name": "Cliente de pruebas SL",
            "contact_billing_vat": "12345678G",
            "contact_billing_address": "Calle de ejemplo 33",
            "contact_billing_postal": "03005",
            "contact_billing_city": "Madrid",
            "contact_billing_region": "123",
            "contact_email": "hola@cliente.com",
            "contact_phone": "653000000",
            "contact_iban": "ES000000000000000000",
            "contact_birthdate": "1990-12-31",
        }
    }
}
POST Crear Contacto
Crea un nuevo elemento.
contact_name
text
Nombre
Nombre del contacto
contact_billing_type
select
Tipo de contacto
0
Particular
1
Autónomo
2
Empresa
contact_billing_name
text
Razón Social
EL nombre fiscal del contacto, tanto para empresas como autónomos.
contact_billing_vat
text
NIF
El NIF del contacto, sin guiones ni espacios.
contact_billing_address
text
Dirección
La dirección del contacto, incluyendo el número y piso/puerta.
contact_billing_postal
text
Código postal
contact_billing_city
text
Ciudad
contact_billing_region
text
Provincia
contact_billing_country
text
País
contact_email
text
Email
contact_phone
text
Teléfono
contact_iban
text
Cuenta IBAN
contact_birthdate
date
Fecha de nacimiento
En formato YYYY-MM-DD.
POST https://vendomia.app/api/contacts
Payload de ejemplo
{
    "contact_name": "Mi Cliente",
    "contact_billing_type": "1",
    "contact_billing_name": "Cliente de pruebas SL",
    "contact_billing_vat": "12345678G",
    "contact_billing_address": "Calle de ejemplo 33",
    "contact_billing_postal": "03005",
    "contact_billing_city": "Madrid",
    "contact_billing_region": "123",
    "contact_email": "hola@cliente.com",
    "contact_phone": "653000000",
    "contact_iban": "ES000000000000000000",
    "contact_birthdate": "1990-12-31",
}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "contact_id": "12345",
            "contact_name": "Mi Cliente",
            "contact_billing_type": "1",
            "contact_billing_name": "Cliente de pruebas SL",
            "contact_billing_vat": "12345678G",
            "contact_billing_address": "Calle de ejemplo 33",
            "contact_billing_postal": "03005",
            "contact_billing_city": "Madrid",
            "contact_billing_region": "123",
            "contact_email": "hola@cliente.com",
            "contact_phone": "653000000",
            "contact_iban": "ES000000000000000000",
            "contact_birthdate": "1990-12-31",
        }
    }
}
PUT Modificar Contacto
Modifica un elemento existente según su identificador primario.
contact_name
text
Nombre
Nombre del contacto
contact_billing_type
select
Tipo de contacto
0
Particular
1
Autónomo
2
Empresa
contact_billing_name
text
Razón Social
EL nombre fiscal del contacto, tanto para empresas como autónomos.
contact_billing_vat
text
NIF
El NIF del contacto, sin guiones ni espacios.
contact_billing_address
text
Dirección
La dirección del contacto, incluyendo el número y piso/puerta.
contact_billing_postal
text
Código postal
contact_billing_city
text
Ciudad
contact_billing_region
text
Provincia
contact_billing_country
text
País
contact_email
text
Email
contact_phone
text
Teléfono
contact_iban
text
Cuenta IBAN
contact_birthdate
date
Fecha de nacimiento
En formato YYYY-MM-DD.
PUT https://vendomia.app/api/contacts/{id}
Payload de ejemplo
{
    "contact_name": "Mi Cliente",
    "contact_billing_type": "1",
    "contact_billing_name": "Cliente de pruebas SL",
    "contact_billing_vat": "12345678G",
    "contact_billing_address": "Calle de ejemplo 33",
    "contact_billing_postal": "03005",
    "contact_billing_city": "Madrid",
    "contact_billing_region": "123",
    "contact_email": "hola@cliente.com",
    "contact_phone": "653000000",
    "contact_iban": "ES000000000000000000",
    "contact_birthdate": "1990-12-31",
}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "contact_id": "12345",
            "contact_name": "Mi Cliente",
            "contact_billing_type": "1",
            "contact_billing_name": "Cliente de pruebas SL",
            "contact_billing_vat": "12345678G",
            "contact_billing_address": "Calle de ejemplo 33",
            "contact_billing_postal": "03005",
            "contact_billing_city": "Madrid",
            "contact_billing_region": "123",
            "contact_email": "hola@cliente.com",
            "contact_phone": "653000000",
            "contact_iban": "ES000000000000000000",
            "contact_birthdate": "1990-12-31",
        }
    }
}
DELETE Borrar Contacto
Borra un elemento existente.
DELETE https://vendomia.app/api/contacts/{id}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}