Billhighway Cloud API

<back to all web services

RecurringObligationTemplateGetRq

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class RecurringObligationTemplateGetRq
    {
        public Integer NatID = null;
        public Integer GroupId = null;
        public String UserId = null;
        public String UserType = null;
        
        public Integer getNatID() { return NatID; }
        public RecurringObligationTemplateGetRq setNatID(Integer value) { this.NatID = value; return this; }
        public Integer getGroupId() { return GroupId; }
        public RecurringObligationTemplateGetRq setGroupId(Integer value) { this.GroupId = value; return this; }
        public String getUserId() { return UserId; }
        public RecurringObligationTemplateGetRq setUserId(String value) { this.UserId = value; return this; }
        public String getUserType() { return UserType; }
        public RecurringObligationTemplateGetRq setUserType(String value) { this.UserType = value; return this; }
    }

    public static class RecurringObligationTemplateGetRs
    {
        public RecurringObligationWrapper RecurringObligations = null;
        
        public RecurringObligationWrapper getRecurringObligations() { return RecurringObligations; }
        public RecurringObligationTemplateGetRs setRecurringObligations(RecurringObligationWrapper value) { this.RecurringObligations = value; return this; }
    }

    public static class RecurringObligationWrapper
    {
        public ArrayList<RecurringInvoiceModel> RecurringInvoices = null;
        public ArrayList<RecurringObligationInvoiceTemplate> RecurringObligationTemplates = null;
        public ArrayList<RecurringObligationChapBillCatDetail> RecurringObligationChapBillCatDetail = null;
        
        public ArrayList<RecurringInvoiceModel> getRecurringInvoices() { return RecurringInvoices; }
        public RecurringObligationWrapper setRecurringInvoices(ArrayList<RecurringInvoiceModel> value) { this.RecurringInvoices = value; return this; }
        public ArrayList<RecurringObligationInvoiceTemplate> getRecurringObligationTemplates() { return RecurringObligationTemplates; }
        public RecurringObligationWrapper setRecurringObligationTemplates(ArrayList<RecurringObligationInvoiceTemplate> value) { this.RecurringObligationTemplates = value; return this; }
        public ArrayList<RecurringObligationChapBillCatDetail> getRecurringObligationChapBillCatDetail() { return RecurringObligationChapBillCatDetail; }
        public RecurringObligationWrapper setRecurringObligationChapBillCatDetail(ArrayList<RecurringObligationChapBillCatDetail> value) { this.RecurringObligationChapBillCatDetail = value; return this; }
    }

    public static class RecurringInvoiceModel
    {
        public Integer ChapID = null;
        public String ClientGroupID = null;
        public Integer RecurringInvoiceID = null;
        public Integer MemTypeID = null;
        public String BillingTypeName = null;
        public String InvoiceDescription = null;
        public BigDecimal Amount = null;
        public String ProcessingCurrency = null;
        public String FrequencyDescription = null;
        public Date EffectiveDate = null;
        public Date EndDate = null;
        public Date NextDueDate = null;
        public String donationCoaNum = null;
        public String donationCoaDesc = null;
        public Integer Donation_ChapBillCatID = null;
        public Integer FrequencyID = null;
        public Integer Monthly_DayOfMOnth = null;
        public Integer Weekly_DayOfWeek = null;
        public Integer SemiMonthly_DayOfMonth1 = null;
        public Integer SemiMonthly_DayOfMonth2 = null;
        public Boolean UseLastDayOfMonth = null;
        public Boolean IsActive = null;
        public Integer NumOccurences = null;
        
        public Integer getChapID() { return ChapID; }
        public RecurringInvoiceModel setChapID(Integer value) { this.ChapID = value; return this; }
        public String getClientGroupID() { return ClientGroupID; }
        public RecurringInvoiceModel setClientGroupID(String value) { this.ClientGroupID = value; return this; }
        public Integer getRecurringInvoiceID() { return RecurringInvoiceID; }
        public RecurringInvoiceModel setRecurringInvoiceID(Integer value) { this.RecurringInvoiceID = value; return this; }
        public Integer getMemTypeID() { return MemTypeID; }
        public RecurringInvoiceModel setMemTypeID(Integer value) { this.MemTypeID = value; return this; }
        public String getBillingTypeName() { return BillingTypeName; }
        public RecurringInvoiceModel setBillingTypeName(String value) { this.BillingTypeName = value; return this; }
        public String getInvoiceDescription() { return InvoiceDescription; }
        public RecurringInvoiceModel setInvoiceDescription(String value) { this.InvoiceDescription = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public RecurringInvoiceModel setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getProcessingCurrency() { return ProcessingCurrency; }
        public RecurringInvoiceModel setProcessingCurrency(String value) { this.ProcessingCurrency = value; return this; }
        public String getFrequencyDescription() { return FrequencyDescription; }
        public RecurringInvoiceModel setFrequencyDescription(String value) { this.FrequencyDescription = value; return this; }
        public Date getEffectiveDate() { return EffectiveDate; }
        public RecurringInvoiceModel setEffectiveDate(Date value) { this.EffectiveDate = value; return this; }
        public Date getEndDate() { return EndDate; }
        public RecurringInvoiceModel setEndDate(Date value) { this.EndDate = value; return this; }
        public Date getNextDueDate() { return NextDueDate; }
        public RecurringInvoiceModel setNextDueDate(Date value) { this.NextDueDate = value; return this; }
        public String getDonationCoaNum() { return donationCoaNum; }
        public RecurringInvoiceModel setDonationCoaNum(String value) { this.donationCoaNum = value; return this; }
        public String getDonationCoaDesc() { return donationCoaDesc; }
        public RecurringInvoiceModel setDonationCoaDesc(String value) { this.donationCoaDesc = value; return this; }
        public Integer getDonationChapBillCatID() { return Donation_ChapBillCatID; }
        public RecurringInvoiceModel setDonationChapBillCatID(Integer value) { this.Donation_ChapBillCatID = value; return this; }
        public Integer getFrequencyID() { return FrequencyID; }
        public RecurringInvoiceModel setFrequencyID(Integer value) { this.FrequencyID = value; return this; }
        public Integer getMonthlyDayOfMOnth() { return Monthly_DayOfMOnth; }
        public RecurringInvoiceModel setMonthlyDayOfMOnth(Integer value) { this.Monthly_DayOfMOnth = value; return this; }
        public Integer getWeeklyDayOfWeek() { return Weekly_DayOfWeek; }
        public RecurringInvoiceModel setWeeklyDayOfWeek(Integer value) { this.Weekly_DayOfWeek = value; return this; }
        public Integer getSemiMonthlyDayOfMonth1() { return SemiMonthly_DayOfMonth1; }
        public RecurringInvoiceModel setSemiMonthlyDayOfMonth1(Integer value) { this.SemiMonthly_DayOfMonth1 = value; return this; }
        public Integer getSemiMonthlyDayOfMonth2() { return SemiMonthly_DayOfMonth2; }
        public RecurringInvoiceModel setSemiMonthlyDayOfMonth2(Integer value) { this.SemiMonthly_DayOfMonth2 = value; return this; }
        public Boolean isUseLastDayOfMonth() { return UseLastDayOfMonth; }
        public RecurringInvoiceModel setUseLastDayOfMonth(Boolean value) { this.UseLastDayOfMonth = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public RecurringInvoiceModel setIsActive(Boolean value) { this.IsActive = value; return this; }
        public Integer getNumOccurences() { return NumOccurences; }
        public RecurringInvoiceModel setNumOccurences(Integer value) { this.NumOccurences = value; return this; }
    }

    public static class RecurringObligationInvoiceTemplate
    {
        public Integer RecurringObligationTemplateId = null;
        public Integer RecurringObligationInvoiceTemplateId = null;
        public Integer NationalId = null;
        public Integer MemberTypeClientId = null;
        public FiscalYearItem FiscalYear = null;
        public Integer ChapId = null;
        public Boolean IsDeleted = null;
        public String Name = null;
        public ArrayList<RecurringObligationInvoiceTemplateItem> RecurringObligationInvoiceTemplateItems = null;
        
        public Integer getRecurringObligationTemplateId() { return RecurringObligationTemplateId; }
        public RecurringObligationInvoiceTemplate setRecurringObligationTemplateId(Integer value) { this.RecurringObligationTemplateId = value; return this; }
        public Integer getRecurringObligationInvoiceTemplateId() { return RecurringObligationInvoiceTemplateId; }
        public RecurringObligationInvoiceTemplate setRecurringObligationInvoiceTemplateId(Integer value) { this.RecurringObligationInvoiceTemplateId = value; return this; }
        public Integer getNationalId() { return NationalId; }
        public RecurringObligationInvoiceTemplate setNationalId(Integer value) { this.NationalId = value; return this; }
        public Integer getMemberTypeClientId() { return MemberTypeClientId; }
        public RecurringObligationInvoiceTemplate setMemberTypeClientId(Integer value) { this.MemberTypeClientId = value; return this; }
        public FiscalYearItem getFiscalYear() { return FiscalYear; }
        public RecurringObligationInvoiceTemplate setFiscalYear(FiscalYearItem value) { this.FiscalYear = value; return this; }
        public Integer getChapId() { return ChapId; }
        public RecurringObligationInvoiceTemplate setChapId(Integer value) { this.ChapId = value; return this; }
        public Boolean getIsDeleted() { return IsDeleted; }
        public RecurringObligationInvoiceTemplate setIsDeleted(Boolean value) { this.IsDeleted = value; return this; }
        public String getName() { return Name; }
        public RecurringObligationInvoiceTemplate setName(String value) { this.Name = value; return this; }
        public ArrayList<RecurringObligationInvoiceTemplateItem> getRecurringObligationInvoiceTemplateItems() { return RecurringObligationInvoiceTemplateItems; }
        public RecurringObligationInvoiceTemplate setRecurringObligationInvoiceTemplateItems(ArrayList<RecurringObligationInvoiceTemplateItem> value) { this.RecurringObligationInvoiceTemplateItems = value; return this; }
    }

    public static class FiscalYearItem
    {
        public Integer Year = null;
        public Date BeginDate = null;
        public Date EndDate = null;
        
        public Integer getYear() { return Year; }
        public FiscalYearItem setYear(Integer value) { this.Year = value; return this; }
        public Date getBeginDate() { return BeginDate; }
        public FiscalYearItem setBeginDate(Date value) { this.BeginDate = value; return this; }
        public Date getEndDate() { return EndDate; }
        public FiscalYearItem setEndDate(Date value) { this.EndDate = value; return this; }
    }

    public static class RecurringObligationInvoiceTemplateItem
    {
        public Integer RecurringObligationTemplateItemId = null;
        public Integer RecurringObligationInvoiceTemplateItemId = null;
        public Integer RecurringObligationInvoiceTemplateId = null;
        public BigDecimal Amount = null;
        public Integer ChapBillCatId = null;
        public String Name = null;
        
        public Integer getRecurringObligationTemplateItemId() { return RecurringObligationTemplateItemId; }
        public RecurringObligationInvoiceTemplateItem setRecurringObligationTemplateItemId(Integer value) { this.RecurringObligationTemplateItemId = value; return this; }
        public Integer getRecurringObligationInvoiceTemplateItemId() { return RecurringObligationInvoiceTemplateItemId; }
        public RecurringObligationInvoiceTemplateItem setRecurringObligationInvoiceTemplateItemId(Integer value) { this.RecurringObligationInvoiceTemplateItemId = value; return this; }
        public Integer getRecurringObligationInvoiceTemplateId() { return RecurringObligationInvoiceTemplateId; }
        public RecurringObligationInvoiceTemplateItem setRecurringObligationInvoiceTemplateId(Integer value) { this.RecurringObligationInvoiceTemplateId = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public RecurringObligationInvoiceTemplateItem setAmount(BigDecimal value) { this.Amount = value; return this; }
        public Integer getChapBillCatId() { return ChapBillCatId; }
        public RecurringObligationInvoiceTemplateItem setChapBillCatId(Integer value) { this.ChapBillCatId = value; return this; }
        public String getName() { return Name; }
        public RecurringObligationInvoiceTemplateItem setName(String value) { this.Name = value; return this; }
    }

    public static class RecurringObligationChapBillCatDetail
    {
        public Integer ChapBillCatId = null;
        public String ChapBillCatDesc = null;
        public Integer NatId = null;
        public Boolean IsContribution = null;
        public Integer CalcTypeId = null;
        public ArrayList<KeyValuePair<Integer,String>> DonationAmounts = null;
        public String ChartOfAccountRefId = null;
        
        public Integer getChapBillCatId() { return ChapBillCatId; }
        public RecurringObligationChapBillCatDetail setChapBillCatId(Integer value) { this.ChapBillCatId = value; return this; }
        public String getChapBillCatDesc() { return ChapBillCatDesc; }
        public RecurringObligationChapBillCatDetail setChapBillCatDesc(String value) { this.ChapBillCatDesc = value; return this; }
        public Integer getNatId() { return NatId; }
        public RecurringObligationChapBillCatDetail setNatId(Integer value) { this.NatId = value; return this; }
        public Boolean getIsContribution() { return IsContribution; }
        public RecurringObligationChapBillCatDetail setIsContribution(Boolean value) { this.IsContribution = value; return this; }
        public Integer getCalcTypeId() { return CalcTypeId; }
        public RecurringObligationChapBillCatDetail setCalcTypeId(Integer value) { this.CalcTypeId = value; return this; }
        public ArrayList<KeyValuePair<Integer,String>> getDonationAmounts() { return DonationAmounts; }
        public RecurringObligationChapBillCatDetail setDonationAmounts(ArrayList<KeyValuePair<Integer,String>> value) { this.DonationAmounts = value; return this; }
        public String getChartOfAccountRefId() { return ChartOfAccountRefId; }
        public RecurringObligationChapBillCatDetail setChartOfAccountRefId(String value) { this.ChartOfAccountRefId = value; return this; }
    }

}

Java RecurringObligationTemplateGetRq DTOs

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>