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 .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"}]}