Billhighway Cloud API

<back to all web services

RecurringObligationFormInfoGetRq

import Foundation
import ServiceStack

public class RecurringObligationFormInfoGetRq : Codable
{
    public var natID:Int?
    public var groupId:Int?
    public var userId:String?
    public var userType:String?

    required public init(){}
}

public class RecurringObligationFormInfoGetRs : Codable
{
    public var recurringObligationFormInfo:RecurringObligationFormInfo?
    public var links:[Link] = []

    required public init(){}
}

public class RecurringObligationFormInfo : Codable
{
    public var contextualHelp:[ContextualHelpDto] = []
    public var countries:[CountryDto] = []
    public var states:[StateDto] = []
    public var chapters:[ChapterDto] = []
    public var recurringInvoices:[RecurringInvoiceModel] = []
    public var recurringObligationTemplates:[RecurringObligationInvoiceTemplate] = []
    public var recurringObligationChapBillCatDetail:[RecurringObligationChapBillCatDetail] = []

    required public init(){}
}

public class ContextualHelpDto : Codable
{
    public var controlName:String?
    public var labelText:String?
    public var isVisible:Bool?
    public var isRequired:Bool?

    required public init(){}
}

public class CountryDto : Codable
{
    public var countryID:Int?
    public var fullName:String?
    public var abbr:String?

    required public init(){}
}

public class StateDto : Codable
{
    public var stateID:Int?
    public var countryID:Int?
    public var fullName:String?
    public var abbr:String?

    required public init(){}
}

public class ChapterDto : Codable
{
    public var chapId:Int?
    public var college:String?
    public var designation:String?

    required public init(){}
}

public class RecurringInvoiceModel : Codable
{
    public var chapID:Int?
    public var clientGroupID:String?
    public var recurringInvoiceID:Int?
    public var memTypeID:Int?
    public var billingTypeName:String?
    public var invoiceDescription:String?
    public var amount:Double?
    public var processingCurrency:String?
    public var frequencyDescription:String?
    public var effectiveDate:Date?
    public var endDate:Date?
    public var nextDueDate:Date?
    public var donationCoaNum:String?
    public var donationCoaDesc:String?
    public var donation_ChapBillCatID:Int?
    public var frequencyID:Int?
    public var monthly_DayOfMOnth:Int?
    public var weekly_DayOfWeek:Int?
    public var semiMonthly_DayOfMonth1:Int?
    public var semiMonthly_DayOfMonth2:Int?
    public var useLastDayOfMonth:Bool?
    public var isActive:Bool?
    public var numOccurences:Int?

    required public init(){}
}

public class RecurringObligationInvoiceTemplate : Codable
{
    public var recurringObligationTemplateId:Int?
    public var recurringObligationInvoiceTemplateId:Int?
    public var nationalId:Int?
    public var memberTypeClientId:Int?
    public var fiscalYear:FiscalYearItem?
    public var chapId:Int?
    public var isDeleted:Bool?
    public var name:String?
    public var recurringObligationInvoiceTemplateItems:[RecurringObligationInvoiceTemplateItem] = []

    required public init(){}
}

public class FiscalYearItem : Codable
{
    public var year:Int?
    public var beginDate:Date?
    public var endDate:Date?

    required public init(){}
}

public class RecurringObligationInvoiceTemplateItem : Codable
{
    public var recurringObligationTemplateItemId:Int?
    public var recurringObligationInvoiceTemplateItemId:Int?
    public var recurringObligationInvoiceTemplateId:Int?
    public var amount:Double?
    public var chapBillCatId:Int?
    public var name:String?

    required public init(){}
}

public class RecurringObligationChapBillCatDetail : Codable
{
    public var chapBillCatId:Int?
    public var chapBillCatDesc:String?
    public var natId:Int?
    public var isContribution:Bool?
    public var calcTypeId:Int?
    public var donationAmounts:[KeyValuePair<Int,String>] = []
    public var chartOfAccountRefId:String?

    required public init(){}
}

public class Link : Codable
{
    public var rel:String?
    public var url:String?

    required public init(){}
}

Swift 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
		}
	]
}