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

**RecurringObligationTemplateGetRq** Parameters:
Name	Parameter	Data Type	Required
NatID	path	int	No
GroupId	path	int	No
UserId	path	string	No
UserType	path	string	No

**RecurringObligationTemplateGetRs** Parameters:
Name	Parameter	Data Type	Required	Description
RecurringObligations	form	RecurringObligationWrapper	No

**RecurringObligationWrapper** Parameters:
Name	Parameter	Data Type	Required
RecurringInvoices	form	List<RecurringInvoiceModel>	No
RecurringObligationTemplates	form	List<RecurringObligationInvoiceTemplate>	No
RecurringObligationChapBillCatDetail	form	List<RecurringObligationChapBillCatDetail>	No

**RecurringInvoiceModel** Parameters:
Name	Parameter	Data Type	Required
ChapID	form	int	No
ClientGroupID	form	string	No
RecurringInvoiceID	form	int	No
MemTypeID	form	int	No
BillingTypeName	form	string	No
InvoiceDescription	form	string	No
Amount	form	decimal	No
ProcessingCurrency	form	string	No
FrequencyDescription	form	string	No
EffectiveDate	form	DateTime	No
EndDate	form	DateTime?	No
NextDueDate	form	DateTime	No
donationCoaNum	form	string	No
donationCoaDesc	form	string	No
Donation_ChapBillCatID	form	int	No
FrequencyID	form	int	No
Monthly_DayOfMOnth	form	int	No
Weekly_DayOfWeek	form	int	No
SemiMonthly_DayOfMonth1	form	int	No
SemiMonthly_DayOfMonth2	form	int	No
UseLastDayOfMonth	form	bool	No
IsActive	form	bool	No
NumOccurences	form	int	No

**RecurringObligationInvoiceTemplate** Parameters:
Name	Parameter	Data Type	Required
RecurringObligationTemplateId	form	int	No
RecurringObligationInvoiceTemplateId	form	int	No
NationalId	form	int	No
MemberTypeClientId	form	int	No
FiscalYear	form	FiscalYearItem	No
ChapId	form	int	No
IsDeleted	form	bool	No
Name	form	string	No
RecurringObligationInvoiceTemplateItems	form	List<RecurringObligationInvoiceTemplateItem>	No

**FiscalYearItem** Parameters:
Name	Parameter	Data Type	Required
Year	form	int	No
BeginDate	form	DateTime	No
EndDate	form	DateTime	No

**RecurringObligationInvoiceTemplateItem** Parameters:
Name	Parameter	Data Type	Required
RecurringObligationTemplateItemId	form	int	No
RecurringObligationInvoiceTemplateItemId	form	int	No
RecurringObligationInvoiceTemplateId	form	int	No
Amount	form	decimal	No
ChapBillCatId	form	int	No
Name	form	string	No

**RecurringObligationChapBillCatDetail** Parameters:
Name	Parameter	Data Type	Required
ChapBillCatId	form	int	No
ChapBillCatDesc	form	string	No
NatId	form	int	No
IsContribution	form	bool	No
CalcTypeId	form	int	No
DonationAmounts	form	List<KeyValuePair<Int32,String>>	No
ChartOfAccountRefId	form	string	No

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>