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âmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
unit_token	string	Token de identificação da unidade (obrigatório)	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
due_date	string	Data de vencimento (AAAA-MM-DD) (obrigatório)	2025-03-20	-
barcode	string	Código de barras (para boletos) (Máximo 50 caracteres) (opcional)	00000000000000000000000000000000000000000000	-
digitable_line	string	Linha digitavel do codigo de barras (para boletos) (Máximo 50 caracteres) (opcional)	00000000000000000000000000000000000000000000	-
access_key	string	Chave de acesso (para cupons fiscais) (Máximo 50 caracteres) (opcional)	00000000000000000000000000000000000000000000	-
pay_day	string	Data de pagamento (AAAA-MM-DD) (obrigatório)	2025-03-15	-
value	number	Valor base da despesa (obrigatório)	30.5	-
origin	string	Origem 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": "<access_token>",
            "unit_token": "<unit_token>",
            "digitable_line": "<digitable_line>",
            "barcode": "<barcode>",
            "due_date": "<due_date>",
            "pay_day": "<pay_day>",
            "value": <value>,
            "origin": "<origin>"
        };type=application/json' \
    -F 'files=@./<filename_1>' \
    -F 'files=@./<filename_2>' \
    | 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.