Conceitos

Empresas e chaves, estados das cobranças, montantes em unidades menores, datas de vencimento locais e versões.

Empresas

Cada chave de API pertence a exatamente uma empresa. Uma chave só pode ver e alterar os registos dessa empresa. Pedir um ID que pertence a outra empresa devolve 404 not_found, para que os registos de outras empresas não possam ser descobertos.

Estados das cobranças

Estado	Significado
`draft`	Criada, mas não ativa. Não são planeados nem enviados lembretes.
`active`	Os lembretes seguem o calendário da empresa.
`partially_paid`	Parte do montante foi registada como paga; os lembretes usam o montante em falta.
`paid`	Totalmente paga. Os lembretes futuros param.
`paused`	Os lembretes ficam em espera até serem retomados.
`disputed`	O cliente contesta o montante; não são enviados lembretes.
`cancelled`	Encerrada sem pagamento. Não são enviados lembretes.

Montantes

Envie os montantes como strings com até duas casas decimais, por exemplo "1250.00". A vírgula é aceite como separador decimal ("1250,50"). Os montantes têm de ser positivos.

As respostas devolvem unidades menores inteiras: amount_minor: 125000 corresponde a 1250,00. As moedas suportadas são EUR, GBP, TRY e USD. O RemindCash nunca converte entre moedas.

Datas e horas

due_date é uma data de calendário local no formato YYYY-MM-DD, não um carimbo temporal.
Os instantes, como recorded_at ou submitted_at, são carimbos temporais ISO 8601 em UTC.
As horas de envio dos lembretes são calculadas no fuso horário IANA da empresa (ou do cliente), incluindo as mudanças da hora de verão.

Versões

Cada resposta de uma cobrança inclui um version — uma impressão digital de 64 caracteres do seu estado atual. Envie-o como expected_version quando atualizar um rascunho. Se a cobrança tiver mudado entretanto, a atualização é rejeitada com 409 conflict em vez de substituir dados mais recentes.

Lembretes e segurança

As chamadas à API nunca enviam lembretes. O envio é decidido pelo motor de lembretes depois da ativação na aplicação. Antes de cada envio, volta a verificar o estado da cobrança, o montante pago, o cancelamento por parte do cliente, o plano e a disponibilidade do canal, para que uma cobrança marcada como paga ou em pausa não seja lembrada.