---
title: "InvoiceSummary"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Billing API

## Fields

- `InvoiceSummary.id` (string, required)
- `InvoiceSummary.number` (string | null, required) — Assigned when the invoice is issued.
- `InvoiceSummary.status` (string, required) — open, paid, void or uncollectible. Treat other values as unknown.
- `InvoiceSummary.overdue` (boolean, required) — Open, not carried forward, and past its due date.
- `InvoiceSummary.carriedForward` (boolean, required) — Below the minimum charge: added to the next invoice instead.
- `InvoiceSummary.carriedIntoInvoiceId` (string | null, required) — The invoice it was carried into, once there is one.
- `InvoiceSummary.periodStart` (string, required)
  - format `date-time`
- `InvoiceSummary.periodEnd` (string, required)
  - format `date-time`
- `InvoiceSummary.currency` (string, required)
- `InvoiceSummary.collectionMethod` (string | null, required) — charge_automatically (the default card) or send_invoice.
- `InvoiceSummary.totalCents` (string, required) — Cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceSummary.startingBalanceCents` (string, required) — Carried from earlier invoices, in cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceSummary.amountDueCents` (string, required) — Cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceSummary.amountPaidCents` (string, required) — Cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceSummary.amountRemainingCents` (string, required) — Cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceSummary.dueAt` (string | null, required)
  - format `date-time`
- `InvoiceSummary.issuedAt` (string | null, required) — When it was issued and numbered.
  - format `date-time`
- `InvoiceSummary.finalizedAt` (string | null, required) — The same as issuedAt.
  - format `date-time`
- `InvoiceSummary.paidAt` (string | null, required)
  - format `date-time`


Source: https://docs.ezghcloud.com/billing-api/schemas/InvoiceSummary/index.md