Billhighway Cloud API

<back to all web services

RecurringObligationFormInfoGetRq

export class ContextualHelpDto
{
    public ControlName?: string;
    public LabelText?: string;
    public IsVisible?: boolean;
    public IsRequired?: boolean;

    public constructor(init?: Partial<ContextualHelpDto>) { (Object as any).assign(this, init); }
}

export class CountryDto
{
    public CountryID?: number;
    public FullName?: string;
    public Abbr?: string;

    public constructor(init?: Partial<CountryDto>) { (Object as any).assign(this, init); }
}

export class StateDto
{
    public StateID?: number;
    public CountryID?: number;
    public FullName?: string;
    public Abbr?: string;

    public constructor(init?: Partial<StateDto>) { (Object as any).assign(this, init); }
}

export class ChapterDto
{
    public ChapId?: number;
    public College?: string;
    public Designation?: string;

    public constructor(init?: Partial<ChapterDto>) { (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 RecurringObligationFormInfo
{
    public ContextualHelp?: ContextualHelpDto[];
    public Countries?: CountryDto[];
    public States?: StateDto[];
    public Chapters?: ChapterDto[];
    public RecurringInvoices?: RecurringInvoiceModel[];
    public RecurringObligationTemplates?: RecurringObligationInvoiceTemplate[];
    public RecurringObligationChapBillCatDetail?: RecurringObligationChapBillCatDetail[];

    public constructor(init?: Partial<RecurringObligationFormInfo>) { (Object as any).assign(this, init); }
}

export class Link
{
    public Rel?: string;
    public Url?: string;

    public constructor(init?: Partial<Link>) { (Object as any).assign(this, init); }
}

export class RecurringObligationFormInfoGetRs
{
    public RecurringObligationFormInfo?: RecurringObligationFormInfo;
    public Links?: Link[];

    public constructor(init?: Partial<RecurringObligationFormInfoGetRs>) { (Object as any).assign(this, init); }
}

export class RecurringObligationFormInfoGetRq
{
    public NatID?: number;
    public GroupId?: number;
    public UserId?: string;
    public UserType?: string;

    public constructor(init?: Partial<RecurringObligationFormInfoGetRq>) { (Object as any).assign(this, init); }
}

TypeScript RecurringObligationFormInfoGetRq DTOs

GET /signup/api/nat/{natID}/recurring/obligation/info HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"RecurringObligationFormInfo":{"ContextualHelp":[{"ControlName":"String","LabelText":"String","IsVisible":false,"IsRequired":false}],"Countries":[{"CountryID":0,"FullName":"String","Abbr":"String"}],"States":[{"StateID":0,"CountryID":0,"FullName":"String","Abbr":"String"}],"Chapters":[{"ChapId":0,"College":"String","Designation":"String"}],"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"}]},"Links":[{"Rel":"String","Url":"String"}]}