Pular para o conteúdo principal

Inserção de triagem

POST /insert_screening

Descrição

Adiciona uma despesa ao repositório de triagem para validação manual.


Requisição

Headers

  • Content-Type: multipart/form-data

Body da Requisição

ParâmetroTipoDescriçãoExemploPadrão
access_tokenstringToken de acesso do usuário (obrigatório)4b194dff-eb83-4af7-ac6f-951fe7931e43-
unit_tokenstringToken de identificação da unidade (obrigatório)5bd5bc16-780f-438c-8665-c8cb7cccbe45-
due_datestringData de vencimento (AAAA-MM-DD) (obrigatório)2025-03-20-
barcodestringCódigo de barras (para boletos) (Máximo 50 caracteres) (opcional)82650000001907700970910730452087432916773187-
digitable_linestringLinha digitavel do codigo de barras (para boletos) (Máximo 50 caracteres) (opcional)82650000001907700970910730452087432916773187-
access_keystringChave de acesso (para cupons fiscais) (Máximo 50 caracteres) (opcional)82650000001907700970910730452087432916773183-
pay_daystringData de pagamento (AAAA-MM-DD) (obrigatório)2025-03-15-
valuenumberValor base da despesa (obrigatório)30.5-
originstringOrigem por onde a despesa esta sendo inserida(whatsapp ou email) (obrigatório)2025-03-15-

Anexos de Arquivos:

  • files: Arquivos adicionais, pode ter varios arquivos

Respostas

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

200 Sucesso

{
"success": true,
"message": "Screening inserted successfuly",
"data": {
"id": "<id_do_token_da_despesa_em_triagem>"
}
}

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/insert_screening' \
-F 'metadata={
"access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
"unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
"digitable_line": "82650000001907700970910730452087432916773187",
"barcode": "82650000001907700970910730452087432916773187",
"due_date": "2025-05-08",
"pay_day": "2025-05-08",
"value": 10,
"origin": "whatsapp"
};type=application/json' \
-F 'files=@./arquivo1.pdf' \
-F 'files=@./arquivo2.pdf' \
| jq

Observações Importantes

  • Validação de intervalo máximo de 1 ano para datas

  • Uploads simultâneos para armazenamento em nuvem

  • Tipos de arquivo suportados: PDF, imagens (JPG, PNG) e outros documentos

  • Permitido apenas um entre boleto(barcode) ou nota fiscal(access_key)

  • O conteúdo JSON deve ser enviado como parte do formulário (multipart/form-data), dentro de um campo específico chamado 'metadata', e não no corpo bruto da requisição.