Introdução
O que o RemindCash faz, onde entra a API e exatamente o que está disponível hoje na v1.
O RemindCash acompanha o que os seus clientes lhe devem e envia lembretes de pagamento agendados em nome da sua empresa — antes, no dia e depois de cada data de vencimento. Quando marca uma cobrança como paga, os lembretes restantes param. O RemindCash não recebe pagamentos: o seu cliente paga-lhe diretamente e é você que regista o pagamento.
Para que serve a API
A API REST permite que os seus próprios sistemas trabalhem com as mesmas cobranças que gere na aplicação:
- criar e atualizar cobranças em rascunho a partir da sua ferramenta de faturação ou de projetos,
- registar os pagamentos que o seu cliente lhe comunicou,
- pausar, retomar ou cancelar os lembretes de uma cobrança,
- ler as tentativas de lembrete feitas para uma cobrança,
- ler a utilização e os saldos de créditos pré-pagos da sua empresa.
Cada escrita usa as mesmas regras de validação, permissões e segurança que a aplicação. As escritas pela API nunca enviam mensagens: as cobranças criadas pela API começam como rascunhos e são ativadas na aplicação depois de revistas.
URL de base
Todos os endpoints têm versão e partilham um único URL de base. Os pedidos e as respostas são JSON sobre HTTPS.
https://api.remindcash.com/v1Disponibilidade
| Área | Estado na v1 |
|---|---|
| Cobranças: listar, ler, criar rascunho, atualizar rascunho | Disponível |
| Pagamentos comunicados | Disponível |
| Pausar, retomar e cancelar | Disponível |
| Tentativas de lembrete (leitura) | Disponível |
| Utilização e créditos pré-pagos (leitura) | Disponível |
| Séries de cobranças recorrentes | Só na aplicação — veja Cobranças recorrentes |
| Contas a pagar (as suas próprias faturas) | Listar, ler, criar e atualizar rascunhos; marcar uma fatura como paga como comunicação da equipa |
| Webhooks de saída para os seus sistemas | Não disponível |
| Referência OpenAPI gerada | Descarregar o JSON com versão |
Próximos passos
- Siga o Início rápido para fazer o seu primeiro pedido.
- Leia os Conceitos sobre montantes, datas, estados e versões.
- Configure chaves e permissões em Autenticação.