Billhighway Cloud API

RecurringInvoiceListRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringInvoiceListResponseItem:
    group_i_d: Optional[str] = None
    recurring_invoice_i_d: Optional[int] = None
    billing_type_i_d: Optional[int] = None
    billing_type_name: Optional[str] = None
    invoice_description: Optional[str] = None
    amount: Optional[Decimal] = None
    processing_currency: Optional[str] = None
    frequency_description: Optional[str] = None
    effective_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    next_due_date: Optional[datetime.datetime] = None
    donation_coa_num: Optional[str] = None
    donation_coa_desc: Optional[str] = None
    is_active: Optional[bool] = None
    frequency_summary: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringInvoiceListResponse:
    results: Optional[List[RecurringInvoiceListResponseItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringInvoiceListRequest:
    group_i_d: Optional[str] = None

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