Billhighway Cloud API

<back to all web services

RecurringObligationFormInfoGetRq

The following routes are available for this service:
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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.RecurringObligation.Request
Imports BH.CloudAPI.Common4.DTO.RecurringObligation.Response
Imports BH.CloudAPI.Common4.DTO.RecurringObligation
Imports BH.API.DataAccess.Dto
Imports BH.CloudAPI.Common.DTO.RecurringInvoice
Imports BH.CloudAPI.Common.DTO.RecurringObligations
Imports BH.CloudAPI.Common.DTO
Imports BH.API.CloudApi.Core

Namespace Global

    Namespace BH.API.CloudApi.Core

        Public Partial Class Link
            Public Overridable Property Rel As String
            Public Overridable Property Url As String
        End Class
    End Namespace

    Namespace BH.API.DataAccess.Dto

        Public Partial Class ChapterDto
            Public Overridable Property ChapId As Integer
            Public Overridable Property College As String
            Public Overridable Property Designation As String
        End Class

        Public Partial Class ContextualHelpDto
            Public Overridable Property ControlName As String
            Public Overridable Property LabelText As String
            Public Overridable Property IsVisible As Boolean
            Public Overridable Property IsRequired As Boolean
        End Class

        Public Partial Class CountryDto
            Public Overridable Property CountryID As Integer
            Public Overridable Property FullName As String
            Public Overridable Property Abbr As String
        End Class

        Public Partial Class StateDto
            Public Overridable Property StateID As Integer
            Public Overridable Property CountryID As Integer
            Public Overridable Property FullName As String
            Public Overridable Property Abbr As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common.DTO

        Public Partial Class FiscalYearItem
            Public Overridable Property Year As Integer
            Public Overridable Property BeginDate As Date
            Public Overridable Property EndDate As Date
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common.DTO.RecurringInvoice

        Public Partial Class RecurringInvoiceModel
            Public Overridable Property ChapID As Integer
            Public Overridable Property ClientGroupID As String
            Public Overridable Property RecurringInvoiceID As Integer
            Public Overridable Property MemTypeID As Integer
            Public Overridable Property BillingTypeName As String
            Public Overridable Property InvoiceDescription As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property ProcessingCurrency As String
            Public Overridable Property FrequencyDescription As String
            Public Overridable Property EffectiveDate As Date
            Public Overridable Property EndDate As Nullable(Of Date)
            Public Overridable Property NextDueDate As Date
            Public Overridable Property donationCoaNum As String
            Public Overridable Property donationCoaDesc As String
            Public Overridable Property Donation_ChapBillCatID As Integer
            Public Overridable Property FrequencyID As Integer
            Public Overridable Property Monthly_DayOfMOnth As Integer
            Public Overridable Property Weekly_DayOfWeek As Integer
            Public Overridable Property SemiMonthly_DayOfMonth1 As Integer
            Public Overridable Property SemiMonthly_DayOfMonth2 As Integer
            Public Overridable Property UseLastDayOfMonth As Boolean
            Public Overridable Property IsActive As Boolean
            Public Overridable Property NumOccurences As Integer
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common.DTO.RecurringObligations

        Public Partial Class RecurringObligationChapBillCatDetail
            Public Sub New()
                DonationAmounts = New List(Of KeyValuePair(Of Int32,String))
            End Sub

            Public Overridable Property ChapBillCatId As Integer
            Public Overridable Property ChapBillCatDesc As String
            Public Overridable Property NatId As Integer
            Public Overridable Property IsContribution As Boolean
            Public Overridable Property CalcTypeId As Integer
            Public Overridable Property DonationAmounts As List(Of KeyValuePair(Of Int32,String))
            Public Overridable Property ChartOfAccountRefId As String
        End Class

        Public Partial Class RecurringObligationInvoiceTemplate
            Public Sub New()
                RecurringObligationInvoiceTemplateItems = New List(Of RecurringObligationInvoiceTemplateItem)
            End Sub

            Public Overridable Property RecurringObligationTemplateId As Integer
            Public Overridable Property RecurringObligationInvoiceTemplateId As Integer
            Public Overridable Property NationalId As Integer
            Public Overridable Property MemberTypeClientId As Integer
            Public Overridable Property FiscalYear As FiscalYearItem
            Public Overridable Property ChapId As Integer
            Public Overridable Property IsDeleted As Boolean
            Public Overridable Property Name As String
            Public Overridable Property RecurringObligationInvoiceTemplateItems As List(Of RecurringObligationInvoiceTemplateItem)
        End Class

        Public Partial Class RecurringObligationInvoiceTemplateItem
            Public Overridable Property RecurringObligationTemplateItemId As Integer
            Public Overridable Property RecurringObligationInvoiceTemplateItemId As Integer
            Public Overridable Property RecurringObligationInvoiceTemplateId As Integer
            Public Overridable Property Amount As Decimal
            Public Overridable Property ChapBillCatId As Integer
            Public Overridable Property Name As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.RecurringObligation

        Public Partial Class RecurringObligationFormInfo
            Public Sub New()
                ContextualHelp = New List(Of ContextualHelpDto)
                Countries = New List(Of CountryDto)
                States = New List(Of StateDto)
                Chapters = New List(Of ChapterDto)
                RecurringInvoices = New List(Of RecurringInvoiceModel)
                RecurringObligationTemplates = New List(Of RecurringObligationInvoiceTemplate)
                RecurringObligationChapBillCatDetail = New List(Of RecurringObligationChapBillCatDetail)
            End Sub

            Public Overridable Property ContextualHelp As List(Of ContextualHelpDto)
            Public Overridable Property Countries As List(Of CountryDto)
            Public Overridable Property States As List(Of StateDto)
            Public Overridable Property Chapters As List(Of ChapterDto)
            Public Overridable Property RecurringInvoices As List(Of RecurringInvoiceModel)
            Public Overridable Property RecurringObligationTemplates As List(Of RecurringObligationInvoiceTemplate)
            Public Overridable Property RecurringObligationChapBillCatDetail As List(Of RecurringObligationChapBillCatDetail)
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.RecurringObligation.Request

        Public Partial Class RecurringObligationFormInfoGetRq
            Public Overridable Property NatID As Integer
            Public Overridable Property GroupId As Integer
            Public Overridable Property UserId As String
            Public Overridable Property UserType As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.RecurringObligation.Response

        Public Partial Class RecurringObligationFormInfoGetRs
            Public Sub New()
                Links = New List(Of Link)
            End Sub

            Public Overridable Property RecurringObligationFormInfo As RecurringObligationFormInfo
            Public Overridable Property Links As List(Of Link)
        End Class
    End Namespace
End Namespace

VB.NET RecurringObligationFormInfoGetRq 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/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>