Contactos Proyectos Ventas
Ventas
Las ventas de Vendomia representan las negociaciones de oportunidades de negocio en tu empresa. Una venta empieza desde el contacto de un Lead hasta que se gana y se cierra el negocio. Se utilizan para hacer un seguimiento de manera ordenada y por fases de todas las oportunidades de negocio.
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 Ventas
Devuelve un listado de elementos.
deal_id
number
ID de venta
Identificador principal y único de la venta.
deal_number
number
Número de venta
Número incremental que recibe la venta.
deal_contact
remoteselect
Contacto de la venta
ID del contacto asignado a la venta.
deal_type
select
Formato de venta
Formato de la venta. Indica si la venta posee funciones adicionales, como inmuebles asociados.
0
Simple
1
Inmobiliaria
deal_date
date
Fecha de venta
Fecha de inicio de la venta, definido por el usuario.
deal_pipeline
remoteselect
Tipo de venta
ID del tipo de venta asociado a esta venta.
deal_stage
remoteselect
Fase de venta
ID de la fase actual de la venta.
deal_status
select
Estado de venta
ID del estado actual de la venta.
0
Activa
1
Archivada
2
Ganada
3
Perdida
4
Descartada
5
Delegada
deal_price
number
Valor de la venta
Valor potencial de la venta en caso de ser ganada. Puede incluir o no impuestos.
GET https://vendomia.app/api/deals
Payload de ejemplo
{
    "deal_id": "12345",
    "deal_number": "123",
    "deal_contact": "12345",
    "deal_date": "2020-05-30",
    "deal_pipeline": "123",
    "deal_stage": "123",
    "deal_price": "234",
}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "objects": {
            "12345": {
                "deal_id": "12345",
                "deal_number": "123",
                "deal_contact": "12345",
                "deal_date": "2020-05-30",
                "deal_pipeline": "123",
                "deal_stage": "123",
                "deal_price": "234",
            }
        }
    }
}
GET Recuperar Venta
Devuelve un único elemento a través de su identificador primario.
GET https://vendomia.app/api/deals/{id}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "deal_id": "12345",
            "deal_number": "123",
            "deal_contact": "12345",
            "deal_date": "2020-05-30",
            "deal_pipeline": "123",
            "deal_stage": "123",
            "deal_price": "234",
        }
    }
}
POST Crear Venta
Crea un nuevo elemento.
deal_id
number
ID de venta
Identificador principal y único de la venta.
deal_name
text
Nombre de venta
Nombre proporcionado a la venta.
deal_description
text
Descripción de la venta
Detalles y observaciones principales sobre la venta.
deal_contact
remoteselect
Contacto de la venta
ID del contacto asignado a la venta.
deal_type
select
Formato de venta
Formato de la venta. Indica si la venta posee funciones adicionales, como inmuebles asociados.
0
Simple
1
Inmobiliaria
deal_date
date
Fecha de venta
Fecha de inicio de la venta, definido por el usuario.
deal_pipeline
remoteselect
Tipo de venta
ID del tipo de venta asociado a esta venta.
deal_price
number
Valor de la venta
Valor potencial de la venta en caso de ser ganada. Puede incluir o no impuestos.
deal_utm_origin
text
Fuente
Parámetro UTM. Indica la fuente de donde proviene esta venta (google, email...).
POST https://vendomia.app/api/deals
Payload de ejemplo
{
    "deal_id": "12345",
    "deal_name": "Oferta de negocio",
    "deal_description": "Presupuestar compra de servicio.",
    "deal_contact": "12345",
    "deal_date": "2020-05-30",
    "deal_pipeline": "123",
    "deal_price": "234",
    "deal_utm_origin": "ABC",
}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "deal_id": "12345",
            "deal_number": "123",
            "deal_contact": "12345",
            "deal_date": "2020-05-30",
            "deal_pipeline": "123",
            "deal_stage": "123",
            "deal_price": "234",
        }
    }
}
PUT Modificar Venta
Modifica un elemento existente según su identificador primario.
deal_id
number
ID de venta
Identificador principal y único de la venta.
deal_name
text
Nombre de venta
Nombre proporcionado a la venta.
deal_description
text
Descripción de la venta
Detalles y observaciones principales sobre la venta.
deal_contact
remoteselect
Contacto de la venta
ID del contacto asignado a la venta.
deal_type
select
Formato de venta
Formato de la venta. Indica si la venta posee funciones adicionales, como inmuebles asociados.
0
Simple
1
Inmobiliaria
deal_date
date
Fecha de venta
Fecha de inicio de la venta, definido por el usuario.
deal_pipeline
remoteselect
Tipo de venta
ID del tipo de venta asociado a esta venta.
deal_price
number
Valor de la venta
Valor potencial de la venta en caso de ser ganada. Puede incluir o no impuestos.
deal_utm_origin
text
Fuente
Parámetro UTM. Indica la fuente de donde proviene esta venta (google, email...).
PUT https://vendomia.app/api/deals/{id}
Payload de ejemplo
{
    "deal_id": "12345",
    "deal_name": "Oferta de negocio",
    "deal_description": "Presupuestar compra de servicio.",
    "deal_contact": "12345",
    "deal_date": "2020-05-30",
    "deal_pipeline": "123",
    "deal_price": "234",
    "deal_utm_origin": "ABC",
}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "deal_id": "12345",
            "deal_number": "123",
            "deal_contact": "12345",
            "deal_date": "2020-05-30",
            "deal_pipeline": "123",
            "deal_stage": "123",
            "deal_price": "234",
        }
    }
}
DELETE Borrar Venta
Borra un elemento existente.
DELETE https://vendomia.app/api/deals/{id}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Ganar una venta
Pasa una venta al estado Ganado.
POST https://vendomia.app/api/deals/{id}/win_deal
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Perder una venta
Marca una venta como perdida.
POST https://vendomia.app/api/deals/{id}/lose_deal
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Delegar una venta
Marca una venta como delegada.
POST https://vendomia.app/api/deals/{id}/delegate_deal
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Descartar una venta
Marca una venta como descartada.
POST https://vendomia.app/api/deals/{id}/discard_deal
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Reabrir una venta
Marca una venta como abierta.
POST https://vendomia.app/api/deals/{id}/reopen_deal
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}