Billhighway Cloud API

<back to all web services

RecurringInvoiceListRequest

The following routes are available for this service:
GET/invoices/recurringInvoices
RecurringInvoiceListRequest Parameters:
NameParameterData TypeRequiredDescription
GroupIDquerystringNo
RecurringInvoiceListResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<RecurringInvoiceListResponseItem>No
RecurringInvoiceListResponseItem Parameters:
NameParameterData TypeRequiredDescription
GroupIDformstringNo
RecurringInvoiceIDformintNo
BillingTypeIDformintNo
BillingTypeNameformstringNo
InvoiceDescriptionformstringNo
AmountformdecimalNo
ProcessingCurrencyformstringNo
FrequencyDescriptionformstringNo
EffectiveDateformDateTimeNo
EndDateformDateTime?No
NextDueDateformDateTimeNo
DonationCoaNumformstringNo
DonationCoaDescformstringNo
IsActiveformboolNo
FrequencySummaryformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /invoices/recurringInvoices HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			GroupID: String,
			RecurringInvoiceID: 0,
			BillingTypeID: 0,
			BillingTypeName: String,
			InvoiceDescription: String,
			Amount: 0,
			ProcessingCurrency: String,
			FrequencyDescription: String,
			EffectiveDate: 0001-01-01,
			EndDate: 0001-01-01,
			NextDueDate: 0001-01-01,
			DonationCoaNum: String,
			DonationCoaDesc: String,
			IsActive: False,
			FrequencySummary: String
		}
	]
}