| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
EndDate: 0001-01-01,
NextDueDate: 0001-01-01,
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-01,
EndDate: 0001-01-01
},
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
}
]
}
}