Billhighway Cloud API

<back to all web services

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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"RecurringObligations":{"RecurringInvoices":[{"ChapID":0,"ClientGroupID":"String","RecurringInvoiceID":0,"MemTypeID":0,"BillingTypeName":"String","InvoiceDescription":"String","Amount":0,"ProcessingCurrency":"String","FrequencyDescription":"String","EffectiveDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","NextDueDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000"},"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"}]}}