Lançamentos

A API de Lançamentos permite o gerenciamento completo de ajustes financeiros, sejam eles de débito ou crédito, além de funcionalidades para antecipação de vendas. Esses serviços são essenciais para quem necessita de um controle preciso e ágil sobre transações financeiras, possibilitando ajustes em faturas e pagamentos, bem como uma visão detalhada de vendas.

Figura 1. Fluxo da API de Lançamento

O fluxo descreve os passos para realizar ajustes financeiros, consultar dados e antecipar vendas, utilizando os endpoints disponíveis.

1. Identificar necessidade de ajuste financeiro

O cliente identifica a necessidade de realizar um ajuste financeiro, como registrar um débito ou crédito em sua conta.

2. Registrar ajuste financeiro

O cliente utiliza o endpoint Lançar ajuste financeiro para registrar o ajuste necessário:

Tipo de ajuste: Débito ou crédito.

Detalhamento: Informar dados relevantes, como valor e descrição.

3. Consultar ajustes anteriores

Caso necessário, o cliente pode acessar o endpoint Listar ajustes para verificar ajustes financeiros previamente realizados.

4. Realizar antecipação de vendas

O cliente pode optar por antecipar parcelas de vendas futuras, escolhendo entre as seguintes opções:

Antecipar venda total: Utilize o endpoint para antecipar todas as parcelas de uma venda.

Antecipar venda avulsa: Utilize o endpoint para antecipar apenas uma parcela específica.

5. Monitorar Pagamentos e Vendas

O cliente acompanha os pagamentos e vendas através dos endpoints de listagem disponíveis para:

Verificar transações concluídas.

Validar informações relacionadas às vendas antecipadas.

Endpoints

Ajustes Financeiros

Método	Endpoint	Descrição
POST	`api/v1/lancamentos/ajustes`	Lançar um ajuste manual de débito ou crédito
GET	`/api/v1/lancamentos/ajustes`	Retorna a lista de ajustes realizados
POST	`/api/v1/lancamentos/ajustes/debito`	Lança um ajuste específico a débito
POST	`/api/v1/lancamentos/ajustes/credito`	Lança um ajuste específico a crédito
GET	`/api/v1/lancamentos/tipos`	Lista os tipos de ajustes financeiros disponíveis
GET	`/api/v1/lancamentos/ajustes/fatura`	Retorna todas as faturas que possuem ajustes aplicados
POST	`/api/v1/lancamentos/ajustes/lancamento`	Lança um ajuste diretamente na fatura de um portador específico

Vendas

Método	Endpoint	Descrição
POST	`/api/v1/lancamentos/vendas/antecipar-venda-total`	Antecipação de todas as parcelas de uma venda
POST	`/api/v1/lancamentos/vendas/antecipar-venda-avulsa`	Antecipação de uma parcela especifica de uma venda

Casos de uso

A seguir, detalhamos os principais casos de uso na Jornada de lançamentos, explicando como cada operação é realizada através das APIs disponíveis.

Lançar um ajuste financeiro

Use este o endpoint para realizar o lançamento de um ajuste na fatura do portador.

Exemplo de request body :

{
  "idTipoLancamentoAjuste": 0,
  "idCliente": 2001,
  "valor": 0,
  "dataFaturamento": "2023-04-15",
  "incideFaturaAtiva": true
 
}'

Exemplo de response:

{
  "idLancamentoAjuste": 33546590
}

Listar tipos de ajustes

Use este o endpoint para listar os tipos de lançamentos cadastrados na sua base de dados.

Exemplo de Query Parameters :

idClienteTitular: 1

Exemplo de response:

{
  "content": [
    {
      "id": 0,
      "descricao": "string",
      "tipo": "string",
      "creditoDebito": "string",
      "codigoSeguroExterno": "string",
      "ativo": "string",
      "valorMaximo": 0,
      "limitarValorMaximoPermitido": "string"
    }
  ],
  "pageable": {
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "pageSize": 0,
    "pageNumber": 0,
    "offset": 0,
    "paged": true,
    "unpaged": true
  },
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true
}