| 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 |
export class RecurringObligationTemplateGetRq
{
public NatID?: number;
public GroupId?: number;
public UserId?: string;
public UserType?: string;
public constructor(init?: Partial<RecurringObligationTemplateGetRq>) { (Object as any).assign(this, init); }
}
export class RecurringInvoiceModel
{
public ChapID?: number;
public ClientGroupID?: string;
public RecurringInvoiceID?: number;
public MemTypeID?: number;
public BillingTypeName?: string;
public InvoiceDescription?: string;
public Amount?: number;
public ProcessingCurrency?: string;
public FrequencyDescription?: string;
public EffectiveDate?: string;
public EndDate?: string;
public NextDueDate?: string;
public donationCoaNum?: string;
public donationCoaDesc?: string;
public Donation_ChapBillCatID?: number;
public FrequencyID?: number;
public Monthly_DayOfMOnth?: number;
public Weekly_DayOfWeek?: number;
public SemiMonthly_DayOfMonth1?: number;
public SemiMonthly_DayOfMonth2?: number;
public UseLastDayOfMonth?: boolean;
public IsActive?: boolean;
public NumOccurences?: number;
public constructor(init?: Partial<RecurringInvoiceModel>) { (Object as any).assign(this, init); }
}
export class FiscalYearItem
{
public Year?: number;
public BeginDate?: string;
public EndDate?: string;
public constructor(init?: Partial<FiscalYearItem>) { (Object as any).assign(this, init); }
}
export class RecurringObligationInvoiceTemplateItem
{
public RecurringObligationTemplateItemId?: number;
public RecurringObligationInvoiceTemplateItemId?: number;
public RecurringObligationInvoiceTemplateId?: number;
public Amount?: number;
public ChapBillCatId?: number;
public Name?: string;
public constructor(init?: Partial<RecurringObligationInvoiceTemplateItem>) { (Object as any).assign(this, init); }
}
export class RecurringObligationInvoiceTemplate
{
public RecurringObligationTemplateId?: number;
public RecurringObligationInvoiceTemplateId?: number;
public NationalId?: number;
public MemberTypeClientId?: number;
public FiscalYear?: FiscalYearItem;
public ChapId?: number;
public IsDeleted?: boolean;
public Name?: string;
public RecurringObligationInvoiceTemplateItems?: RecurringObligationInvoiceTemplateItem[];
public constructor(init?: Partial<RecurringObligationInvoiceTemplate>) { (Object as any).assign(this, init); }
}
export class RecurringObligationChapBillCatDetail
{
public ChapBillCatId?: number;
public ChapBillCatDesc?: string;
public NatId?: number;
public IsContribution?: boolean;
public CalcTypeId?: number;
public DonationAmounts?: KeyValuePair<number,string>[];
public ChartOfAccountRefId?: string;
public constructor(init?: Partial<RecurringObligationChapBillCatDetail>) { (Object as any).assign(this, init); }
}
export class RecurringObligationWrapper
{
public RecurringInvoices?: RecurringInvoiceModel[];
public RecurringObligationTemplates?: RecurringObligationInvoiceTemplate[];
public RecurringObligationChapBillCatDetail?: RecurringObligationChapBillCatDetail[];
public constructor(init?: Partial<RecurringObligationWrapper>) { (Object as any).assign(this, init); }
}
export class RecurringObligationTemplateGetRs
{
public RecurringObligations?: RecurringObligationWrapper;
public constructor(init?: Partial<RecurringObligationTemplateGetRs>) { (Object as any).assign(this, init); }
}
TypeScript RecurringObligationTemplateGetRq DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>