Billhighway Cloud API

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