| GET | /signup/api/nat/{natID}/recurring/obligation/info | ||
|---|---|---|---|
| GET | /signup/api/nat/{natID}/group/{groupId}/recurring/obligation/info | ||
| GET | /signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/recurring/obligation/info |
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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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/info HTTP/1.1
Host: devapi.billhighway.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RecurringObligationFormInfoGetRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation.Response">
<Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.CloudApi.Core">
<d2p1:Link>
<d2p1:Rel>String</d2p1:Rel>
<d2p1:Url>String</d2p1:Url>
</d2p1:Link>
</Links>
<RecurringObligationFormInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation">
<d2p1:_x003C_Chapters_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
<d3p1:ChapterDto>
<d3p1:ChapId>0</d3p1:ChapId>
<d3p1:College>String</d3p1:College>
<d3p1:Designation>String</d3p1:Designation>
</d3p1:ChapterDto>
</d2p1:_x003C_Chapters_x003E_k__BackingField>
<d2p1:_x003C_ContextualHelp_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
<d3p1:ContextualHelpDto>
<d3p1:ControlName>String</d3p1:ControlName>
<d3p1:IsRequired>false</d3p1:IsRequired>
<d3p1:IsVisible>false</d3p1:IsVisible>
<d3p1:LabelText>String</d3p1:LabelText>
</d3p1:ContextualHelpDto>
</d2p1:_x003C_ContextualHelp_x003E_k__BackingField>
<d2p1:_x003C_Countries_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
<d3p1:CountryDto>
<d3p1:Abbr>String</d3p1:Abbr>
<d3p1:CountryID>0</d3p1:CountryID>
<d3p1:FullName>String</d3p1:FullName>
</d3p1:CountryDto>
</d2p1:_x003C_Countries_x003E_k__BackingField>
<d2p1:_x003C_RecurringInvoices_x003E_k__BackingField 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:_x003C_RecurringInvoices_x003E_k__BackingField>
<d2p1:_x003C_RecurringObligationChapBillCatDetail_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.RecurringObligations">
<d3p1:RecurringObligationChapBillCatDetail>
<d3p1:CalcTypeId>0</d3p1:CalcTypeId>
<d3p1:ChapBillCatDesc>String</d3p1:ChapBillCatDesc>
<d3p1:ChapBillCatId>0</d3p1:ChapBillCatId>
<d3p1:ChartOfAccountRefId>String</d3p1:ChartOfAccountRefId>
<d3p1: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>
</d3p1:DonationAmounts>
<d3p1:IsContribution>false</d3p1:IsContribution>
<d3p1:NatId>0</d3p1:NatId>
</d3p1:RecurringObligationChapBillCatDetail>
</d2p1:_x003C_RecurringObligationChapBillCatDetail_x003E_k__BackingField>
<d2p1:_x003C_RecurringObligationTemplates_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.RecurringObligations">
<d3p1:RecurringObligationInvoiceTemplate>
<d3p1:ChapId>0</d3p1:ChapId>
<d3p1: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>
</d3p1:FiscalYear>
<d3p1:IsDeleted>false</d3p1:IsDeleted>
<d3p1:MemberTypeClientId>0</d3p1:MemberTypeClientId>
<d3p1:Name>String</d3p1:Name>
<d3p1:NationalId>0</d3p1:NationalId>
<d3p1:RecurringObligationInvoiceTemplateId>0</d3p1:RecurringObligationInvoiceTemplateId>
<d3p1:RecurringObligationInvoiceTemplateItems>
<d3p1:RecurringObligationInvoiceTemplateItem>
<d3p1:Amount>0</d3p1:Amount>
<d3p1:ChapBillCatId>0</d3p1:ChapBillCatId>
<d3p1:Name>String</d3p1:Name>
<d3p1:RecurringObligationInvoiceTemplateId>0</d3p1:RecurringObligationInvoiceTemplateId>
<d3p1:RecurringObligationInvoiceTemplateItemId>0</d3p1:RecurringObligationInvoiceTemplateItemId>
<d3p1:RecurringObligationTemplateItemId>0</d3p1:RecurringObligationTemplateItemId>
</d3p1:RecurringObligationInvoiceTemplateItem>
</d3p1:RecurringObligationInvoiceTemplateItems>
<d3p1:RecurringObligationTemplateId>0</d3p1:RecurringObligationTemplateId>
</d3p1:RecurringObligationInvoiceTemplate>
</d2p1:_x003C_RecurringObligationTemplates_x003E_k__BackingField>
<d2p1:_x003C_States_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
<d3p1:StateDto>
<d3p1:Abbr>String</d3p1:Abbr>
<d3p1:CountryID>0</d3p1:CountryID>
<d3p1:FullName>String</d3p1:FullName>
<d3p1:StateID>0</d3p1:StateID>
</d3p1:StateDto>
</d2p1:_x003C_States_x003E_k__BackingField>
</RecurringObligationFormInfo>
</RecurringObligationFormInfoGetRs>