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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.RecurringObligation.Request;
using BH.CloudAPI.Common4.DTO.RecurringObligation.Response;
using BH.CloudAPI.Common.DTO.RecurringObligations;
using BH.CloudAPI.Common.DTO.RecurringInvoice;
using BH.CloudAPI.Common.DTO;

namespace BH.CloudAPI.Common.DTO
{
    public partial class FiscalYearItem
    {
        public virtual int Year { get; set; }
        public virtual DateTime BeginDate { get; set; }
        public virtual DateTime EndDate { get; set; }
    }

}

namespace BH.CloudAPI.Common.DTO.RecurringInvoice
{
    public partial class RecurringInvoiceModel
    {
        public virtual int ChapID { get; set; }
        public virtual string ClientGroupID { get; set; }
        public virtual int RecurringInvoiceID { get; set; }
        public virtual int MemTypeID { get; set; }
        public virtual string BillingTypeName { get; set; }
        public virtual string InvoiceDescription { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string ProcessingCurrency { get; set; }
        public virtual string FrequencyDescription { get; set; }
        public virtual DateTime EffectiveDate { get; set; }
        public virtual DateTime? EndDate { get; set; }
        public virtual DateTime NextDueDate { get; set; }
        public virtual string donationCoaNum { get; set; }
        public virtual string donationCoaDesc { get; set; }
        public virtual int Donation_ChapBillCatID { get; set; }
        public virtual int FrequencyID { get; set; }
        public virtual int Monthly_DayOfMOnth { get; set; }
        public virtual int Weekly_DayOfWeek { get; set; }
        public virtual int SemiMonthly_DayOfMonth1 { get; set; }
        public virtual int SemiMonthly_DayOfMonth2 { get; set; }
        public virtual bool UseLastDayOfMonth { get; set; }
        public virtual bool IsActive { get; set; }
        public virtual int NumOccurences { get; set; }
    }

}

namespace BH.CloudAPI.Common.DTO.RecurringObligations
{
    public partial class RecurringObligationChapBillCatDetail
    {
        public RecurringObligationChapBillCatDetail()
        {
            DonationAmounts = new List<KeyValuePair<Int32,String>>{};
        }

        public virtual int ChapBillCatId { get; set; }
        public virtual string ChapBillCatDesc { get; set; }
        public virtual int NatId { get; set; }
        public virtual bool IsContribution { get; set; }
        public virtual int CalcTypeId { get; set; }
        public virtual List<KeyValuePair<Int32,String>> DonationAmounts { get; set; }
        public virtual string ChartOfAccountRefId { get; set; }
    }

    public partial class RecurringObligationInvoiceTemplate
    {
        public RecurringObligationInvoiceTemplate()
        {
            RecurringObligationInvoiceTemplateItems = new List<RecurringObligationInvoiceTemplateItem>{};
        }

        public virtual int RecurringObligationTemplateId { get; set; }
        public virtual int RecurringObligationInvoiceTemplateId { get; set; }
        public virtual int NationalId { get; set; }
        public virtual int MemberTypeClientId { get; set; }
        public virtual FiscalYearItem FiscalYear { get; set; }
        public virtual int ChapId { get; set; }
        public virtual bool IsDeleted { get; set; }
        public virtual string Name { get; set; }
        public virtual List<RecurringObligationInvoiceTemplateItem> RecurringObligationInvoiceTemplateItems { get; set; }
    }

    public partial class RecurringObligationInvoiceTemplateItem
    {
        public virtual int RecurringObligationTemplateItemId { get; set; }
        public virtual int RecurringObligationInvoiceTemplateItemId { get; set; }
        public virtual int RecurringObligationInvoiceTemplateId { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual int ChapBillCatId { get; set; }
        public virtual string Name { get; set; }
    }

    public partial class RecurringObligationWrapper
    {
        public RecurringObligationWrapper()
        {
            RecurringInvoices = new List<RecurringInvoiceModel>{};
            RecurringObligationTemplates = new List<RecurringObligationInvoiceTemplate>{};
            RecurringObligationChapBillCatDetail = new List<RecurringObligationChapBillCatDetail>{};
        }

        public virtual List<RecurringInvoiceModel> RecurringInvoices { get; set; }
        public virtual List<RecurringObligationInvoiceTemplate> RecurringObligationTemplates { get; set; }
        public virtual List<RecurringObligationChapBillCatDetail> RecurringObligationChapBillCatDetail { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.RecurringObligation.Request
{
    public partial class RecurringObligationTemplateGetRq
    {
        public virtual int NatID { get; set; }
        public virtual int GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual string UserType { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.RecurringObligation.Response
{
    public partial class RecurringObligationTemplateGetRs
    {
        public virtual RecurringObligationWrapper RecurringObligations { get; set; }
    }

}

C# RecurringObligationTemplateGetRq DTOs

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>