api_get_arrangement – Proxima Research Español

Obtiene la información introducida durante la visita en la tarjeta “Acuerdo”.
El conjunto de parámetros depende de la configuración del cliente.
Para obtener la configuración se usa api_get_entitymap.

Solicitud

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Autenticación

Bearer Token (obligatorio)

Estructura de la solicitud

Encabezados

Clave	Valor
Authorization	Bearer `<token>`
Content-Type	application/json

Cuerpo

{
    "function": "api_get_arrangement",
    "format": "csv",
    "arguments": {
        "date_from": "2025-08-04",
        "date_till": "2025-08-04",
        "preparation_ids": "1,2,3,4",
        "brend_ids": "1,2,3,4"
    }
}

Campo	Tipo	Obligatorio	Descripción
function	string	Sí	Método API — `"api_get_arrangement"`.
format	string	Sí	Formato — `csv`.
arguments	object	Sí	Bloque de parámetros.
date_from	string	Sí	Fecha inicio de las visitas.
date_till	string	Sí	Fecha fin de las visitas.
preparation_ids	string	No	IDs de medicamentos (separados por comas).
brend_ids	string	No	IDs de marcas (string).

Respuesta exitosa

200 OK

csv, texto plano.

Ejemplo

preparation_id,brend_id,potential,plancount,factcount,patalog,task_id
1,6,,2,2,,51365
13,1,1,5,5,,51365
14,4,3,5,5,,51365

Campo	Descripción
preparation_id	ID del medicamento (sólo uno de los campos existirá).
brend_id	ID de la marca.
potential	Valor numérico float.
plancount	Valor numérico (float).
factcount	Valor numérico (float).
patalog	Nombre de la patología.
task_id	ID de la visita en Proxima CRM.

Error

40x/50x

{
  "message": "string"
}

Código	Descripción
400	solicitud incorrecta
401	no autorizado
500	error del servidor

Búsqueda