EventCatalog | Entities | Invoice

Invoice (v1.0.0)

Represents a bill issued to a customer, detailing charges for products or services.

Overview

The Invoice entity represents a formal request for payment issued by the business to a customer. It details the products, services, quantities, prices, taxes, and total amount due, along with payment terms.

Entity Properties

Name	Type	Required	Description
`invoiceId`	`UUID`	Required	Unique identifier for the invoice.
`customerId`	`UUID`	Required	Identifier of the customer being invoiced
`orderId`	`UUID`	Optional	Identifier of the associated order, if applicable.
`subscriptionId`	`UUID`	Optional	Identifier of the associated subscription, if applicable.
`invoiceNumber`	`string`	Required	Human-readable, sequential identifier for the invoice (may have specific format).
`issueDate`	`Date`	Required	Date the invoice was generated and issued.
`dueDate`	`Date`	Required	Date by which the payment for the invoice is due.
`totalAmount`	`decimal`	Required	The total amount due on the invoice.
`currency`	`string`	Required	Currency of the invoice amount.
`status`	`string`	Required	Current status of the invoice.
`billingAddressId`	`UUID`	Required	Identifier for the billing address used on this invoice.
`lineItems`	`array`	Required	List of individual items or services being charged on the invoice.
`createdAt`	`DateTime`	Required	Timestamp when the invoice record was created.
`paidAt`	`DateTime`	Optional	Timestamp when the invoice was marked as paid.

Relationships

Customer: An invoice is issued to one Customer.
Order/Subscription: An invoice may be related to one or more Orders or a specific Subscription period.
Payment: An invoice is settled by one or more Payment transactions.
InvoiceLineItem: An invoice contains multiple InvoiceLineItems detailing the charges.
BillingProfile: Invoice generation often uses details from the customer’s BillingProfile.

Examples

Invoice #INV-00123 issued to Jane Doe for her monthly subscription renewal, due in 15 days.
Invoice #INV-00124 issued to Acme Corp for consulting services rendered in the previous month, status Paid.