v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Extrato de Faturas

Retorna o extrato de faturas de uma conta.

get/accounts/invoices

Query parameters

yearstring

Ano

monthstring

Mês

statusstring

Filtrar pelo status da fatura. ("pending", "paid", "partially_paid", "externally_paid", "refunded", "expired", "canceled", "in_protest", "chargeback")

Response

200

idstring

created_atstring

due_datestring

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:occurrence_date","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:paid_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:refunded_at","oasType":"schema","type":"unknown"}

pending_valuestring

paid_valuestring

taxes_paidstring

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:payment_method","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:installments","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:customer_id","oasType":"schema","type":"unknown"}

customer_emailstring

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:customer_name","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:subscription_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:receivable_date","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:receivable_reference","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/invoices:get:responses:200:content:application/json:schema:items:properties:receivable_total","oasType":"schema","type":"unknown"}

commissionstring

statusstring

Example response

[
  {
    "id": "111D480C111147B08D0603548A078B40",
    "created_at": "2024-08-01T14:45:11-03:00",
    "due_date": "2024-08-18",
    "pending_value": "40.00 BRL",
    "paid_value": "0.00 BRL",
    "taxes_paid": "0.00 BRL",
    "customer_email": "teste.teste@iugu.com",
    "commission": "0.00 BRL",
    "status": "pending"
  }
]