Billhighway Cloud API

<back to all web services

RecurringInvoiceListRequest

The following routes are available for this service:
GET/invoices/recurringInvoices
import Foundation
import ServiceStack

public class RecurringInvoiceListRequest : Codable
{
    public var groupID:String?

    required public init(){}
}

public class RecurringInvoiceListResponse : Codable
{
    public var results:[RecurringInvoiceListResponseItem] = []

    required public init(){}
}

public class RecurringInvoiceListResponseItem : Codable
{
    public var groupID:String?
    public var recurringInvoiceID:Int?
    public var billingTypeID:Int?
    public var billingTypeName:String?
    public var invoiceDescription:String?
    public var amount:Double?
    public var processingCurrency:String?
    public var frequencyDescription:String?
    public var effectiveDate:Date?
    public var endDate:Date?
    public var nextDueDate:Date?
    public var donationCoaNum:String?
    public var donationCoaDesc:String?
    public var isActive:Bool?
    public var frequencySummary:String?

    required public init(){}
}


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