v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Enviar Fatura por Email

Envia a fatura iugu para o email vinculado a ela.

post/invoices/{id}/send_email

Path parameters

idstring required

ID da fatura.

Response

200

idstring

due_datestring

currencystring

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:discount_cents","oasType":"schema","type":"unknown"}

emailstring

items_total_centsinteger

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:notification_url","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:return_url","oasType":"schema","type":"unknown"}

statusstring

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:tax_cents","oasType":"schema","type":"unknown"}

total_centsinteger

total_paid_centsinteger

taxes_paid_centsinteger

paid_atstring

paid_centsinteger

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:cc_emails","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:financial_return_date","oasType":"schema","type":"unknown"}

payable_withstring

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:overpaid_cents","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:ignore_due_email","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:ignore_canceled_email","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:advance_fee_cents","oasType":"schema","type":"unknown"}

commission_centsinteger

early_payment_discountboolean

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:order_id","oasType":"schema","type":"unknown"}

updated_atstring

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:credit_card_brand","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:credit_card_bin","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:credit_card_last_4","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:credit_card_captured_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:credit_card_tid","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:external_reference","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:max_installments_value","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_name","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_email","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_cpf_cnpj","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_phone","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_phone_prefix","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_address_zip_code","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_address_street","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_address_district","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_address_city","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_address_state","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_address_number","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_address_complement","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payer_address_country","oasType":"schema","type":"unknown"}

late_payment_fineinteger

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:late_payment_fine_cents","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:split_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:external_payment_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:external_payment_description","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:payment_booklet_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:subscription_id","oasType":"schema","type":"unknown"}

custom_variablesobject[]

{"stackTrail":"paths:/invoices/{id}/send_email: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/{id}/send_email:post:responses:200:content:application/json:schema:properties:customer_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:customer_ref","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:customer_name","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email: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/{id}/send_email:post:responses:200:content:application/json:schema:properties:advance_fee","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:estimated_advance_fee","oasType":"schema","type":"unknown"}

paidstring

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:original_payment_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:double_payment_id","oasType":"schema","type":"unknown"}

per_day_interestboolean

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:per_day_interest_value","oasType":"schema","type":"unknown"}

per_day_interest_centsinteger

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:interest","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:discount","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email: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/{id}/send_email:post:responses:200:content:application/json:schema:properties:authorized_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:authorized_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:expired_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:expired_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:refunded_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:refunded_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:canceled_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:canceled_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:protested_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:protested_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:chargeback_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:chargeback_at_iso","oasType":"schema","type":"unknown"}

occurrence_datestring

refundableboolean

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:installments","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:transaction_number","oasType":"schema","type":"unknown"}

payment_methodstring

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:financial_return_dates","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:bank_slip","oasType":"schema","type":"unknown"}

early_payment_discountsobject[]

{"stackTrail":"paths:/invoices/{id}/send_email:post:responses:200:content:application/json:schema:properties:split_rules","oasType":"schema","type":"unknown"}

Example response

{
  "id": "AB1136DB52934C629DEE3CAC141C0C3E",
  "due_date": "2025-02-18",
  "currency": "BRL",
  "email": "email@iug.com",
  "items_total_cents": 300,
  "status": "paid",
  "total_cents": 300,
  "total_paid_cents": 300,
  "taxes_paid_cents": 3,
  "paid_at": "2025-02-18T16:26:19-03:00",
  "paid_cents": 300,
  "payable_with": "pix",
  "updated_at": "2025-02-18T16:26:20-03:00",
  "variables": [
    {
      "variable": "payment_method",
      "value": "iugu_pix"
    }
  ],
  "logs": [
    {
      "id": "3B0FFB20DCC94F34AA2AD5607C7D521B",
      "description": "Fatura visualizada via checkout",
      "notes": "Fatura visualizada!!",
      "created_at": "02/04, 14:58"
    }
  ],
  "account_id": "44C5DC6376804D1FA792CBCA382105C1",
  "bank_account_branch": "0001",
  "bank_account_number": "2739435-0",
  "account_name": "Nome da Conta",
  "secure_id": "ab1136db-5293-4c62-9dee-3cac141c0c3e-9329",
  "secure_url": "https://checkout.iugu.com/invoices/-5293-4c62-9dee-3cac141c0c3e-9329",
  "total": "R$ 3,00",
  "taxes_paid": "R$ 0,03",
  "total_paid": "R$ 3,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$ 3,00",
  "total_on_occurrence_day_cents": 300,
  "remaining_captured_cents": 300,
  "paid": "R$ 3,00",
  "bank_slip_extra_due": 10,
  "created_at": "18/02, 16:15",
  "created_at_iso": "2025-02-18T16:15:32-03:00",
  "occurrence_date": "2025-02-18",
  "refundable": true,
  "payment_method": "iugu_pix",
  "pix": {
    "qrcode": "https://faturas.iugu.com/qr_code/-5293-4c62-9dee-3cac141c0c3e-9329",
    "qrcode_text": "00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/AB1136DB52934C629DEE3CAC141C0C3E52040000530398654043.005802BR5924NOME DA CONTA6009SAO PAULO62070503***6304EC4D",
    "status": "paid",
    "payer_cpf_cnpj": "11122233344",
    "payer_name": "Nome do Pagador",
    "end_to_end_id": "B245436542345231234454Ru9No0iLU",
    "account_number_last_digits": "5132"
  },
  "items": [
    {
      "id": "9A989E79E6094548B10E7A356A06E7DF",
      "description": "Item",
      "price_cents": 300,
      "quantity": 1,
      "created_at": "2025-02-18T16:15:32-03:00",
      "updated_at": "2025-02-18T16:15:32-03:00",
      "price": "R$ 3,00"
    }
  ]
}