api_get_arrangement – Proxima Research Brazil

Obtém as informações inseridas durante a visita no cartão “Acordo”.
O conjunto de parâmetros preenchidos depende das configurações do cliente específico.
Para obter essas configurações utilize o método api_get_entitymap.

Solicitação

Endpoint

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

Autenticação

Bearer Token (obrigatório)

Estrutura da solicitação

Cabeçalhos

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

Corpo da solicitação

{
    "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	Obrigatório	Descrição
function	string	Sim	Nome do método API — `"api_get_arrangement"`.
format	string	Sim	Formato da resposta — `csv`.
arguments	object	Sim	Bloco de parâmetros.
date_from	string	Sim	Data inicial da lista de visitas (pela data de início). Formato: `YYYY-MM-DD`.
date_till	string	Sim	Data final da lista de visitas (pela data de fim). Formato: `YYYY-MM-DD`.
preparation_ids	string	Não	IDs de medicamentos no Proxima CRM, separados por vírgulas.
brend_ids	string	Não	IDs de marcas no Proxima CRM, separados por vírgulas (string).

Resposta bem-sucedida

200 OK

Formato csv — texto plano.

Content-Type

text/plain

Exemplo de resposta

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	Descrição
preparation_id	ID do medicamento no Proxima CRM. Pode aparecer preparation_id ou brend_id dependendo das configurações.
brend_id	ID da marca no Proxima CRM. Pode aparecer preparation_id ou brend_id dependendo das configurações.
potential	Valor numérico (float). Significado definido nas regras do projeto.
plancount	Valor numérico (float). Significado definido nas regras do projeto.
factcount	Valor numérico (float). Significado definido nas regras do projeto.
patalog	Valor textual: nome da patologia associada aos valores numéricos.
task_id	ID da visita na base Proxima CRM onde os dados foram inseridos.

Resposta de erro

40x/50x

{
  "message": "string"
}

Código	Descrição
400	Requisição inválida
401	Não autorizado
500	Erro interno do servidor

Pesquisa