InvoicesSummaryResponseDto

Example

JSON

{
  "currency": "string",
  "year": 0,
  "billed_this_year": {
    "amount": 0,
    "count": 0
  },
  "due": {
    "amount": 0,
    "count": 0
  },
  "paid": {
    "amount": 0,
    "count": 0
  },
  "latest_charged_amount": 0,
  "payable_invoice": {
    "id": "string",
    "number": "string",
    "status": "draft",
    "amount": 0,
    "amount_due": 0,
    "currency": "string",
    "description": "string",
    "period_start": "2026-04-20T12:00:00.000Z",
    "period_end": "2026-04-20T12:00:00.000Z",
    "due_date": "2026-04-20T12:00:00.000Z",
    "collection_method": "charge_automatically",
    "created": "2026-04-20T12:00:00.000Z",
    "hosted_invoice_url": "string",
    "invoice_pdf": "string"
  }
}

Properties

7 properties 7 required

currency string Required

ISO 4217 currency of the newest invoice (e.g. `usd`); `usd` with none.

year number Required

The calendar year `billed_this_year` covers.

billed_this_year object Required

Invoices created this calendar year that were finalized (`open`, `paid` or `uncollectible`).

due object Required

Open invoices.

paid object Required

Paid invoices.

latest_charged_amount number Required

Total of the newest finalized invoice, the per-cycle charge; `null` with none.

nullable

payable_invoice object Required

The oldest `open` or `uncollectible` invoice, the one a payment should settle; `null` with none.

nullable

Was this page helpful?

Tell us how we can improve this guide.