Billhighway Cloud API

RecurringObligationTemplateGetRq

The following routes are available for this service:
GET	/signup/api/nat/{natID}/recurring/obligation/templates
GET	/signup/api/nat/{natID}/group/{groupId}/recurring/obligation/templates
GET	/signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/recurring/obligation/templates

import java.math.*
import java.util.*
import net.servicestack.client.*


open class RecurringObligationTemplateGetRq
{
    var NatID:Int? = null
    var GroupId:Int? = null
    var UserId:String? = null
    var UserType:String? = null
}

open class RecurringObligationTemplateGetRs
{
    var RecurringObligations:RecurringObligationWrapper? = null
}

open class RecurringObligationWrapper
{
    var RecurringInvoices:ArrayList<RecurringInvoiceModel> = ArrayList<RecurringInvoiceModel>()
    var RecurringObligationTemplates:ArrayList<RecurringObligationInvoiceTemplate> = ArrayList<RecurringObligationInvoiceTemplate>()
    var RecurringObligationChapBillCatDetail:ArrayList<RecurringObligationChapBillCatDetail> = ArrayList<RecurringObligationChapBillCatDetail>()
}

open class RecurringInvoiceModel
{
    var ChapID:Int? = null
    var ClientGroupID:String? = null
    var RecurringInvoiceID:Int? = null
    var MemTypeID:Int? = null
    var BillingTypeName:String? = null
    var InvoiceDescription:String? = null
    var Amount:BigDecimal? = null
    var ProcessingCurrency:String? = null
    var FrequencyDescription:String? = null
    var EffectiveDate:Date? = null
    var EndDate:Date? = null
    var NextDueDate:Date? = null
    var donationCoaNum:String? = null
    var donationCoaDesc:String? = null
    var Donation_ChapBillCatID:Int? = null
    var FrequencyID:Int? = null
    var Monthly_DayOfMOnth:Int? = null
    var Weekly_DayOfWeek:Int? = null
    var SemiMonthly_DayOfMonth1:Int? = null
    var SemiMonthly_DayOfMonth2:Int? = null
    var UseLastDayOfMonth:Boolean? = null
    var IsActive:Boolean? = null
    var NumOccurences:Int? = null
}

open class RecurringObligationInvoiceTemplate
{
    var RecurringObligationTemplateId:Int? = null
    var RecurringObligationInvoiceTemplateId:Int? = null
    var NationalId:Int? = null
    var MemberTypeClientId:Int? = null
    var FiscalYear:FiscalYearItem? = null
    var ChapId:Int? = null
    var IsDeleted:Boolean? = null
    var Name:String? = null
    var RecurringObligationInvoiceTemplateItems:ArrayList<RecurringObligationInvoiceTemplateItem> = ArrayList<RecurringObligationInvoiceTemplateItem>()
}

open class FiscalYearItem
{
    var Year:Int? = null
    var BeginDate:Date? = null
    var EndDate:Date? = null
}

open class RecurringObligationInvoiceTemplateItem
{
    var RecurringObligationTemplateItemId:Int? = null
    var RecurringObligationInvoiceTemplateItemId:Int? = null
    var RecurringObligationInvoiceTemplateId:Int? = null
    var Amount:BigDecimal? = null
    var ChapBillCatId:Int? = null
    var Name:String? = null
}

open class RecurringObligationChapBillCatDetail
{
    var ChapBillCatId:Int? = null
    var ChapBillCatDesc:String? = null
    var NatId:Int? = null
    var IsContribution:Boolean? = null
    var CalcTypeId:Int? = null
    var DonationAmounts:ArrayList<KeyValuePair<Int,String>> = ArrayList<KeyValuePair<Int,String>>()
    var ChartOfAccountRefId:String? = null
}

