i4w_list_invoices
Usage
This shortcode enables you to display a list of invoices to your subscribers, based on the currently logged in user.
By using different parameter combinations, this shortcode can be used to display different views of the invoices on file in your system, such as the "invoicetype" filter set to "all", "product" or "subscription" invoices.
With the "status" filter, you can choose "all", "paid" or "unpaid".
You can also specify which fields you want included in the table display. The "official" list of accepted field names can be found in the Keap table schema documentation.
In addition to the table fields, the shortcode also makes one additional "field" available: Balance, which is a virtual or computed field, showing the difference between the invoice total and the amount(s) paid.
[ELSE_list_invoices] conditional branching is NOT supported.
Shortcode nesting is NOT supported.
Parameters
| Parameter | Description | Default | Required |
|---|---|---|---|
| invoice_type | Can be 'all', 'product' or 'subscription'. Only the first character is needed ('a', 'p' or 's'). | all | No |
| status | Filter the list based on paid status. Can be 'all', 'paid' or 'unpaid'. Only the first character is needed. | all | No |
| columns | Fields to be used for the column values. Available: Id, ContactId, DateCreated, InvoiceTotal, TotalPaid, TotalDue, PayStatus, CreditStatus, RefundStatus, PayPlanStatus, AffiliateId, LeadAffiliateId, PromoCode, InvoiceType, Description, ProductSold, Synced, Balance, ProductName, ProductType. | Id, Description, DateCreated, InvoiceTotal, TotalPaid, TotalDue, RefundStatus, Balance | No |
| headers | Column headers for the generated table. | Field names | No |
Example
[i4w_list_invoices]
[i4w_list_invoices invoice_type='product']
[i4w_list_invoices invoice_type='subscription' status='unpaid']
[i4w_list_invoices columns='DateCreated,InvoiceTotal,TotalPaid' headers='Date,Total,Paid']