API do Resulth Windows: Novo endpoint de Contas a Pagar

API do Resulth Windows: Novo endpoint de Contas a Pagar | 146214 | Resulth Windows

1. CONTEXTO

Para facilitar a integração de informações financeiras do Resulth com aplicações externas, o HUB de integração da ATS Informática passa a disponibilizar um endpoint dedicado à consulta de títulos de Contas a Pagar.

A nova integração permite consultar documentos financeiros de forma padronizada, utilizando filtros e paginação para adequar o retorno às necessidades do sistema integrador. Com isso, parceiros e aplicações integradas podem acessar as informações de Contas a Pagar por meio de uma interface estruturada, sem a necessidade de acesso direto ao banco de dados.

2. O QUE MUDOU

• Novo endpoint de Contas a Pagar: disponibilizado no HUB de integração da ATS Informática para consulta de títulos financeiros.

• Documentos retornados: consulta documentos da tabela DOCUPAG com situação Em aberto ou Parcialmente liquidado.

• Filtros opcionais: suporte aos parâmetros empresa, fornecedor, data de vencimento, número do documento, página e limite.

• Empresa autenticada: quando o código da empresa não é informado, o endpoint utiliza automaticamente a empresa autenticada na requisição.

• Retorno padronizado: os documentos são retornados em formato JSON, contendo 10 campos por registro, incluindo o valor em aberto calculado.

• Paginação: os parâmetros pagina e limite permitem controlar a quantidade de registros e navegar pelos resultados.

3. COMO ACESSAR

O endpoint está disponível nos seguintes ambientes:

Ambiente de Produção

4. COMO USAR (PASSO A PASSO)

1. Autentique-se no HUB de integração da ATS Informática utilizando as credenciais do sistema integrador.

2. Realize uma requisição HTTP GET para o endpoint conta-a-pagar.

3. Informe os parâmetros de filtro desejados como Query Params. Todos os parâmetros são opcionais.

4. Processe o retorno em formato JSON, considerando os documentos retornados na consulta.

5. Utilize os parâmetros pagina e limite para controlar a paginação dos resultados quando houver múltiplos registros.

Parâmetros de entrada

Exemplo de requisição com filtros

Figura 1: Exemplo de requisição ao endpoint conta-a-pagar com resposta 200 OK

Exemplo de retorno (objeto por documento)

5. CAMPOS DO RETORNO

6. REGRAS DE NEGÓCIO

• Somente documentos com situação Em aberto (código 1) ou Parcialmente liquidado são retornados. Documentos liquidados não aparecem na consulta.

• O campo valorEmAberto é calculado dinamicamente como: ValorDocto - ValorDesc - ValorPago.

• Se o parâmetro codigoEmpresa não for informado, o HUB assume automaticamente a empresa vinculada ao CNPJ que realizou a autenticação.

• Todos os 4 filtros de entrada (codigoEmpresa, codigoFornecedor, dataVencimento, codigoDocumento) são opcionais e podem ser combinados livremente.

• O endpoint é somente leitura (GET). Não é possível criar, alterar ou excluir registros por meio desta integração.

• A data deve ser enviada no formato yyyy-MM-dd (ex: 2026-10-21). Formatos diferentes podem causar erro na requisição.

7. BOAS PRÁTICAS E OBSERVAÇÕES

• Utilize o ambiente de desenvolvimento para testes e validações antes de promover a integração para produção.

• Combine filtros para reduzir o volume de dados retornados e melhorar a performance das consultas.

• Implemente paginação (parâmetros pagina e limite) em integrações que podem retornar grande volume de documentos.

• O campo descricaoSituacao pode ser usado diretamente na interface do sistema integrador para exibir o status legível ao usuário.

• Guarde o codigoDocumento retornado para referência em operações futuras de liquidação ou baixa que venham a ser disponibilizadas via API.