v1

Swagger 2.02026-07-13107162315.5 KB
RecurringInvoice

Retrieves a single recurring invoice profile by its ID, including line items, schedule configuration, and next invoice date.

get/api/RecurringInvoice/{id}

Path parameters

idinteger required

Recurring Invoice Profile ID number

Response

Returns the recurring invoice profile with line items and schedule.

RecurringInvoiceIDinteger

Unique identifier for the recurring invoice profile.

AccountIDFKinteger

The account this recurring invoice profile belongs to.

ProfileNamestring

A friendly name for the recurring invoice profile.

CompanyIDFKinteger

The ID of the customer company this recurring invoice is billed to.

CompanyNamestring

The name of the customer company this recurring invoice is billed to.

RecurringProfileStatusCodestring

Status of the recurring profile (e.g. Active, Paused, Completed).

RecurringProfileFrequencyCodestring

The frequency at which invoices are generated (e.g. Weekly, Monthly, Yearly).

CustomFrequencyNumberinteger

For custom frequency profiles, the number of units between invoice generations.

StartDatestring date-time

The date the recurring profile first generates an invoice.

NumberOfCyclesinteger

The total number of invoice cycles configured for this profile. Null if the profile never expires.

NumberOfCyclesRemaininginteger

The number of invoice cycles remaining before the profile completes. Null if the profile never expires.

LastInvoiceDatestring date-time

The date the most recent invoice was generated from this profile.

NextInvoiceDatestring date-time

The date the next invoice will be generated from this profile.

NeverExpiresboolean

Whether the profile continues generating invoices indefinitely with no expiry.

TransactionTaxConfigCodestring

Specifies whether generated invoices are tax exclusive or tax inclusive (e.g. EX, INC).

Subjectstring

The subject/title text that appears on generated invoices.

Notesstring

Additional notes or terms that appear on generated invoices.

TaxAmountnumber double

The total tax amount on the recurring invoice profile.

SubtotalAmountnumber double

The subtotal amount before tax and discounts.

DiscountAmountnumber double

The total discount amount applied to the profile.

TotalAmountnumber double

The total amount including tax and after discounts.

CurrencyCodestring

The ISO 3-letter currency code for the generated invoices.

ExchangeRatenumber double

The exchange rate applied when the invoice currency differs from the account default currency.

DateCreatedstring date-time

The date and time this recurring invoice profile was created.

DateUpdatedstring date-time

The date and time this recurring invoice profile was last updated.

isAutoChargeEnabledboolean

Whether automatic charging is enabled for this recurring profile.

ViewRecurringInvoiceURLstring

URL to view this recurring invoice in the Avaza web application.