Documentação da API

POST /get_category_median

Resumo

Este endpoint retorna a categoria mais utilizada para um contato dentro de uma unidade.

Descrição

Use este endpoint para descobrir a categoria com maior recorrência de uso para um contato específico na unidade informada. O contato é identificado pelo cnpj, com ou sem máscara. Opcionalmente, é possível filtrar por tipo de lançamento com type.

Este endpoint aceita dois modos de autenticação:

1. access_token + unit_token
2. token_tec + unit_token

---

Requisição

Body da Requisição

O corpo da requisição deve ser um objeto JSON.

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
access_token	string	Não*	Token de acesso da API.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_token	string	Sim	Token da unidade.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
token_tec	string	Não*	Token interno da aplicação.	xxxxxxxxxxxxxxxx
cnpj	string	Sim	CNPJ do contato/beneficiário. Pode ser enviado com ou sem máscara.	12.345.678/0001-99
type	string	Não	Filtra o tipo de lançamento: in ou out.	out

* Informe access_token ou token_tec.

---

Exemplo com access_token + unit_token

curl -s 'https://portal.fipli.pro/api/v1/get_category_median' \
  -H 'Content-Type: application/json' \
  -d '{
    "access_token": "<access_token>",
    "unit_token": "<unit_token>",
    "cnpj": "12.345.678/0001-99",
    "type": "out"
  }'

{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "cnpj": "12.345.678/0001-99",
  "type": "out"
}

Exemplo com token_tec + unit_token

curl -s 'https://portal.fipli.pro/api/v1/get_category_median' \
  -H 'Content-Type: application/json' \
  -d '{
    "token_tec": "<token_tec>",
    "unit_token": "<unit_token>",
    "cnpj": "12.345.678/0001-99",
    "type": "out"
  }'

{
  "token_tec": "<token_tec>",
  "unit_token": "<unit_token>",
  "cnpj": "12.345.678/0001-99",
  "type": "out"
}

Respostas

200 OK

{
  "success": true,
  "data": {
    "token": "<token>",
    "module_type": "out",
    "category": "Fornecedores",
    "note": "Pagamentos recorrentes para fornecedores",
    "dre_name": "Despesas Operacionais",
    "usage_count": "12"
  }
}

Se não houver histórico suficiente para determinar uma categoria, a resposta será:

{
  "success": true,
  "data": null
}

4xx e 5xx Erros

{
  "success": false,
  "error": "Provide cnpj."
}