SettingsInvoicesTenants

Configurações de faturas

payOff

object

Configurações de quitação.

fine

object

Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor da multa representado em base decimal. A Multa é cobrada uma única vez independente do número de dias de vencimento. O valor máximo para multa é de 2% (0.02).

Example: 0.02

daysToStart integer

Quantidade de dias após o vencimento que a multa começará a incidir.

Example: 1

interest

object

Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor de juros representado em base decimal e ao mês. O valor máximo permitido é 1% (0.01). Os Juros são definidos ao mês, mas calculo para o pagamento após o vencimento converte para juros ao dia e aplica a quantidade de dias em atraso.

Example: 0.01

daysToStart integer

Quantidade de dias após o vencimento que juro começará a incidir.

Example: 1

allowOverduePayment boolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue

object

Definição de regras para o fechamento da fatura.

type string

Tipo de dias. Absoluto representa uma composição de um determinado dia somado ao valor definido em amount. O resultado dessa soma será considerado a data para fechamento da fatura. Exemplo: dia 5 + amount (3) 08/mês/ano.

Possible values: [absolute]

Example: absolute

amount number

Dia exato ou a quantidade de dias.

Possible values: >= 1 and <= 28

Example: 1

updateInvoiceItemOnInsert boolean

Define se no ato de criar o item de fatura será calculado automaticamente descontos/multa para a fatura em contexto. Os valores base usados nesse cálculos são originados de payOff, customerRecurring ou companyRecurring.

Example: true

customerRecurring

object

Configuração de recorrência de fatura.

fine

object

Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor da multa representado em base decimal. A Multa é cobrada uma única vez independente do número de dias de vencimento. O valor máximo para multa é de 2% (0.02).

Example: 0.02

daysToStart integer

Quantidade de dias após o vencimento que a multa começará a incidir.

Example: 1

interest

object

Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor de juros representado em base decimal e ao mês. O valor máximo permitido é 1% (0.01). Os Juros são definidos ao mês, mas calculo para o pagamento após o vencimento converte para juros ao dia e aplica a quantidade de dias em atraso.

Example: 0.01

daysToStart integer

Quantidade de dias após o vencimento que juro começará a incidir.

Example: 1

allowOverduePayment boolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue

object

Definição de regras para o fechamento da fatura.

type string

Tipo de dias usado no fechamento da fatura. Absoluto representa uma composição de um determinado dia somado ao valor definido em amount. O resultado dessa operação será considerado a data para fechamento da fatura. Exemplo: dia 5 + amount (3) 08/mês/ano.

Possible values: [absolute]

Example: absolute

amount number

Quantidade de dias para fechamento da fatura.

Possible values: >= 1 and <= 28

Example: 10

create

object

Definição de regras para geração de fatura.

autoCreate boolean

Define se a fatura deve ser criada automaticamente.

Example: true

updateInvoiceItemOnInsert boolean

Define se no ato de criar o item de fatura será calculado automaticamente descontos/multa para a fatura em contexto. Os valores base usados nesse cálculos são originados de payOff, customerRecurring ou companyRecurring.

Example: false

companyRecurring

object

Configuração de recorrência de fatura.

fine

object

Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor da multa representado em base decimal. A Multa é cobrada uma única vez independente do número de dias de vencimento. O valor máximo para multa é de 2% (0.02).

Example: 0.02

daysToStart integer

Quantidade de dias após o vencimento que a multa começará a incidir.

Example: 1

interest

object

Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor de juros representado em base decimal e ao mês. O valor máximo permitido é 1% (0.01). Os Juros são definidos ao mês, mas calculo para o pagamento após o vencimento converte para juros ao dia e aplica a quantidade de dias em atraso.

Example: 0.01

daysToStart integer

Quantidade de dias após o vencimento que juro começará a incidir.

Example: 1

allowOverduePayment boolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue

object

Definição de regras para o fechamento da fatura.

type string

Tipo de dias usado no fechamento da fatura. Representa o dia do mês (1 até 28) para fechamento da fatura.

Possible values: [static]

Example: static

amount number

Dia do mês para fechamento da fatura.

Possible values: >= 1 and <= 28

Example: 10

create

object

Definição de regras para geração de fatura.

cutoffDay number

Define o dia limite para a edição de uma fatura, antes que ela seja fechada.

Example: 25

autoCreate boolean

Define se a fatura deve ser criada automaticamente.

Example: true

updateInvoiceItemOnInsert boolean

Define se no ato de criar o item de fatura será calculado automaticamente descontos/multa para a fatura em contexto. Os valores base usados nesse cálculos são originados de payOff, customerRecurring ou companyRecurring.

Example: false
autoMoneyRelocation boolean

Se verdadeiro, o sistema irá fazer o remanejo automático de dinheiro entre as parcelas que possuem valor pago excedente.