Billhighway Cloud API

RecurringInvoiceListRequest

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

**RecurringInvoiceListRequest** Parameters:
Name	Parameter	Data Type	Required	Description
GroupID	query	string	No

**RecurringInvoiceListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Results	form	List<RecurringInvoiceListResponseItem>	No

**RecurringInvoiceListResponseItem** Parameters:
Name	Parameter	Data Type	Required
GroupID	form	string	No
RecurringInvoiceID	form	int	No
BillingTypeID	form	int	No
BillingTypeName	form	string	No
InvoiceDescription	form	string	No
Amount	form	decimal	No
ProcessingCurrency	form	string	No
FrequencyDescription	form	string	No
EffectiveDate	form	DateTime	No
EndDate	form	DateTime?	No
NextDueDate	form	DateTime	No
DonationCoaNum	form	string	No
DonationCoaDesc	form	string	No
IsActive	form	bool	No
FrequencySummary	form	string	No

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>