Billhighway Cloud API

<back to all web services

RecurringObligationFormInfoGetRq

namespace BH.API.CloudApi.Core

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ContextualHelpDto() = 
        member val ControlName:String = null with get,set
        member val LabelText:String = null with get,set
        member val IsVisible:Boolean = new Boolean() with get,set
        member val IsRequired:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CountryDto() = 
        member val CountryID:Int32 = new Int32() with get,set
        member val FullName:String = null with get,set
        member val Abbr:String = null with get,set

    [<AllowNullLiteral>]
    type StateDto() = 
        member val StateID:Int32 = new Int32() with get,set
        member val CountryID:Int32 = new Int32() with get,set
        member val FullName:String = null with get,set
        member val Abbr:String = null with get,set

    [<AllowNullLiteral>]
    type ChapterDto() = 
        member val ChapId:Int32 = new Int32() with get,set
        member val College:String = null with get,set
        member val Designation:String = null with get,set

    [<AllowNullLiteral>]
    type RecurringInvoiceModel() = 
        member val ChapID:Int32 = new Int32() with get,set
        member val ClientGroupID:String = null with get,set
        member val RecurringInvoiceID:Int32 = new Int32() with get,set
        member val MemTypeID:Int32 = new Int32() with get,set
        member val BillingTypeName:String = null with get,set
        member val InvoiceDescription:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val ProcessingCurrency:String = null with get,set
        member val FrequencyDescription:String = null with get,set
        member val EffectiveDate:DateTime = new DateTime() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val NextDueDate:DateTime = new DateTime() with get,set
        member val donationCoaNum:String = null with get,set
        member val donationCoaDesc:String = null with get,set
        member val Donation_ChapBillCatID:Int32 = new Int32() with get,set
        member val FrequencyID:Int32 = new Int32() with get,set
        member val Monthly_DayOfMOnth:Int32 = new Int32() with get,set
        member val Weekly_DayOfWeek:Int32 = new Int32() with get,set
        member val SemiMonthly_DayOfMonth1:Int32 = new Int32() with get,set
        member val SemiMonthly_DayOfMonth2:Int32 = new Int32() with get,set
        member val UseLastDayOfMonth:Boolean = new Boolean() with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val NumOccurences:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type FiscalYearItem() = 
        member val Year:Int32 = new Int32() with get,set
        member val BeginDate:DateTime = new DateTime() with get,set
        member val EndDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type RecurringObligationInvoiceTemplateItem() = 
        member val RecurringObligationTemplateItemId:Int32 = new Int32() with get,set
        member val RecurringObligationInvoiceTemplateItemId:Int32 = new Int32() with get,set
        member val RecurringObligationInvoiceTemplateId:Int32 = new Int32() with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val ChapBillCatId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type RecurringObligationInvoiceTemplate() = 
        member val RecurringObligationTemplateId:Int32 = new Int32() with get,set
        member val RecurringObligationInvoiceTemplateId:Int32 = new Int32() with get,set
        member val NationalId:Int32 = new Int32() with get,set
        member val MemberTypeClientId:Int32 = new Int32() with get,set
        member val FiscalYear:FiscalYearItem = null with get,set
        member val ChapId:Int32 = new Int32() with get,set
        member val IsDeleted:Boolean = new Boolean() with get,set
        member val Name:String = null with get,set
        member val RecurringObligationInvoiceTemplateItems:ResizeArray<RecurringObligationInvoiceTemplateItem> = new ResizeArray<RecurringObligationInvoiceTemplateItem>() with get,set

    [<AllowNullLiteral>]
    type RecurringObligationChapBillCatDetail() = 
        member val ChapBillCatId:Int32 = new Int32() with get,set
        member val ChapBillCatDesc:String = null with get,set
        member val NatId:Int32 = new Int32() with get,set
        member val IsContribution:Boolean = new Boolean() with get,set
        member val CalcTypeId:Int32 = new Int32() with get,set
        member val DonationAmounts:ResizeArray<KeyValuePair<Int32,String>> = new ResizeArray<KeyValuePair<Int32,String>>() with get,set
        member val ChartOfAccountRefId:String = null with get,set

    [<AllowNullLiteral>]
    type RecurringObligationFormInfo() = 
        member val ContextualHelp:ResizeArray<ContextualHelpDto> = new ResizeArray<ContextualHelpDto>() with get,set
        member val Countries:ResizeArray<CountryDto> = new ResizeArray<CountryDto>() with get,set
        member val States:ResizeArray<StateDto> = new ResizeArray<StateDto>() with get,set
        member val Chapters:ResizeArray<ChapterDto> = new ResizeArray<ChapterDto>() with get,set
        member val RecurringInvoices:ResizeArray<RecurringInvoiceModel> = new ResizeArray<RecurringInvoiceModel>() with get,set
        member val RecurringObligationTemplates:ResizeArray<RecurringObligationInvoiceTemplate> = new ResizeArray<RecurringObligationInvoiceTemplate>() with get,set
        member val RecurringObligationChapBillCatDetail:ResizeArray<RecurringObligationChapBillCatDetail> = new ResizeArray<RecurringObligationChapBillCatDetail>() with get,set

    [<AllowNullLiteral>]
    type Link() = 
        member val Rel:String = null with get,set
        member val Url:String = null with get,set

    [<AllowNullLiteral>]
    type RecurringObligationFormInfoGetRs() = 
        member val RecurringObligationFormInfo:RecurringObligationFormInfo = null with get,set
        member val Links:ResizeArray<Link> = new ResizeArray<Link>() with get,set

    [<AllowNullLiteral>]
    type RecurringObligationFormInfoGetRq() = 
        member val NatID:Int32 = new Int32() with get,set
        member val GroupId:Int32 = new Int32() with get,set
        member val UserId:String = null with get,set
        member val UserType:String = null with get,set

F# RecurringObligationFormInfoGetRq DTOs

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

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
				EndDate: 0001-01-01,
				NextDueDate: 0001-01-01,
				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-01,
					EndDate: 0001-01-01
				},
				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
		}
	]
}