Pular para o conteúdo principal

Listar arquivos da receita

POST /list_income_files​

Resumo​

Rota para listar arquivos em receitas do sistema.

Descrição​

Esta rota é responsável por listar arquivos associados as receitas existentes no sistema.

Requisição​

Headers​

  • Content-Type: application/json

Body da Requisição​

ParâmetroTipoDescriçãoExemploPadrão
access_tokenstringToken de acesso do usuário (obrigatório)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
unit_tokenstringToken de identificação da unidade (obrigatório)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
id_incomestringID da receita (obrigatório)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-

Respostas​

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso​

{
  "success": true,
  "message": "Income files listed successfuly",
  "data": [
    {
      "file": "<filename_1>",
      "type": "<mimetype_1>",
      "file_name": "<real_filename_1>",
      "type_selected": "Outros",
      "year_inserted": 2025,
      "month_inserted": "05"
    },
    {
      "file": "<filename_2>",
      "type": "<mimetype_2>",
      "file_name": "<real_filename_2>",
      "type_selected": "Outros",
      "year_inserted": 2025,
      "month_inserted": "05"
    },
    {
      "file": "<filename_3>",
      "type": "<mimetype_3>",
      "file_name": "<real_filename_3>",
      "type_selected": "Outros",
      "year_inserted": 2025,
      "month_inserted": "05"
    }
  ]
}

400 Requisição Inválida​

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado​

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor​

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição​

curl -s -X POST 'https://portal.fipli.pro/api/v1/list_income_files' \
    -d '{
            "access_token": "<access_token>",
            "unit_token": "<unit_token>",
            "id_income": "<id_income>"
        }' \
    -H 'Content-Type: application/json' \
    | jq