Billhighway Cloud API

RecurringObligationTemplateGetRq

The following routes are available for this service:
GET	/signup/api/nat/{natID}/recurring/obligation/templates
GET	/signup/api/nat/{natID}/group/{groupId}/recurring/obligation/templates
GET	/signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/recurring/obligation/templates

namespace BH.CloudAPI.Common.DTO

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

    [<AllowNullLiteral>]
    type RecurringObligationTemplateGetRq() = 
        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

    [<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 RecurringObligationWrapper() = 
        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 RecurringObligationTemplateGetRs() = 
        member val RecurringObligations:RecurringObligationWrapper = null with get,set

F# RecurringObligationTemplateGetRq 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/templates HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecurringObligationTemplateGetRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation.Response">
  <RecurringObligations xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.RecurringObligations">
    <d2p1:RecurringInvoices 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:RecurringInvoices>
    <d2p1:RecurringObligationChapBillCatDetail>
      <d2p1:RecurringObligationChapBillCatDetail>
        <d2p1:CalcTypeId>0</d2p1:CalcTypeId>
        <d2p1:ChapBillCatDesc>String</d2p1:ChapBillCatDesc>
        <d2p1:ChapBillCatId>0</d2p1:ChapBillCatId>
        <d2p1:ChartOfAccountRefId>String</d2p1:ChartOfAccountRefId>
        <d2p1: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>
        </d2p1:DonationAmounts>
        <d2p1:IsContribution>false</d2p1:IsContribution>
        <d2p1:NatId>0</d2p1:NatId>
      </d2p1:RecurringObligationChapBillCatDetail>
    </d2p1:RecurringObligationChapBillCatDetail>
    <d2p1:RecurringObligationTemplates>
      <d2p1:RecurringObligationInvoiceTemplate>
        <d2p1:ChapId>0</d2p1:ChapId>
        <d2p1: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>
        </d2p1:FiscalYear>
        <d2p1:IsDeleted>false</d2p1:IsDeleted>
        <d2p1:MemberTypeClientId>0</d2p1:MemberTypeClientId>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:NationalId>0</d2p1:NationalId>
        <d2p1:RecurringObligationInvoiceTemplateId>0</d2p1:RecurringObligationInvoiceTemplateId>
        <d2p1:RecurringObligationInvoiceTemplateItems>
          <d2p1:RecurringObligationInvoiceTemplateItem>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:ChapBillCatId>0</d2p1:ChapBillCatId>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:RecurringObligationInvoiceTemplateId>0</d2p1:RecurringObligationInvoiceTemplateId>
            <d2p1:RecurringObligationInvoiceTemplateItemId>0</d2p1:RecurringObligationInvoiceTemplateItemId>
            <d2p1:RecurringObligationTemplateItemId>0</d2p1:RecurringObligationTemplateItemId>
          </d2p1:RecurringObligationInvoiceTemplateItem>
        </d2p1:RecurringObligationInvoiceTemplateItems>
        <d2p1:RecurringObligationTemplateId>0</d2p1:RecurringObligationTemplateId>
      </d2p1:RecurringObligationInvoiceTemplate>
    </d2p1:RecurringObligationTemplates>
  </RecurringObligations>
</RecurringObligationTemplateGetRs>