Billhighway Cloud API

<back to all web services

ExternalBankTransferReportRq

The following routes are available for this service:
GET/financial/reporting/ebt

export class TransferDetail
{
    public TransactionType?: string;
    public TransactionId?: number;
    public Member?: string;
    public ClientUserId?: string;
    public Company?: string;
    public OrderId?: string;
    public Frequency?: string;
    public ProcessedDate?: string;
    public CheckNumber?: string;
    public Amount?: number;
    public MemberTypeDescription?: string;
    public ChapBillCatID?: string;
    public ChartOfAccountRefID?: string;
    public ChartOfAccountDescription?: string;
    public HeldPaymentTransactionId?: string;

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

export class TransferHeader
{
    public BatchId?: number;
    public TransactionId?: number;
    public CashAccount?: string;
    public TransferDate?: string;
    public Amount?: number;
    public ClearedDate?: string;
    public Status?: string;
    public BankAccount?: string;
    public TransferDetail?: TransferDetail[];

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

export class ExternalBankTransferReportRs
{
    public GroupId?: string;
    public GroupNickName?: string;
    public GroupName?: string;
    public StartDate?: string;
    public EndDate?: string;
    public TotalAmount?: number;
    public Transfers?: TransferHeader[];
    public ErrorCode?: number;
    public ErrorMessage?: string;
    // @ApiMember(ExcludeInSchema=true)
    public IsError?: boolean;

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

export class ExternalBankTransferReportRq
{
    public ClientId?: number;
    public GroupId?: string;
    public StartDate?: string;
    public EndDate?: string;

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

TypeScript ExternalBankTransferReportRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /financial/reporting/ebt HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	GroupId: String,
	GroupNickName: String,
	GroupName: String,
	StartDate: String,
	EndDate: String,
	TotalAmount: 0,
	Transfers: 
	[
		{
			BatchId: 0,
			TransactionId: 0,
			CashAccount: String,
			TransferDate: String,
			Amount: 0,
			ClearedDate: String,
			Status: String,
			BankAccount: String,
			TransferDetail: 
			[
				{
					TransactionType: String,
					TransactionId: 0,
					Member: String,
					ClientUserId: String,
					Company: String,
					OrderId: String,
					Frequency: String,
					ProcessedDate: String,
					CheckNumber: String,
					Amount: 0,
					MemberTypeDescription: String,
					ChapBillCatID: String,
					ChartOfAccountRefID: String,
					ChartOfAccountDescription: String,
					HeldPaymentTransactionId: String
				}
			]
		}
	],
	ErrorCode: 0,
	ErrorMessage: String,
	IsError: False
}