Billhighway Cloud API

<back to all web services

RecurringInvoiceListRequest

The following routes are available for this service:
GET/invoices/recurringInvoices
import java.math.*
import java.util.*
import net.servicestack.client.*


open class RecurringInvoiceListRequest
{
    var GroupID:String? = null
}

open class RecurringInvoiceListResponse
{
    var Results:ArrayList<RecurringInvoiceListResponseItem> = ArrayList<RecurringInvoiceListResponseItem>()
}

open class RecurringInvoiceListResponseItem
{
    var GroupID:String? = null
    var RecurringInvoiceID:Int? = null
    var BillingTypeID:Int? = null
    var BillingTypeName:String? = null
    var InvoiceDescription:String? = null
    var Amount:BigDecimal? = null
    var ProcessingCurrency:String? = null
    var FrequencyDescription:String? = null
    var EffectiveDate:Date? = null
    var EndDate:Date? = null
    var NextDueDate:Date? = null
    var DonationCoaNum:String? = null
    var DonationCoaDesc:String? = null
    var IsActive:Boolean? = null
    var FrequencySummary:String? = null
}

Kotlin RecurringInvoiceListRequest DTOs

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
		}
	]
}