periods

Emite uma nova fatura baseada em um período.

Há 2 casos onde pode ser necessário gerar uma nova fatura manualmente a partir de um período:

  1. Gerar uma fatura que não foi emitida automaticamente por falta de informações de registro de uso;
  2. Gerar uma fatura adicional para um período.

A plataforma Vindi tenta gerar automaticamente uma nova fatura na data especificada no atributo billing_at do período utilizando todos os registros de utilização não faturados até então. A nova fatura é gerada apenas se todos os itens ativos da assinatura possuírem ao menos um registro de utilização, mesmo que algum deles possua o campo quantity explicitamente igual a zero.

Este comportamento é necessário para evitar a emissão de faturas que não receberam registros de utilização, seja por esquecimento do operador do sistema ou por algum tipo de falha na transmissão dessa informação. Para verificar esses períodos que não foram faturados, consulte o relatório "Períodos não faturados" e pesquise pela data da cobrança programada.

Exemplo

Suponha uma assinatura com a cobrança programada para o último dia do período contendo dois produtos:

Mensalidade: Preço fixo - R$ 100,00
Horas de suporte: Preço variável por volume - R$ 15,00/hora

O primeiro período será criado com um único registro de utilização com quantidade igual a 1 representando o produto "Mensalidade". A plataforma espera que a quantidade de "Horas de suporte" seja informada via API ou pelo operador do sistema. Se isto não acontecer até a data de cobrança do período, a plataforma não irá gerar a fatura automaticamente. Neste caso espera-se que a fatura seja gerada a partir do painel de administração ou deste método via API.

Como mencionado acima, também é possível gerar uma fatura adicional incluindo registros de uso que ainda não foram faturados. Isso pode acontecer quando você deseja incluir alguma cobrança adicional no período e faz questão de manter a referência do período.

post/v1/periods/{id}/bill

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/periods/{id}/bill
  • Auth
    HTTP basic

Path parameters

idinteger required

ID do período onde a fatura será gerada.

Response

Fatura gerada com sucesso.

idinteger required

ID do período

billing_atstring

Data para geração automática da cobrança do período

cycleinteger required

Ciclo do período

start_atstring required

Data e hora do início do período

end_atstring required

Data e hora do término do período

durationinteger required

Duração do período em número de segundos

created_atstring required

Data e hora da geração do período

updated_atstring required

Data e hora da última atualização do período

Changes

No recorded changes to this operation across all 1 revision of this API.