academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Invoices → List invoices

AI-generated

Summary

Lists invoices from the academyFIVE API, with optional pagination, filters, and related resources to include. The node sends one request per input item and returns the API response as JSON items.

Inputs

  • page[number] — Page to fetch; pagination starts at 1. The UI documents a default of 1.
  • page[size] — Number of results per page. The UI documents a default of 50.
  • filter[ids] — Comma-separated invoice IDs to return.
  • filter[invoiceNumber] — Invoice number to filter by.
  • filter[profileId] — Student profile ID to filter by.
  • filter[bookingId] — Booking ID to filter by.
  • filter[statusId] — Invoice status ID to filter by: 1 open, 2 paid, 3 canceled, 4 collection, 5 first reminder, 6 second reminder, 7 planning, 8 queued to open, or 9 queued to cancelled.
  • filter[companyId] — Company ID to filter by.
  • filter[invoiceDateFrom] — Include invoices dated on or after this YYYY-MM-DD date.
  • filter[invoiceDateTo] — Include invoices dated on or before this YYYY-MM-DD date.
  • include — Comma-separated related resources to include, such as invoice-positions for line items.

Output shape

A list of JSON items from the API response, paired with their input item.

If continue-on-fail is enabled, a failed request produces a JSON item with an error field. Pagination is controlled with page[number] and page[size]; the operation does not automatically fetch additional pages.

Examples

Example 1: Fetch paid invoices for one student, including line items

Set filter[profileId] to the student's profile ID, filter[statusId] to 2, and include to invoice-positions.

Links

Discussion