O que é uma API?
API é a sigla para Application Programming Interface ou, em português, Interface de Programação de Aplicativos.
Trata-se de uma padronização utilizada para a comunicação, transferência e carregamento de dados entre dois sistemas, softwares ou aplicativos.
De forma prática, uma API é composta por endpoints que permitem a interação com determinados recursos. Por exemplo, um recurso de Clientes pode disponibilizar ações como:
Obter dados de um cliente;
Criar (persistir) um novo cliente;
Editar informações existentes;
Excluir um cliente.
Assim, uma API ou Recurso representa o conjunto dessas ações possíveis em um determinado contexto, como Clientes, Credores ou Títulos a Receber.
Documentação das APIs do Sienge Plataforma
A documentação das APIs do Sienge Plataforma é um conteúdo técnico, voltado principalmente para desenvolvedores.
No entanto, usuários não técnicos também podem compreendê-la, especialmente se seguirem as orientações deste documento, que busca explicar os principais termos utilizados.
Entre os conceitos abordados na documentação estão temas como:
Como interpretar endpoints;
Como utilizar métodos (GET, POST, PUT, DELETE);
Como autenticar chamadas à API;
Como realizar integrações seguras e padronizadas.
Onde acessar
A documentação de APIs é dinâmica e pode sofrer atualizações frequentes.
Você pode consultá-la sempre pelo link: Documentação das APIs do Sienge Plataforma
Antecipação de Parcelas
O endpoint de antecipação de parcelas tem como objetivo apresentar o valor da cobrança a ser antecipada antes da geração efetiva da cobrança. Esse recurso é especialmente útil em processos de simulação que podem ser implementados em aplicações conectadas ao Sienge, permitindo a visualização de valores calculados de acordo com os parâmetros configurados no sistema.
Como funciona
Ao utilizar a API, você informa as parcelas que deseja antecipar e define parâmetros como nova data de vencimento e regras de cálculo.
Com base nessas informações, o sistema:
- Valida os dados informados
- Aplica as regras de antecipação (como cálculo de valor presente, quando habilitado)
- Registra a nova cobrança
Endpoint disponível
Parâmetros da requisição
A requisição deve ser enviada no formato JSON, contendo os seguintes campos:
Dados principais
- companyId: identificador da empresa
- installments: lista de parcelas a serem antecipadas
- billId: identificador do título
- installmentId: identificador da parcela
- accountNumber: conta bancária utilizada na cobrança
- newDueDate: nova data de vencimento da cobrança
Parâmetros opcionais
- groupBy: define agrupamento das parcelas (ex: por cliente)
- matchDueDate: regra para considerar vencimentos
- percentPresentValue: percentual para cálculo do valor presente
- calculatePresentValue: indica se o valor presente deve ser calculado
- correctAnnualInstallment: indica se parcelas anuais devem ser corrigidas
Exemplo de requisição
{
"companyId": 1,
"installments": [
{
"billId": 10,
"installmentId": 0
}
],
"accountNumber": "6538-2",
"newDueDate": "2021-01-01",
"groupBy": "CUSTOMER",
"matchDueDate": "ALL",
"percentPresentValue": 11.11,
"calculatePresentValue": true,
"correctAnnualInstallment": true
}
Retornos da API
Sucesso
201 — Cobrança enviada com sucesso
A antecipação foi processada e a cobrança registrada.
Possíveis erros
400 — Inconsistência nos dados
Ocorre quando há informações inválidas ou incompletas na requisição.
404 — Parcelas não encontradas
As parcelas informadas não foram localizadas.
422 — Regra de agrupamento inválida
O agrupamento por cliente só é permitido quando todas as parcelas pertencem à mesma empresa.
500 — Erro interno
Ocorre quando há falha inesperada no processamento.
Observações importantes
- Todas as parcelas devem ser informadas manualmente na requisição.
- O cálculo de antecipação só será aplicado se configurado nos parâmetros enviados.
- Validações de consistência são realizadas antes do registro da cobrança.
- O uso dessa API depende da contratação do conector Automação Bancária.
Saiba mais em: API para antecipação de parcelas - Documentação Técnica
Quem pode utilizar as APIs do Sienge Plataforma?
O acesso às APIs do Sienge Plataforma está disponível apenas para clientes que utilizam o Sienge na versão Data Center (DC). Para clientes que possuem o sistema em servidor local, o uso das APIs não está disponível.
Para informações detalhadas sobre disponibilidade de recursos e planos, acesse o artigo: Quais clientes podem utilizar APIs e quais recursos do sistema estão disponíveis? – Sienge Plataforma
Esperamos que este artigo tenha ajudado!