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
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.Common.DTO.RecurringObligations
Imports BH.CloudAPI.Common.DTO.RecurringInvoice
Imports BH.CloudAPI.Common.DTO

Namespace Global

    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

        Public Partial Class RecurringObligationWrapper
            Public Sub New()
                RecurringInvoices = New List(Of RecurringInvoiceModel)
                RecurringObligationTemplates = New List(Of RecurringObligationInvoiceTemplate)
                RecurringObligationChapBillCatDetail = New List(Of RecurringObligationChapBillCatDetail)
            End Sub

            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 RecurringObligationTemplateGetRq
            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 RecurringObligationTemplateGetRs
            Public Overridable Property RecurringObligations As RecurringObligationWrapper
        End Class
    End Namespace
End Namespace

VB.NET RecurringObligationTemplateGetRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}]}}