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.*;

public class dtos
{

    public static class RecurringInvoiceListRequest
    {
        public String GroupID = null;
        
        public String getGroupID() { return GroupID; }
        public RecurringInvoiceListRequest setGroupID(String value) { this.GroupID = value; return this; }
    }

    public static class RecurringInvoiceListResponse
    {
        public ArrayList<RecurringInvoiceListResponseItem> Results = null;
        
        public ArrayList<RecurringInvoiceListResponseItem> getResults() { return Results; }
        public RecurringInvoiceListResponse setResults(ArrayList<RecurringInvoiceListResponseItem> value) { this.Results = value; return this; }
    }

    public static class RecurringInvoiceListResponseItem
    {
        public String GroupID = null;
        public Integer RecurringInvoiceID = null;
        public Integer BillingTypeID = null;
        public String BillingTypeName = null;
        public String InvoiceDescription = null;
        public BigDecimal Amount = null;
        public String ProcessingCurrency = null;
        public String FrequencyDescription = null;
        public Date EffectiveDate = null;
        public Date EndDate = null;
        public Date NextDueDate = null;
        public String DonationCoaNum = null;
        public String DonationCoaDesc = null;
        public Boolean IsActive = null;
        public String FrequencySummary = null;
        
        public String getGroupID() { return GroupID; }
        public RecurringInvoiceListResponseItem setGroupID(String value) { this.GroupID = value; return this; }
        public Integer getRecurringInvoiceID() { return RecurringInvoiceID; }
        public RecurringInvoiceListResponseItem setRecurringInvoiceID(Integer value) { this.RecurringInvoiceID = value; return this; }
        public Integer getBillingTypeID() { return BillingTypeID; }
        public RecurringInvoiceListResponseItem setBillingTypeID(Integer value) { this.BillingTypeID = value; return this; }
        public String getBillingTypeName() { return BillingTypeName; }
        public RecurringInvoiceListResponseItem setBillingTypeName(String value) { this.BillingTypeName = value; return this; }
        public String getInvoiceDescription() { return InvoiceDescription; }
        public RecurringInvoiceListResponseItem setInvoiceDescription(String value) { this.InvoiceDescription = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public RecurringInvoiceListResponseItem setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getProcessingCurrency() { return ProcessingCurrency; }
        public RecurringInvoiceListResponseItem setProcessingCurrency(String value) { this.ProcessingCurrency = value; return this; }
        public String getFrequencyDescription() { return FrequencyDescription; }
        public RecurringInvoiceListResponseItem setFrequencyDescription(String value) { this.FrequencyDescription = value; return this; }
        public Date getEffectiveDate() { return EffectiveDate; }
        public RecurringInvoiceListResponseItem setEffectiveDate(Date value) { this.EffectiveDate = value; return this; }
        public Date getEndDate() { return EndDate; }
        public RecurringInvoiceListResponseItem setEndDate(Date value) { this.EndDate = value; return this; }
        public Date getNextDueDate() { return NextDueDate; }
        public RecurringInvoiceListResponseItem setNextDueDate(Date value) { this.NextDueDate = value; return this; }
        public String getDonationCoaNum() { return DonationCoaNum; }
        public RecurringInvoiceListResponseItem setDonationCoaNum(String value) { this.DonationCoaNum = value; return this; }
        public String getDonationCoaDesc() { return DonationCoaDesc; }
        public RecurringInvoiceListResponseItem setDonationCoaDesc(String value) { this.DonationCoaDesc = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public RecurringInvoiceListResponseItem setIsActive(Boolean value) { this.IsActive = value; return this; }
        public String getFrequencySummary() { return FrequencySummary; }
        public RecurringInvoiceListResponseItem setFrequencySummary(String value) { this.FrequencySummary = value; return this; }
    }

}

Java RecurringInvoiceListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"Results":[{"GroupID":"String","RecurringInvoiceID":0,"BillingTypeID":0,"BillingTypeName":"String","InvoiceDescription":"String","Amount":0,"ProcessingCurrency":"String","FrequencyDescription":"String","EffectiveDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","NextDueDate":"0001-01-01T00:00:00.0000000","DonationCoaNum":"String","DonationCoaDesc":"String","IsActive":false,"FrequencySummary":"String"}]}