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
import Foundation
import ServiceStack

public class RecurringObligationTemplateGetRq : Codable
{
    public var natID:Int?
    public var groupId:Int?
    public var userId:String?
    public var userType:String?

    required public init(){}
}

public class RecurringObligationTemplateGetRs : Codable
{
    public var recurringObligations:RecurringObligationWrapper?

    required public init(){}
}

public class RecurringObligationWrapper : Codable
{
    public var recurringInvoices:[RecurringInvoiceModel] = []
    public var recurringObligationTemplates:[RecurringObligationInvoiceTemplate] = []
    public var recurringObligationChapBillCatDetail:[RecurringObligationChapBillCatDetail] = []

    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(){}
}

Swift 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"}]}}