Criar Fatura 18x

Cria uma fatura para um cliente. Para mais informações sobre fatura

post/invoices

Request

  • Base URL
    https://api.iugu.com/v1
  • URL
    https://api.iugu.com/v1/invoices
  • Auth
    API key in query parameter api_token

Request body

emailstring required

E-mail do cliente

cc_emailsstring

Endereços de E-mail para cópia separados por vírgula.

due_datestring date required

Data do vencimento. (Formato: 'AAAA-MM-DD').

ensure_workday_due_dateboolean

Se true, garante que a data de vencimento seja apenas em dias de semana, e não em sábados ou domingos.

expires_instring

Expira uma fatura e impossibilita o seu pagamento depois 'x' dias após o vencimento. Valor enviado precisa estar entre 0 e 30. Se for enviado "0", a fatura ficará disponível para ser paga até às 23:59:59 do dia de vencimento.

bank_slip_extra_duestring

Prazo máximo para pagamento do boleto após o vencimento. O prazo máximo para pagamento deve ser entre "1" e "30" dias após a data de vencimento.

return_urlstring

Cliente é redirecionado para essa URL após efetuar o pagamento da Fatura pela página de Fatura da Iugu

expired_urlstring

Cliente é redirecionado para essa URL se a Fatura que estiver acessando estiver expirada

notification_urlstring

URL chamada para todas as notificações de Fatura, assim como os webhooks (Gatilhos) são chamados

ignore_canceled_emailboolean

Desliga o e-mail de cancelamento de fatura

finesboolean

Booleano para Habilitar ou Desabilitar multa por atraso de pagamento

late_payment_fineinteger

Determine a multa % a ser cobrada para pagamentos efetuados após a data de vencimento

late_payment_fine_centsinteger

Determine a multa por valor fixo a ser cobrada para pagamentos efetuados após a data de vencimento

per_day_interestboolean

Booleano que determina se cobra ou não juros por dia de atraso. 1% ao mês pro rata. Necessário passar a multa como true

per_day_interest_valueinteger

Informar o valor percentual de juros que deseja cobrar. Não se aplica quando os valores diários de mora calculados são menores que 1 centavo.

per_day_interest_centsinteger

Juros a ser cobrado por dia em centavos. Sobrepõem o per_day_interest_value. O juros somado em 30 dias deve ser inferior a 50% do valor da fatura.

discount_centsinteger

Valor dos Descontos em centavos

customer_idstring

ID do Cliente

ignore_due_emailboolean

Booleano que ignora o envio do e-mail de cobrança

subscription_idstring

Amarra esta Fatura com a Assinatura especificada. Esta fatura não causa alterações na assinatura vinculada.

payable_withstring[]

Método de pagamento que será disponibilizado para esta Fatura ("all", "credit_card", "bank_slip" ou "pix"). Obs: Caso esta Fatura esteja atrelada à uma Assinatura, a prioridade é herdar o valor atribuído na Assinatura; caso esta esteja atribuído o valor 'all', o sistema considerará o 'payable_with' da Fatura; se não, o sistema considerará o 'payable_with' da Assinatura.

creditsinteger

Caso tenha o 'subscription_id', pode-se enviar o número de créditos a adicionar nessa Assinatura baseada em créditos, quando a Fatura for paga.

early_payment_discountboolean

Ativa ou desativa os descontos por pagamento antecipado. Quando true, sobrepõe as configurações de desconto da conta.

*atenção*object

Informações do cliente abaixo "payer" são obrigatórias para a emissão de boletos ou necessárias para seu sistema de antifraude. Para emissão de <b>Pix</b> apenas o "payer.name" é obrigatório.

order_idstring

Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura.

*Commissions*object

<b style="color: red;">Depreciado e será removido. Utilizar Splits no lugar</b>

external_referencestring

Informação de referência externa, possibilitando a realização de pesquisa. Limite de 60 caracteres.

max_installments_valueinteger

Limita quantidade máxima de parcelas (1 a 18x). Caso não seja enviado, pegará o padrão configurado na conta.

RAW_BODYstring
passwordstring

Senha para o cliente final abrir a fatura.

soft_descriptor_lightstring

Altera a descrição da cobrança no cartão de crédito do cliente final (Até 12 caracteres). Caso não seja enviado, será utilizada a descrição configurada na conta.

Response

200

Changes

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