Billhighway Cloud API

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

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

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>