Billhighway Cloud API

<back to all web services

RecurringInvoiceListRequest

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

export class RecurringInvoiceListResponseItem
{
    public GroupID?: string;
    public RecurringInvoiceID?: number;
    public BillingTypeID?: number;
    public BillingTypeName?: string;
    public InvoiceDescription?: string;
    public Amount?: number;
    public ProcessingCurrency?: string;
    public FrequencyDescription?: string;
    public EffectiveDate?: string;
    public EndDate?: string;
    public NextDueDate?: string;
    public DonationCoaNum?: string;
    public DonationCoaDesc?: string;
    public IsActive?: boolean;
    public FrequencySummary?: string;

    public constructor(init?: Partial<RecurringInvoiceListResponseItem>) { (Object as any).assign(this, init); }
}

export class RecurringInvoiceListResponse
{
    public Results?: RecurringInvoiceListResponseItem[];

    public constructor(init?: Partial<RecurringInvoiceListResponse>) { (Object as any).assign(this, init); }
}

export class RecurringInvoiceListRequest
{
    public GroupID?: string;

    public constructor(init?: Partial<RecurringInvoiceListRequest>) { (Object as any).assign(this, init); }
}

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