---
title: "Gets list of Recurring Invoices"
method: GET
path: "/api/RecurringInvoice"
tags: ["RecurringInvoice"]
---

# Gets list of Recurring Invoices

`GET /api/RecurringInvoice`

## Query parameters

- `UpdatedAfter` string, date-time
- `pageSize` integer
- `pageNumber` integer
- `Sort` string
- `CompanyIDFK` integer

## Response `200`

Returns a paginated list of recurring invoice profiles.

- RecurringInvoiceList — Paginated collection of recurring invoice profiles.
  - `TotalCount` integer — The total number of recurring invoice profiles matching the query.
  - `PageNumber` integer — The current page number of the result set.
  - `PageSize` integer — The number of records per page.
  - `RecurringInvoices` RecurringInvoice[] — The recurring invoice profiles for the current page.
    - `RecurringInvoiceID` integer — Unique identifier for the recurring invoice profile.
    - `AccountIDFK` integer — The account this recurring invoice profile belongs to.
    - `ProfileName` string — A friendly name for the recurring invoice profile.
    - `CompanyIDFK` integer — The ID of the customer company this recurring invoice is billed to.
    - `CompanyName` string — The name of the customer company this recurring invoice is billed to.
    - `RecurringProfileStatusCode` string — Status of the recurring profile (e.g. Active, Paused, Completed).
    - `RecurringProfileFrequencyCode` string — The frequency at which invoices are generated (e.g. Weekly, Monthly, Yearly).
    - `CustomFrequencyNumber` integer — For custom frequency profiles, the number of units between invoice generations.
    - `StartDate` string, date-time — The date the recurring profile first generates an invoice.
    - `NumberOfCycles` integer — The total number of invoice cycles configured for this profile. Null if the profile never expires.
    - `NumberOfCyclesRemaining` integer — The number of invoice cycles remaining before the profile completes. Null if the profile never expires.
    - `LastInvoiceDate` string, date-time — The date the most recent invoice was generated from this profile.
    - `NextInvoiceDate` string, date-time — The date the next invoice will be generated from this profile.
    - `NeverExpires` boolean — Whether the profile continues generating invoices indefinitely with no expiry.
    - `TransactionTaxConfigCode` string — Specifies whether generated invoices are tax exclusive or tax inclusive (e.g. EX, INC).
    - `Subject` string — The subject/title text that appears on generated invoices.
    - `Notes` string — Additional notes or terms that appear on generated invoices.
    - `TaxAmount` number, double — The total tax amount on the recurring invoice profile.
    - `SubtotalAmount` number, double — The subtotal amount before tax and discounts.
    - `DiscountAmount` number, double — The total discount amount applied to the profile.
    - `TotalAmount` number, double — The total amount including tax and after discounts.
    - `CurrencyCode` string — The ISO 3-letter currency code for the generated invoices.
    - `ExchangeRate` number, double — The exchange rate applied when the invoice currency differs from the account default currency.
    - `DateCreated` string, date-time — The date and time this recurring invoice profile was created.
    - `DateUpdated` string, date-time — The date and time this recurring invoice profile was last updated.
    - `isAutoChargeEnabled` boolean — Whether automatic charging is enabled for this recurring profile.
    - `LineItems` RecurringInvoiceLineItem[] — The line items that will appear on each generated invoice.
      - `RecurringInvoiceLineItemID` integer — Unique identifier for the recurring invoice line item.
      - `InventoryItemIDFK` integer — The ID of the inventory item associated with this line item.
      - `InventoryItemName` string — The name of the inventory item for this line item.
      - `InventoryItemSKU` string — The SKU code of the inventory item for this line item.
      - `Description` string — A description for the line item as it appears on generated invoices.
      - `Quantity` number, double — The quantity for the line item.
      - `UnitPrice` number, double — The unit price for the line item.
      - `TaxAmount` number, double — The tax amount calculated for the line item.
      - `TaxIDFK` integer — The ID of the tax rate applied to this line item.
      - `TaxCode` string — The tax code of the tax rate applied to this line item.
      - `TaxName` string — The display name of the tax rate applied to this line item.
      - `ProjectIDFK` integer — The ID of the project associated with this line item for reporting purposes.
      - `ProjectTitle` string — The title of the project associated with this line item.
      - `Amount` number, double — The total amount for the line item (quantity multiplied by unit price, after discount, before tax).
      - `Discount` number, double — The discount percentage applied to this line item.
    - `ViewRecurringInvoiceURL` string — URL to view this recurring invoice in the Avaza web application.

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/avaza/apis/avaza-api-documentation.md) · [All operations](https://skmtc.net/avaza/apis/avaza-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avaza/avaza-api-documentation/versions/1eeadf750514/schema)