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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecurringInvoiceListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
  <Results>
    <RecurringInvoiceListResponseItem>
      <Amount>0</Amount>
      <BillingTypeID>0</BillingTypeID>
      <BillingTypeName>String</BillingTypeName>
      <DonationCoaDesc>String</DonationCoaDesc>
      <DonationCoaNum>String</DonationCoaNum>
      <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <FrequencyDescription>String</FrequencyDescription>
      <FrequencySummary>String</FrequencySummary>
      <GroupID>String</GroupID>
      <InvoiceDescription>String</InvoiceDescription>
      <IsActive>false</IsActive>
      <NextDueDate>0001-01-01T00:00:00</NextDueDate>
      <ProcessingCurrency>String</ProcessingCurrency>
      <RecurringInvoiceID>0</RecurringInvoiceID>
    </RecurringInvoiceListResponseItem>
  </Results>
</RecurringInvoiceListResponse>