Kotlin RecurringObligationTemplateGetRq 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 /signup/api/nat/{natID}/recurring/obligation/templates HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecurringObligationTemplateGetRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation.Response">
  <RecurringObligations xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.RecurringObligations">
    <d2p1:RecurringInvoices xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.RecurringInvoice">
      <d3p1:RecurringInvoiceModel>
        <d3p1:Amount>0</d3p1:Amount>
        <d3p1:BillingTypeName>String</d3p1:BillingTypeName>
        <d3p1:ChapID>0</d3p1:ChapID>
        <d3p1:ClientGroupID>String</d3p1:ClientGroupID>
        <d3p1:Donation_ChapBillCatID>0</d3p1:Donation_ChapBillCatID>
        <d3p1:EffectiveDate>0001-01-01T00:00:00</d3p1:EffectiveDate>
        <d3p1:EndDate>0001-01-01T00:00:00</d3p1:EndDate>
        <d3p1:FrequencyDescription>String</d3p1:FrequencyDescription>
        <d3p1:FrequencyID>0</d3p1:FrequencyID>
        <d3p1:InvoiceDescription>String</d3p1:InvoiceDescription>
        <d3p1:IsActive>false</d3p1:IsActive>
        <d3p1:MemTypeID>0</d3p1:MemTypeID>
        <d3p1:Monthly_DayOfMOnth>0</d3p1:Monthly_DayOfMOnth>
        <d3p1:NextDueDate>0001-01-01T00:00:00</d3p1:NextDueDate>
        <d3p1:NumOccurences>0</d3p1:NumOccurences>
        <d3p1:ProcessingCurrency>String</d3p1:ProcessingCurrency>
        <d3p1:RecurringInvoiceID>0</d3p1:RecurringInvoiceID>
        <d3p1:SemiMonthly_DayOfMonth1>0</d3p1:SemiMonthly_DayOfMonth1>
        <d3p1:SemiMonthly_DayOfMonth2>0</d3p1:SemiMonthly_DayOfMonth2>
        <d3p1:UseLastDayOfMonth>false</d3p1:UseLastDayOfMonth>
        <d3p1:Weekly_DayOfWeek>0</d3p1:Weekly_DayOfWeek>
        <d3p1:donationCoaDesc>String</d3p1:donationCoaDesc>
        <d3p1:donationCoaNum>String</d3p1:donationCoaNum>
      </d3p1:RecurringInvoiceModel>
    </d2p1:RecurringInvoices>
    <d2p1:RecurringObligationChapBillCatDetail>
      <d2p1:RecurringObligationChapBillCatDetail>
        <d2p1:CalcTypeId>0</d2p1:CalcTypeId>
        <d2p1:ChapBillCatDesc>String</d2p1:ChapBillCatDesc>
        <d2p1:ChapBillCatId>0</d2p1:ChapBillCatId>
        <d2p1:ChartOfAccountRefId>String</d2p1:ChartOfAccountRefId>
        <d2p1:DonationAmounts xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
          <d5p1:KeyValuePairOfintstring>
            <d5p1:key>0</d5p1:key>
            <d5p1:value>String</d5p1:value>
          </d5p1:KeyValuePairOfintstring>
        </d2p1:DonationAmounts>
        <d2p1:IsContribution>false</d2p1:IsContribution>
        <d2p1:NatId>0</d2p1:NatId>
      </d2p1:RecurringObligationChapBillCatDetail>
    </d2p1:RecurringObligationChapBillCatDetail>
    <d2p1:RecurringObligationTemplates>
      <d2p1:RecurringObligationInvoiceTemplate>
        <d2p1:ChapId>0</d2p1:ChapId>
        <d2p1:FiscalYear xmlns:d5p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
          <d5p1:BeginDate>0001-01-01T00:00:00</d5p1:BeginDate>
          <d5p1:EndDate>0001-01-01T00:00:00</d5p1:EndDate>
          <d5p1:Year>0</d5p1:Year>
        </d2p1:FiscalYear>
        <d2p1:IsDeleted>false</d2p1:IsDeleted>
        <d2p1:MemberTypeClientId>0</d2p1:MemberTypeClientId>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:NationalId>0</d2p1:NationalId>
        <d2p1:RecurringObligationInvoiceTemplateId>0</d2p1:RecurringObligationInvoiceTemplateId>
        <d2p1:RecurringObligationInvoiceTemplateItems>
          <d2p1:RecurringObligationInvoiceTemplateItem>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:ChapBillCatId>0</d2p1:ChapBillCatId>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:RecurringObligationInvoiceTemplateId>0</d2p1:RecurringObligationInvoiceTemplateId>
            <d2p1:RecurringObligationInvoiceTemplateItemId>0</d2p1:RecurringObligationInvoiceTemplateItemId>
            <d2p1:RecurringObligationTemplateItemId>0</d2p1:RecurringObligationTemplateItemId>
          </d2p1:RecurringObligationInvoiceTemplateItem>
        </d2p1:RecurringObligationInvoiceTemplateItems>
        <d2p1:RecurringObligationTemplateId>0</d2p1:RecurringObligationTemplateId>
      </d2p1:RecurringObligationInvoiceTemplate>
    </d2p1:RecurringObligationTemplates>
  </RecurringObligations>
</RecurringObligationTemplateGetRs>