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