Documentación API

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 Presupuestos

Devuelve un listado de elementos.

estimate_contact

remoteselect

Contacto

ID del contacto asociado al presupuesto.

estimate_status

select

Estado

ID del estado asociado al presupuesto.

0

Borrador

1

Pendiente

2

Aceptado

3

Rechazado

4

Cancelado

limit

integer

limit

Indica el número máximo de resultados a devolver. Máximo de 24 resultados.

offset

integer

offset

Indica el número de resultados a omitir, a fin de paginar los resultados. Por ejemplo, indicar 100 para comenzar a partir del resultado 101.

GET https://vendomia.app/api/estimates

Payload de ejemplo

{
    "estimate_contact": "12345",
    "estimate_status": "1",
    "limit": "24",
    "offset": "0",
}

Respuesta de ejemplo

{
    "status": 200,
    "message": "OK.",
    "body": {
        "objects": {
            "12345": {
                "estimate_contact": "12345",
                "estimate_status": "1",
            }
        }
    }
}

GET Recuperar Presupuesto

Devuelve un único elemento a través de su identificador primario.

GET https://vendomia.app/api/estimates/{id}

Respuesta de ejemplo

{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "estimate_contact": "12345",
            "estimate_status": "1",
        }
    }
}

POST Crear Presupuesto

Crea un nuevo elemento.

estimate_series

remoteselect

Serie

Serie del presupuesto, basado en las series de facturación. La identidad se calcula a partir de la serie seleccionada.

estimate_contact

remoteselect

Contacto

ID del contacto asociado al presupuesto.

estimate_billing_name

text

Razón social

Razón social del contacto.

estimate_billing_vat

text

NIF

NIF del contacto.

estimate_billing_address

text

Dirección

Dirección del contacto.

estimate_billing_postal

text

Código postal

Código postal del contacto.

estimate_billing_city

text

Ciudad

Ciudad del contacto.

estimate_date

date

Fecha

Fecha del presupuesto.

POST https://vendomia.app/api/estimates

Payload de ejemplo

{
    "estimate_series": "123",
    "estimate_contact": "12345",
    "estimate_billing_name": "Mi cliente SL",
    "estimate_billing_vat": "B1234567890",
    "estimate_billing_address": "Calle Huertas 25",
    "estimate_billing_postal": "03007",
    "estimate_billing_city": "Madrid",
    "estimate_date": "Madrid",
}

Respuesta de ejemplo

{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "estimate_contact": "12345",
            "estimate_status": "1",
        }
    }
}

PUT Modificar Presupuesto

Modifica un elemento existente según su identificador primario.

estimate_series

remoteselect

Serie

Serie del presupuesto, basado en las series de facturación. La identidad se calcula a partir de la serie seleccionada.

estimate_contact

remoteselect

Contacto

ID del contacto asociado al presupuesto.

estimate_billing_name

text

Razón social

Razón social del contacto.

estimate_billing_vat

text

NIF

NIF del contacto.

estimate_billing_address

text

Dirección

Dirección del contacto.

estimate_billing_postal

text

Código postal

Código postal del contacto.

estimate_billing_city

text

Ciudad

Ciudad del contacto.

estimate_date

date

Fecha

Fecha del presupuesto.

PUT https://vendomia.app/api/estimates/{id}

Payload de ejemplo

{
    "estimate_series": "123",
    "estimate_contact": "12345",
    "estimate_billing_name": "Mi cliente SL",
    "estimate_billing_vat": "B1234567890",
    "estimate_billing_address": "Calle Huertas 25",
    "estimate_billing_postal": "03007",
    "estimate_billing_city": "Madrid",
    "estimate_date": "Madrid",
}

Respuesta de ejemplo

{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "estimate_contact": "12345",
            "estimate_status": "1",
        }
    }
}

DELETE Borrar Presupuesto

Borra un elemento existente.

DELETE https://vendomia.app/api/estimates/{id}

Respuesta de ejemplo

{
    "status": 200,
    "message": "OK.",
    "body": {}
}