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
RecurringObligationTemplateGetRq Parameters:
NameParameterData TypeRequiredDescription
NatIDpathintNo
GroupIdpathintNo
UserIdpathstringNo
UserTypepathstringNo
RecurringObligationTemplateGetRs Parameters:
NameParameterData TypeRequiredDescription
RecurringObligationsformRecurringObligationWrapperNo
RecurringObligationWrapper Parameters:
NameParameterData TypeRequiredDescription
RecurringInvoicesformList<RecurringInvoiceModel>No
RecurringObligationTemplatesformList<RecurringObligationInvoiceTemplate>No
RecurringObligationChapBillCatDetailformList<RecurringObligationChapBillCatDetail>No
RecurringInvoiceModel Parameters:
NameParameterData TypeRequiredDescription
ChapIDformintNo
ClientGroupIDformstringNo
RecurringInvoiceIDformintNo
MemTypeIDformintNo
BillingTypeNameformstringNo
InvoiceDescriptionformstringNo
AmountformdecimalNo
ProcessingCurrencyformstringNo
FrequencyDescriptionformstringNo
EffectiveDateformDateTimeNo
EndDateformDateTime?No
NextDueDateformDateTimeNo
donationCoaNumformstringNo
donationCoaDescformstringNo
Donation_ChapBillCatIDformintNo
FrequencyIDformintNo
Monthly_DayOfMOnthformintNo
Weekly_DayOfWeekformintNo
SemiMonthly_DayOfMonth1formintNo
SemiMonthly_DayOfMonth2formintNo
UseLastDayOfMonthformboolNo
IsActiveformboolNo
NumOccurencesformintNo
RecurringObligationInvoiceTemplate Parameters:
NameParameterData TypeRequiredDescription
RecurringObligationTemplateIdformintNo
RecurringObligationInvoiceTemplateIdformintNo
NationalIdformintNo
MemberTypeClientIdformintNo
FiscalYearformFiscalYearItemNo
ChapIdformintNo
IsDeletedformboolNo
NameformstringNo
RecurringObligationInvoiceTemplateItemsformList<RecurringObligationInvoiceTemplateItem>No
FiscalYearItem Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
BeginDateformDateTimeNo
EndDateformDateTimeNo
RecurringObligationInvoiceTemplateItem Parameters:
NameParameterData TypeRequiredDescription
RecurringObligationTemplateItemIdformintNo
RecurringObligationInvoiceTemplateItemIdformintNo
RecurringObligationInvoiceTemplateIdformintNo
AmountformdecimalNo
ChapBillCatIdformintNo
NameformstringNo
RecurringObligationChapBillCatDetail Parameters:
NameParameterData TypeRequiredDescription
ChapBillCatIdformintNo
ChapBillCatDescformstringNo
NatIdformintNo
IsContributionformboolNo
CalcTypeIdformintNo
DonationAmountsformList<KeyValuePair<Int32,String>>No
ChartOfAccountRefIdformstringNo

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