Central de Atendimento

Visão Geral

Este documento descreve as APIs disponíveis para gerenciamento financeiro do sistema.

Endpoints

Buscar Duplicatas

GET /v1/duplicatas

Retorna uma lista de duplicatas com base nos filtros informados.

Parâmetros de Consulta

Exemplo de Uso

Buscar duplicatas de um período específico

GET /v1/duplicatas?dataInicio=2024-01-01&dataFim=2024-03-31

Buscar duplicatas de um negociante específico

GET /v1/duplicatas?negociante.codigo=123&negociante.nome=Empresa%20ABC

Exemplo de Resposta

{
  "data": [
    {
      "id": 1,
      "numero": "DUP-001",
      "dataEmissao": "2024-01-15",
      "dataVencimento": "2024-02-15",
      "valor": 1500.00,
      "negociante": {
        "id": 1,
        "codigo": "123",
        "nome": "Empresa ABC"
      },
      "contaInterna": {
        "id": 1,
        "codigo": "1.1.1.01",
        "descricao": "Contas a Receber",
        "creditoDebito": "CREDITO"
      },
      "tipoCobranca": {
        "id": 1,
        "codigo": "BOL",
        "descricao": "Boleto Bancário"
      },
      "rateiosCentroCusto": [
        {
          "centroCusto": {
            "id": 1,
            "codigo": "CC001",
            "descricao": "Centro de Custo 1"
          },
          "percentual": 100.00
        }
      ],
      "rateiosContaInterna": [
        {
          "contaInterna": {
            "id": 2,
            "codigo": "1.1.1.02",
            "descricao": "Conta Interna 2"
          },
          "percentual": 100.00
        }
      ]
    }
  ],
  "metadata": {
    "resultset": {
      "count": 1,
      "start": 0,
      "limit": 50
    }
  }
}

Buscar Movimentos

GET /v1/movimentos

Retorna uma lista de movimentos financeiros com base nos filtros informados.

Parâmetros de Consulta

Exemplo de Uso

Buscar movimentos de um período específico

GET /v1/movimentos?dataInicio=2024-01-01&dataFim=2024-03-31

Buscar movimentos de uma conta bancária específica

GET /v1/movimentos?contaBancaria.numero=123456&contaBancaria.digito=7

Exemplo de Resposta

{
  "data": [
    {
      "id": 1,
      "data": "2024-01-15",
      "valor": 2500.00,
      "contaBancaria": {
        "id": 1,
        "numero": "123456",
        "digito": "7",
        "descricao": "Conta Principal"
      },
      "contaInterna": {
        "id": 1,
        "codigo": "1.1.1.01",
        "descricao": "Contas a Receber",
        "creditoDebito": "CREDITO"
      },
      "centroCusto": {
        "id": 1,
        "codigo": "CC001",
        "descricao": "Centro de Custo 1"
      },
      "lancamento": {
        "id": 1,
        "numero": "LANC-001",
        "data": "2024-01-15",
        "valor": 2500.00
      }
    }
  ],
  "metadata": {
    "resultset": {
      "count": 1,
      "start": 0,
      "limit": 50
    }
  }
}

Modelos de Dados

DuplicataDto

Representa uma duplicata no sistema.

Atributos

MovimentoDto

Representa um movimento financeiro.

Atributos

ContaBancariaDto

Representa uma conta bancária.

Atributos

CentroCustoDto

Representa um centro de custo.

Atributos

ContaInternaDto

Representa uma conta interna.

Atributos

TipoCobrancaDto

Representa um tipo de cobrança.

Atributos

RateioCentroCustoPercentualDto

Representa um rateio por centro de custo.

Atributos

LancamentoDto

Representa um lançamento financeiro.

Atributos

NegocianteDto

Representa um negociante.

Atributos

RateioContaInternaPercentualDto

Representa um rateio por conta interna.

Atributos

Observações Importantes

Formato de Datas

• Todas as datas devem ser informadas no formato 'yyyy-MM-dd'
• Exemplo: "2024-03-20"

Paginação

• A paginação é opcional, com valores padrão:
  • page.start: 0 (índice inicial)
  • page.limit: 50 (tamanho da página)
• O resultado inclui metadados com o total de registros encontrados

Rateios

• Os rateios (centro de custo e conta interna) são opcionais
• A soma dos percentuais deve ser igual a 100%
• Cada rateio pode ter um ou mais itens

Valores Monetários

• Todos os valores monetários são representados como BigDecimal
• O formato deve incluir duas casas decimais
• Exemplo: 1500.00

Códigos de Resposta HTTP

• 200: Sucesso
• 400: Requisição inválida
• 401: Não autorizado
• 403: Acesso negado
• 404: Recurso não encontrado
• 500: Erro interno do servidor

Exemplos de Uso Comuns

Buscar Duplicatas Vencidas

# Buscar duplicatas vencidas no último mês
GET /v1/duplicatas?dataInicio=2024-02-20&dataFim=2024-03-20

Buscar Movimentos por Conta Bancária

# Buscar movimentos de uma conta específica
GET /v1/movimentos?contaBancaria.numero=123456&contaBancaria.digito=7

Buscar com Paginação

# Buscar segunda página com 20 registros
GET /v1/duplicatas?page.start=20&page.limit=20

Buscar com Múltiplos Filtros

# Buscar duplicatas de um negociante em um período específico
GET /v1/duplicatas?dataInicio=2024-01-01&dataFim=2024-03-31&negociante.codigo=123

Esta API é parte do sistema ERP Easy e está disponível para clientes com as devidas permissões de acesso.