Billhighway Cloud API

<back to all web services

RecurringObligationFormInfoGetRq

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


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

open class RecurringObligationFormInfoGetRs
{
    var RecurringObligationFormInfo:RecurringObligationFormInfo? = null
    var Links:ArrayList<Link> = ArrayList<Link>()
}

open class RecurringObligationFormInfo
{
    var ContextualHelp:ArrayList<ContextualHelpDto> = ArrayList<ContextualHelpDto>()
    var Countries:ArrayList<CountryDto> = ArrayList<CountryDto>()
    var States:ArrayList<StateDto> = ArrayList<StateDto>()
    var Chapters:ArrayList<ChapterDto> = ArrayList<ChapterDto>()
    var RecurringInvoices:ArrayList<RecurringInvoiceModel> = ArrayList<RecurringInvoiceModel>()
    var RecurringObligationTemplates:ArrayList<RecurringObligationInvoiceTemplate> = ArrayList<RecurringObligationInvoiceTemplate>()
    var RecurringObligationChapBillCatDetail:ArrayList<RecurringObligationChapBillCatDetail> = ArrayList<RecurringObligationChapBillCatDetail>()
}

open class ContextualHelpDto
{
    var ControlName:String? = null
    var LabelText:String? = null
    var IsVisible:Boolean? = null
    var IsRequired:Boolean? = null
}

open class CountryDto
{
    var CountryID:Int? = null
    var FullName:String? = null
    var Abbr:String? = null
}

open class StateDto
{
    var StateID:Int? = null
    var CountryID:Int? = null
    var FullName:String? = null
    var Abbr:String? = null
}

open class ChapterDto
{
    var ChapId:Int? = null
    var College:String? = null
    var Designation:String? = null
}

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
}

open class Link
{
    var Rel:String? = null
    var Url:String? = null
}

Kotlin RecurringObligationFormInfoGetRq DTOs

GET /signup/api/nat/{natID}/recurring/obligation/info HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"RecurringObligationFormInfo":{"ContextualHelp":[{"ControlName":"String","LabelText":"String","IsVisible":false,"IsRequired":false}],"Countries":[{"CountryID":0,"FullName":"String","Abbr":"String"}],"States":[{"StateID":0,"CountryID":0,"FullName":"String","Abbr":"String"}],"Chapters":[{"ChapId":0,"College":"String","Designation":"String"}],"RecurringInvoices":[{"ChapID":0,"ClientGroupID":"String","RecurringInvoiceID":0,"MemTypeID":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","Donation_ChapBillCatID":0,"FrequencyID":0,"Monthly_DayOfMOnth":0,"Weekly_DayOfWeek":0,"SemiMonthly_DayOfMonth1":0,"SemiMonthly_DayOfMonth2":0,"UseLastDayOfMonth":false,"IsActive":false,"NumOccurences":0}],"RecurringObligationTemplates":[{"RecurringObligationTemplateId":0,"RecurringObligationInvoiceTemplateId":0,"NationalId":0,"MemberTypeClientId":0,"FiscalYear":{"Year":0,"BeginDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000"},"ChapId":0,"IsDeleted":false,"Name":"String","RecurringObligationInvoiceTemplateItems":[{"RecurringObligationTemplateItemId":0,"RecurringObligationInvoiceTemplateItemId":0,"RecurringObligationInvoiceTemplateId":0,"Amount":0,"ChapBillCatId":0,"Name":"String"}]}],"RecurringObligationChapBillCatDetail":[{"ChapBillCatId":0,"ChapBillCatDesc":"String","NatId":0,"IsContribution":false,"CalcTypeId":0,"DonationAmounts":[{"Key":0,"Value":"String"}],"ChartOfAccountRefId":"String"}]},"Links":[{"Rel":"String","Url":"String"}]}