Dúvidas frequentes

Geral

Quais operações a API suporta?
Somente leitura: dá pra consultar dados, mas não criar, editar ou lançar informações (todos os endpoints são GET).

Como obtenho minha chave de API?
Entre em contato com o suporte.

A API possui webhooks?
Não. Para acompanhar vencimentos e baixas, use polling.

Autenticação

Recebi 401 — o que fazer?
Verifique se o header se chama exatamente API-KEY e se a chave está ativa.

Dados

Recebi 404 em um /{id} — o que fazer?
Confirme que está usando o ID público encriptado retornado pela própria API, não um código numérico interno.

Quais são as situações possíveis de uma conta?
Exatamente três: em_aberto, parcial e paga. Conta vencida e não paga permanece em_aberto/parcial — "vencida" se deriva comparando dataVencimento com a data atual. Veja Contas.

Qual o formato dos telefones?
Sem formatação: dígitos corridos com DDI 55 + DDD, ex.: 5547999666332. CPF/CNPJ (documento) também vem sem formatação.

Qual o formato das datas?
Sempre Y-m-d (ex.: 2026-07-16), tanto nos filtros quanto nas respostas.

Seguros (incêndio/fiança) aparecem na API?
Não há endpoint de apólices. Quando o seguro é cobrado nas parcelas da locação, ele aparece como lançamento em Itens de contas, identificável pelos campos categoria e descricao.