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 here.

In addition to the table fields, the shortcode also makes one additional “field” available to you:

  • Balance“, which is a virtual or computed field, showing the difference between the invoice total and the amount(s) paid,

You can specify your own headers for each column. If you choose not to, the shortcode will use the field names from the invoice table.

This shortcode does NOT supports conditional branching with [ELSE_list_invoices].

Shortcode nesting is NOT supported.

Parameters:

invoice_type Can be ‘all’, ‘product’ or ‘subscription’. Please note that only the first character is needed, ‘a’, ‘p’ or ‘s’.
Required: No, defaults to ‘all’.
status Is used to filter the list based on “paid” status. Can be ‘all, ‘paid’ or ‘unpaid’. Please not that only the first character is needed.
Required: No, defaults to ‘all’.
columns: Is used to specify the fields to be used for the column values. These can be: Id, ContactId, DateCreated, InvoiceTotal, TotalPaid, TotalDue, PayStatus, CreditStatus, RefundStatus, PayPlanStatus, AffiliateId, LeadAffiliateId, PromoCode, InvoiceType, Description, ProductSold, Synced, Balance, ProductName, ProductType.
Required: No.
Default: ‘Id, Description, DateCreated, InvoiceTotal, TotalPaid, TotalDue, RefundStatus, Balance’.
columns Is used to specify the fields to be used for the column values. These can be: Id, ContactId, DateCreated, InvoiceTotal, TotalPaid, TotalDue, PayStatus, CreditStatus, RefundStatus, PayPlanStatus, AffiliateId, LeadAffiliateId, PromoCode, InvoiceType, Description, ProductSold, Synced, Balance, ProductName, ProductType.
Required: No.
Default: ‘Id, Description, DateCreated, InvoiceTotal, TotalPaid, TotalDue, RefundStatus, Balance’.
headers Is used to specify columns headers for the generate table. The fields to be used for the column values.
Required: No, defaults to the default column names.

Example:

API:

There is no API function equivalent for this shortcode.