Consulta os títulos a pagar cadastrados no sistema Teknisa e retorna os registros em formato JSON, com filtros por empresa, período de vencimento e status.

GET /index.php/consultaTitulosPagar

A URL base para todas as chamadas é https://teknisa-integracao.teknisa.com. A autenticação é feita por headers HTTP e os parâmetros de filtro são enviados na própria URL da requisição.

---

1. Autenticação

Toda requisição deve enviar dois headers HTTP com as credenciais do operador autenticado.

Header	Tipo	Obrigatório	Descrição
Emailoper	String	Sim	E-mail do operador autenticado
Senhaoper	String	Sim	Senha criptografada/hash do operador

🔒 Cuidado com a senha em texto puro

O header Senhaoper espera a senha já criptografada/hash — nunca a senha em texto plano do operador. Confirme com a equipe de integração o algoritmo de hash utilizado antes de gerar esse valor.

2. Como usar

Parâmetros da requisição

Parâmetro	Tipo	Obrigatório	Descrição
CDEMPRESA	String	Sim	Código da empresa
DTVENBOLPAGINI	dd/MM/yyyy	Sim	Data inicial de vencimento
DTVENBOLPAGFIN	dd/MM/yyyy	Sim	Data final de vencimento
DTULTATUINI	dd/MM/yyyy	Não	Data inicial da última atualização
DTULTATUFIN	dd/MM/yyyy	Não	Data final da última atualização
IDSTATBPAG	String	Não	Status do título — veja valores possíveis na seção de retorno

Recomenda-se codificar a URL (urlencode ou http_build_query) antes de enviar a requisição.

Exemplo de chamada — cURL

curl --location --request GET 'https://teknisaintegracao.teknisa.com/index.php/consultaTitulosPagar?CDEMPRESA=01&DTVENBOLPAGINI=28/05/2026&DTVENBOLPAGFIN=28/05/2026&IDSTATBPAG=A' \
--header 'Emailoper: usuario@empresa.com' \
--header 'Senhaoper: ***************'

Exemplo de chamada — PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://teknisaintegracao.teknisa.com/index.php/consultaTitulosPagar?CDEMPRESA=01&DTVENBOLPAGINI=28/05/2026&DTVENBOLPAGFIN=28/05/2026&IDSTATBPAG=A',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Emailoper: usuario@empresa.com',
    'Senhaoper: ***************'
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

Exemplo de chamada — URL completa

# Base
https://teknisa-integracao.teknisa.com

# Endpoint + parâmetros
GET /index.php/consultaTitulosPagar
    ?CDEMPRESA=01
    &DTVENBOLPAGINI=28/05/2026
    &DTVENBOLPAGFIN=28/05/2026
    &IDSTATBPAG=A

3. Referência de retorno

A API sempre retorna um array JSON com um objeto por título. Alguns campos podem vir como null dependendo da situação do título.

Exemplo de resposta

[
  {
    "CDFILIAL": "0007",
    "NRLANBOLPAG": "0000130106",
    "CDEMPRESA": "01",
    "CDFORNECED": "F12460251670",
    "NMRAZSOCFORN": "VICTOR",
    "IDSTATBPAG": "A",
    "CDBANCO": null,
    "VRFINALBPAG": 25,
    "NRNOTAFISC": "0005654",
    "DTVENBOLPAG": "28/05/2026 00:00:00",
    "DSTPCTPAGAR": "LUZ",
    "DSCLASSFINA": "CASA"
    // ... demais campos, ver tabela abaixo
  }
]

Campos do retorno

Campo	Tipo	Descrição
CDFILIAL	String	Código da filial
NRLANBOLPAG	String	Número do lançamento do boleto/título
CDEMPRESA	String	Código da empresa
CDFORNECED	String	Código do fornecedor
NRINSJURFORN	String	CPF/CNPJ do fornecedor
NMRAZSOCFORN	String	Nome/razão social do fornecedor
DSEMAILFORN	String	E-mail do fornecedor
CDCHAVEPIX	String	Chave PIX do fornecedor
IDCHAVEPIX	String	Tipo da chave PIX (01 – Telefone, 02 – Email, 03 – CPF/CNPJ, 04 – EVP)
NRPARCBOLPAGVISU	String	Número da parcela do boleto
IDSTATBPAG	String	Status do título — ver tabela de valores abaixo
CDTPBAIXAPAG	String / Null	Código do tipo de baixa do pagamento
CDREDUCONT	String / Null	Código reduzido da conta corrente
CDBANCO	String / Null	Código do banco
CDAGENCIA	String / Null	Código da agência bancária
CDCONTCORR	String / Null	Conta corrente
DSBOLETPAG	String	Descrição do boleto
VRPEMULBPAG	Decimal	Percentual/multa aplicada
VRPEMORBPAG	Decimal	Percentual de mora
VRFINALBPAG	Decimal	Valor final do título
CDFILIRECE	String	Código da filial de recebimento
CDTIPOOPER	String	Código do tipo de operação
NRNOTAFISC	String	Número da nota fiscal
CDSERIEENTR	String	Série da nota fiscal
DTVENBOLPAG	String	Data de vencimento
DTEMISSAO	DateTime	Data de emissão
DTENTRSAID	DateTime	Data de entrada/saída
CDTPCTPAGAR	String	Código do tipo de conta a pagar
DSTPCTPAGAR	String	Descrição do tipo de conta a pagar
CDCLASSFINA	String	Código da classificação financeira
DSCLASSFINA	String	Descrição da classificação financeira
DSCONTAPAG	String	Descrição da conta a pagar

Valores de IDSTATBPAG

Valor	Status
A	Aberto
B	Baixado

Formato de datas

Todos os campos de data seguem o padrão dd/MM/yyyy HH:mm:ss, por exemplo 28/05/2026 00:00:00.

---

Comportamento importante: consolidação de títulos

Boletos com múltiplas contas ou notas vinculadas retornam um único registro consolidado

Quando um boleto tem mais de uma conta e/ou nota fiscal associada, a API não divide o retorno em múltiplos registros. Ela retorna apenas um registro consolidado, preenchendo os campos de identificação com os dados da conta de maior valor associado ao boleto e o valor correspondente ao somatório dos valores.

Isso é especialmente relevante para quem consome esta API esperando um registro por conta/documento — o consumidor precisa tratar o caso de valores agregados.

	Conta 01	Conta 02	Retorno da API
Documento	001	002	002
Valor	R$ 120,00	R$ 80,00	R$ 200,00
Tipo	Água	Luz	Luz

Este artigo foi útil?

0 Até 5 estrelas

5 Estrelas		0%
4 Estrelas		0%
3 Estrelas		0%
2 Estrelas		0%
1 Estrelas		0%

5 Submit

Por favor, nos dê seu feedback

Como podemos melhorar este documento?

Nome

Email

Precisa de ajuda?

Enviar