ChartMogul icon

ChartMogul

Interact with ChartMogul API

Actions88

Customer → List Customer's Invoices

AI-generated

Summary

Fetches paginated invoices associated with a specific ChartMogul customer.

Inputs

  • customerUUID (required) — The ChartMogul UUID of the customer whose invoices to list.
  • returnAll — When enabled, iterates through all available pages to return the complete list of invoices.
  • limit — Maximum number of results to return per page. Defaults to 50. Only used if 'Return All' is disabled.
  • validationType — Filters invoices by validation status: 'valid', 'invalid', or 'all'. Defaults to 'valid'.
  • requestOptions — Advanced options including batching (throttling requests), proxy settings, and SSL timeout configuration.

Output shape

A list of items, each containing invoice data (e.g., ID, date, amount).

The 'returnAll' parameter triggers pagination. The response structure includes the invoice data nested under an 'invoices' key.

Examples

Example 1: Retrieve all invoices for a specific customer.

Set Customer UUID and enable 'Return All'.

Example 2: Fetch a specific number of recent invoices with a limit.

Set Customer UUID and a Limit (e.g., 20).

Example 3: Retrieve all invoices including those currently marked invalid.

Set Customer UUID, enable 'Return All', and set Validation Type to 'all'.

Links

Discussion