Sign in

v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Criar Fatura

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

post/invoices

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

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.<br>

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 "120" dias após a data de vencimento.

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.

customer_idstring

ID do Cliente

subscription_idstring

Amarra esta Fatura com a Assinatura especificada. Caso ocorra o pagamento desta fatura, a ciclagem da assinatura acontecerá normalmente.

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

ignore_due_emailboolean

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

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.

order_idstring

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

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. Caso não seja enviado, pegará o padrão configurado na conta.

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.

pix_qr_code_expires_atstring date-time

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

pix_remittance_infostring

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

passwordstring

Senha para o cliente final abrir a fatura.

RAW_BODYstring

Response

200

idstring
due_datestring
currencystring
discount_centsinteger
emailstring
items_total_centsinteger
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:notification_url","oasType":"schema","type":"unknown"}
return_urlstring
statusstring
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:tax_cents","oasType":"schema","type":"unknown"}
total_centsinteger
total_paid_centsinteger
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:taxes_paid_cents","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:paid_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:paid_cents","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:cc_emails","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:financial_return_date","oasType":"schema","type":"unknown"}
payable_withstring
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:overpaid_cents","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:ignore_due_email","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:ignore_canceled_email","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:advance_fee_cents","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:commission_cents","oasType":"schema","type":"unknown"}
early_payment_discountboolean
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:order_id","oasType":"schema","type":"unknown"}
updated_atstring
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:credit_card_brand","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:credit_card_bin","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:credit_card_last_4","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:credit_card_captured_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:credit_card_tid","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:external_reference","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:max_installments_value","oasType":"schema","type":"unknown"}
payer_namestring
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:payer_email","oasType":"schema","type":"unknown"}
payer_cpf_cnpjstring
payer_phonestring
payer_phone_prefixstring
payer_address_zip_codestring
payer_address_streetstring
payer_address_districtstring
payer_address_citystring
payer_address_statestring
payer_address_numberstring
payer_address_complementstring
payer_address_countrystring
late_payment_fineinteger
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:late_payment_fine_cents","oasType":"schema","type":"unknown"}
split_idstring
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:external_payment_id","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:external_payment_description","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:payment_booklet_id","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:subscription_id","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:credit_card_transaction","oasType":"schema","type":"unknown"}
account_idstring
bank_account_branchstring
bank_account_numberstring
account_namestring
secure_idstring
secure_urlstring
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:customer_id","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:customer_ref","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:customer_name","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:user_id","oasType":"schema","type":"unknown"}
totalstring
taxes_paidstring
total_paidstring
total_overpaidstring
total_refundedstring
fine_centsinteger
commissionstring
fines_on_occurrence_daystring
total_on_occurrence_daystring
fines_on_occurrence_day_centsinteger
total_on_occurrence_day_centsinteger
refunded_centsinteger
remaining_captured_centsinteger
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:advance_fee","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:estimated_advance_fee","oasType":"schema","type":"unknown"}
paidstring
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:original_payment_id","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:double_payment_id","oasType":"schema","type":"unknown"}
per_day_interestboolean
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:per_day_interest_value","oasType":"schema","type":"unknown"}
per_day_interest_centsinteger
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:interest","oasType":"schema","type":"unknown"}
discountstring
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:duplicated_invoice_id","oasType":"schema","type":"unknown"}
bank_slip_extra_dueinteger
created_atstring
created_at_isostring
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:authorized_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:authorized_at_iso","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:expired_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:expired_at_iso","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:refunded_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:refunded_at_iso","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:canceled_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:canceled_at_iso","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:protested_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:protested_at_iso","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:chargeback_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:chargeback_at_iso","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:occurrence_date","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:refundable","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:installments","oasType":"schema","type":"unknown"}
transaction_numberinteger
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:payment_method","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices:post:responses:200:content:application/json:schema:properties:financial_return_dates","oasType":"schema","type":"unknown"}
early_payment_discountsobject[]

Example response

{
  "id": "EBB161AAB22849BFA047D5F1DF55AEE9",
  "due_date": "2025-04-02",
  "currency": "BRL",
  "discount_cents": 24,
  "email": "email@iugu.com",
  "items_total_cents": 400,
  "return_url": "https://google.com",
  "status": "pending",
  "total_cents": 376,
  "payable_with": "all",
  "updated_at": "2025-04-02T13:14:27-03:00",
  "payer_name": "John",
  "payer_cpf_cnpj": "11343675030",
  "payer_phone": "971113024",
  "payer_phone_prefix": "11",
  "payer_address_zip_code": "13056-344",
  "payer_address_street": "Rua Antônio Nunes",
  "payer_address_district": "Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)",
  "payer_address_city": "Campinas",
  "payer_address_state": "SP",
  "payer_address_number": "21",
  "payer_address_complement": "AP1702",
  "payer_address_country": "Brasil",
  "split_id": "3270D0BAB8074BDE98E382340338550C",
  "variables": [
    {
      "variable": "barcode_v1",
      "value": "40197103900000003762025092000000000000200864"
    }
  ],
  "custom_variables": [
    {
      "name": "Minha variável",
      "value": "DSAY312HKD312JH"
    }
  ],
  "logs": [
    {
      "id": "F34952A91D364C1AA2C827F62615239D",
      "description": "Email de Fatura enviado!",
      "notes": "Fatura enviada com sucesso para: email@iugu.com",
      "created_at": "02/04, 13:14"
    }
  ],
  "account_id": "44C5DC6376804D1FA792CBCA382105C1",
  "bank_account_branch": "0001",
  "bank_account_number": "2739435-0",
  "account_name": "Nome da Conta",
  "secure_id": "ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03",
  "secure_url": "https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03",
  "total": "R$ 3,76",
  "taxes_paid": "R$ 0,00",
  "total_paid": "R$ 0,00",
  "total_overpaid": "R$ 0,00",
  "total_refunded": "R$ 0,00",
  "commission": "R$ 0,00",
  "fines_on_occurrence_day": "R$ 0,00",
  "total_on_occurrence_day": "R$ 0,00",
  "paid": "R$ 0,00",
  "discount": "R$ 0,24",
  "bank_slip_extra_due": 1,
  "created_at": "02/04, 13:14",
  "created_at_iso": "2025-04-02T13:14:26-03:00",
  "transaction_number": 412825250927504,
  "bank_slip": {
    "digitable_line": "40192025089200000000700002008647710390000000376",
    "barcode_data": "40197103900000003762025092000000000000200864",
    "barcode": "https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode",
    "bank_slip_url": "https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip",
    "bank_slip_pdf_url": "https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf",
    "bank_slip_bank": 401,
    "bank_slip_status": "pending",
    "recipient_cpf_cnpj": "42135294870"
  },
  "pix": {
    "qrcode": "https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03",
    "qrcode_text": "00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6",
    "status": "qr_code_created"
  },
  "items": [
    {
      "id": "03B951855B92410890A0EA5742636E96",
      "description": "Nome do Item",
      "price_cents": 300,
      "quantity": 1,
      "created_at": "2025-04-02T13:14:26-03:00",
      "updated_at": "2025-04-02T13:14:26-03:00",
      "price": "R$ 3,00"
    }
  ],
  "split_rules": [
    {
      "id": "AB1B22F356464105A3C17BA18A640BA9",
      "split_id": "3270D0BAB8074BDE98E382340338550C",
      "recipient_account_id": "E638DCED176240E4A510510C065FB52D",
      "cents": 10,
      "percent": 1,
      "permit_aggregated": true,
      "created_at": "2025-04-02T13:14:26-03:00",
      "updated_at": "2025-04-02T13:14:26-03:00"
    }
  ]
}