Billhighway Cloud API

<back to all web services

RecurringInvoiceListRequest

The following routes are available for this service:
GET/invoices/recurringInvoices
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.DTO;

namespace BH.CloudAPI.DTO
{
    public partial class RecurringInvoiceListRequest
    {
        public virtual string GroupID { get; set; }
    }

    public partial class RecurringInvoiceListResponse
    {
        public RecurringInvoiceListResponse()
        {
            Results = new List<RecurringInvoiceListResponseItem>{};
        }

        public virtual List<RecurringInvoiceListResponseItem> Results { get; set; }
    }

    public partial class RecurringInvoiceListResponseItem
    {
        public virtual string GroupID { get; set; }
        public virtual int RecurringInvoiceID { get; set; }
        public virtual int BillingTypeID { get; set; }
        public virtual string BillingTypeName { get; set; }
        public virtual string InvoiceDescription { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string ProcessingCurrency { get; set; }
        public virtual string FrequencyDescription { get; set; }
        public virtual DateTime EffectiveDate { get; set; }
        public virtual DateTime? EndDate { get; set; }
        public virtual DateTime NextDueDate { get; set; }
        public virtual string DonationCoaNum { get; set; }
        public virtual string DonationCoaDesc { get; set; }
        public virtual bool IsActive { get; set; }
        public virtual string FrequencySummary { get; set; }
    }

}

C# 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>