Billhighway Cloud API

<back to all web services

PaymentApplicationRequest

export class LineItem
{
    public chartOfAccountRefID?: string;
    public chartOfAccountDescription?: string;
    public cashAccount?: string;
    public amount?: number;
    public fee?: number;

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

export class TransactionHistory
{
    public type?: string;
    public date?: string;
    public lineItems?: LineItem[];

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

export class UserTransaction
{
    public transactionID?: number;
    public date?: string;
    public type?: string;
    public accountLast4?: string;
    public amount?: number;
    public unapplied?: number;
    public unappliedFee?: number;
    public returnReason?: string;
    public returnDate?: string;
    public refundAmount?: number;
    public lineItems?: LineItem[];
    public transactionHistory?: TransactionHistory[];

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

export class PaymentApplicationUser
{
    public groupID?: string;
    public fiscalYear?: number;
    public userID?: string;
    public bhUserID?: number;
    public autoPayStatus?: string;
    public userTransactions?: UserTransaction[];

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

export class Paging
{
    public page?: number;
    public totalPages?: number;
    public next?: string;

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

export class PaymentApplicationResponse
{
    public IsError?: boolean;
    public users?: PaymentApplicationUser[];
    public ErrorMessage?: string;
    public paging?: Paging;

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

export class PaymentApplicationRequest
{
    public transactionID?: number;
    public groupID?: string;
    public userID?: string;
    public bhUserID?: number;
    public transactionBeginDate?: string;
    public transactionEndDate?: string;
    public fiscalYear?: number;
    public page?: number;

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

TypeScript PaymentApplicationRequest DTOs

GET /payments/paymentApplication HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsError: True,
	users: 
	[
		{
			groupID: String,
			fiscalYear: 0,
			userID: String,
			bhUserID: 0,
			autoPayStatus: String,
			userTransactions: 
			[
				{
					transactionID: 0,
					date: String,
					type: String,
					accountLast4: String,
					amount: 0,
					unapplied: 0,
					unappliedFee: 0,
					returnReason: String,
					returnDate: String,
					refundAmount: 0,
					lineItems: 
					[
						{
							chartOfAccountRefID: String,
							chartOfAccountDescription: String,
							cashAccount: String,
							amount: 0,
							fee: 0
						}
					],
					transactionHistory: 
					[
						{
							type: String,
							date: String,
							lineItems: 
							[
								{
									chartOfAccountRefID: String,
									chartOfAccountDescription: String,
									cashAccount: String,
									amount: 0,
									fee: 0
								}
							]
						}
					]
				}
			]
		}
	],
	ErrorMessage: String,
	paging: 
	{
		page: 0,
		totalPages: 0,
		next: String
	}
}