======Boletos======

Serão consideradas nas requisições dos boletos os documentos com modalidade de pagamento parametrizada como "Boleto":

{{:enduser:erp:financeiro:cp:pgescritural:remessaapi:envio:pasted:20260421-114537.png}}

=====Requisição=====

Na requisição (Request) de pagamentos de Boletos serão enviados:\\

- O número da Requisição\\
- Os dados bancários da empresa para débito\\

- A lista dos documentos para realização dos lançamentos dos boletos, contendo:
  * O número do código de barras
  * A data do pagamento
  * O valor do pagamento
  * O documento, contendo o número, tipo e parcela do documento e o estabelecimento ao qual pertence
  * A descrição do pagamento, contendo o número, tipo e parcela do documento e o estabelecimento ao qual pertence
  * As informações do Beneficiário.
   
{{:enduser:erp:financeiro:cp:pgescritural:remessaapi:envio:pasted:20260430-115911.png}}

=====Resposta=====

Instantaneamente a API envia uma resposta (Response) contendo, além dos alguns dados enviados na requisição, informações como:

- o Estado da requisição:
Código que identifica o estado da solicitação, que pode conter os seguintes status:
  - Requisição com todos os lançamentos consistentes;
  - Ao menos um lançamento inconsistente;
  - Todos os lançamentos inconsistentes;
  - Pendente de ação pelo Conveniado (falta autorizar);
  - Em processamento pelo Banco;
  - Processada;
  - Rejeitada;
  - Preparando remessa não liberada;
  - Liberada via API;
  - Preparando remessa liberada.

- Quantidade de Lançamentos\\
- Quantidade de Lançamentos Válidos\\
- Valor dos Lançamentos\\
- Valor dos Lançamentos Válidos\\

{{:enduser:erp:financeiro:cp:pgescritural:remessaapi:envio:pasted:20260430-120333.png}}

- Lista Response de Boletos contendo, além das informações enviadas de cada documento:
  * o Código Identificador do Pagamento (Número único gerado pelo Banco, utilizado para consultas posteriores)
  * o Indicador de Aceite do Pagamento: "S" (Sim) ou "N" (Não). No caso de não aceito, carrega uma lista com as respectivas ocorrências.

{{:enduser:erp:financeiro:cp:pgescritural:remessaapi:envio:pasted:20260430-120259.png}}

//Informações técnicas: \\
- O código identificador do pagamento é guardado na tabela de pagamento (PPAGAR) para realização das consultas posteriores.\\
- O envio da requisição também é guardado na tabela de movimentações do pagamento escritural (MOVPGESC)\\
- A URL, Request e Response da API também são guardados na tabela de integração (INTWSLOG).
//


=====Mensagens=====

Possíveis mensagens de Status das requisições retornadas pela API (Responses):

  * 201 - CRIADO - A solicitação foi atendida e resultou em um novo recurso sendo criado.
  * 400 - REQUISIÇÃO INVÁLIDA - O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.
  * 401 - NÃO AUTORIZADO. A requisição requer autenticação do usuário.
  * 403 - PROIBIDO - A solicitação foi válida, mas o servidor está recusando a ação. O usuário pode não ter as permissões necessárias para um recurso ou pode precisar de uma conta de algum tipo.
  * 404 - NÃO ENCONTRADO - O servidor não pode encontrar o recurso solicitado.
  * 409 - CONFLITO - A solicitação não pôde ser concluída devido a um conflito com o estado atual do recurso.
  * 500 - ERRO INTERNO - O servidor encontrou uma condição inesperada que o impediu de atender a requisição.