Crear Proforma

Crear Proforma

POST https://api.sperant.com/v3/budgets

La creación de proforma implica añadir parámetros obligatorios y opcionales. Los parámetros opcionales se documentarán más adelante. Para el uso de la plantilla se debe configurar en medios digitales de cada proyecto, sino solicitar el Id a Sperant.

Headers

Name	Type	Description
Authorization*	string	Token entregado.

Request Body

Name	Type	Description
client_id*	integer	Identificador del cliente. Consulta el endpoint Listar Clientes
unit_id*	integer	Identificador de la unidad. Consulta el endpoint Listar Unidades. Campo obligatorio si no se envía el type_id.
type_id*	integer	Identificador de la tipología. Consulta el endpoint Listar Tipologías. Campo obligatorio si no se envía el unit_id.

200

{
    "data": {
        "type": "budgets",
        "id": "75061",
        "links": {
            "titulars": "https://api.sperant.com/v3/budgets/75061/units",
            "units": "https://api.sperant.com/v3/budgets/75061/titulars"
        },
        "attributes": {
            "id": 75061,
            "code": "2021-00067",
            "contract_num": null,
            "expire_date": 1615481423,
            "created_at": 1615395023,
            "active": true,
            "total_price": 25000,
            "total_price_discount": 25000,
            "exchange_rate": 1,
            "can_discount": 0,
            "funding_type_id": 1,
            "funding_type": "hipotecario",
            "currency": "PEN",
            "reserved": false,
            "origin": "api",
            "project_id": 20,
            "agent_id": 74,
            "bank_id": null,
            "bank": null,
            "extra_fields": {
                "prueba": 10
            }
        }
    }
}

Parámetros opcionales para la creación de proforma

Parámetro	Tipo de Dato	Descripción
template_id*	integer	Identificador de la plantilla. Si no se envía toma el valor configurado en medios digitales de cada proyecto, si no está configurado solicitar a Sperant el ID.
agent_id	integer	Identificador del vendedor a asignar a la proforma. Consulta el endpoint Usuarios.
utm_source	string	Sirve para identificar un motor de búsqueda, el nombre del boletín u otra fuente. Si no se envía un valor se registrará con el valor sperant.
utm_medium	string	Sirve para identificar un medio como el correo electrónico o el costo por clic. Si no se envía un valor se registrará con el valor api.
utm_campaign	string	Utilizado para el análisis de palabras clave. Sirve para identificar una promoción de producto o campaña estratégica específica.
utm_term	string	Usado para búsquedas pagadas. Sirve para anotar las palabras clave de este anuncio.
utm_content	string	Se usa para pruebas A/B y anuncios orientados por contenido. Sirve para diferenciar anuncios o enlaces que apuntan a la misma URL.
extra_fields	json	Datos extras de la proforma

El envío de atributos para crear una proforma debe ser en el siguiente formato:

{
    "client_id": 81957,
    "unit_id": 8499,
    "template_id": 135
}

Datos que se registran en Sperant

• Se asignará vendedor de acuerdo a la lógica de asignación. Para ver la asignación de vendedores, visitar: Asignación de Vendedores
• Se asignará el proyecto de la unidad o tipología elegida en la cotización al cliente.

• Se enviará un correo al ciente con la información de la proforma según la plantilla elegida previa configuración en el proyecto.

• Se creará la interacción de Creación de proforma.

• En la interacción creación de proforma se guardará los campos UTM:

  • utm_source: sperant

  • utm_medium: api