IntroduçãoReferência de APICentral de AjudaObter SuporteStatus page
Referência
Start typing to search…

Criar Fatura

post
https://api.iugu.com/v1/invoices

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

Body Params
string
required

E-mail do cliente

string
Defaults to [email protected],[email protected]

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

date
required

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

boolean
Defaults to false

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

string

Define em quantos dias após o vencimento a fatura expira e deixa de poder ser paga. O valor deve estar entre "0" e "120" por padrão. Se informado "0", a fatura poderá ser paga até 23:59:59 do dia de vencimento.

string

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

items
array of objects
required

Itens da fatura. O parâmetro price_cents tem o valor mínimo de 100. Limite de 30 itens em test_mode. Já live_mode não há limites.

items*
payable_with
array of strings

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.

payable_with
payer
object

Informações do Cliente para o Anti Fraude ou Boleto. Dados são obrigatórios para emissão de boletos e Pix.

splits
array of objects

Lista de splits a serém aplicado nas faturas pagas. Para mais informações sobre com funciona o split por fatura

splits
string

ID do Cliente

string

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

string

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

string

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

string

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

boolean

Desliga o e-mail de cancelamento de fatura

boolean

Booleano para Habilitar ou Desabilitar multa por atraso de pagamento

int32

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

int32

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

boolean

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

int32

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.

int32

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.

int32

Valor dos Descontos em centavos

boolean

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

int32

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.

custom_variables
array of objects

Variáveis Personalizadas

custom_variables
boolean

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

early_payment_discounts
array of objects

Quantidade de dias de antecedência para o pagamento receber o desconto (Se enviado, substituirá a configuração atual da conta)

early_payment_discounts
string

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

string

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

int32

Limita quantidade máxima de parcelas. Caso não seja enviado, pegará o padrão configurado na conta.

string

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.

automatic_pix
object

Dados do Payer são obrigatórios para emissão do Pix Automático.

date-time

Data, hora, minuto e segundo que o QRCode irá expirar. Formato ISO 8601 — AAAA-MM-DDTHH:MM:SS-00:00

string

140 caracteres. Informações do Remetente. A exibição da informação dependerá do app do Banco.

pix_additional_info
array of objects

Máximo 5 itens. A exibição da informação dependerá do app do Banco.

pix_additional_info
string

Senha para o cliente final abrir a fatura.

string
Responses

Updated about 1 month ago

Language
Credentials
Query
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago