Billhighway Cloud API

<back to all web services

ExternalBankTransferReportRq

The following routes are available for this service:
GET/financial/reporting/ebt
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ExternalBankTransferReportRq
    {
        public Integer ClientId = null;
        public String GroupId = null;
        public Date StartDate = null;
        public Date EndDate = null;
        
        public Integer getClientId() { return ClientId; }
        public ExternalBankTransferReportRq setClientId(Integer value) { this.ClientId = value; return this; }
        public String getGroupId() { return GroupId; }
        public ExternalBankTransferReportRq setGroupId(String value) { this.GroupId = value; return this; }
        public Date getStartDate() { return StartDate; }
        public ExternalBankTransferReportRq setStartDate(Date value) { this.StartDate = value; return this; }
        public Date getEndDate() { return EndDate; }
        public ExternalBankTransferReportRq setEndDate(Date value) { this.EndDate = value; return this; }
    }

    public static class ExternalBankTransferReportRs
    {
        public String GroupId = null;
        public String GroupNickName = null;
        public String GroupName = null;
        public String StartDate = null;
        public String EndDate = null;
        public BigDecimal TotalAmount = null;
        public ArrayList<TransferHeader> Transfers = null;
        public Integer ErrorCode = null;
        public String ErrorMessage = null;
        @ApiMember(ExcludeInSchema=true)
        public Boolean IsError = null;
        
        public String getGroupId() { return GroupId; }
        public ExternalBankTransferReportRs setGroupId(String value) { this.GroupId = value; return this; }
        public String getGroupNickName() { return GroupNickName; }
        public ExternalBankTransferReportRs setGroupNickName(String value) { this.GroupNickName = value; return this; }
        public String getGroupName() { return GroupName; }
        public ExternalBankTransferReportRs setGroupName(String value) { this.GroupName = value; return this; }
        public String getStartDate() { return StartDate; }
        public ExternalBankTransferReportRs setStartDate(String value) { this.StartDate = value; return this; }
        public String getEndDate() { return EndDate; }
        public ExternalBankTransferReportRs setEndDate(String value) { this.EndDate = value; return this; }
        public BigDecimal getTotalAmount() { return TotalAmount; }
        public ExternalBankTransferReportRs setTotalAmount(BigDecimal value) { this.TotalAmount = value; return this; }
        public ArrayList<TransferHeader> getTransfers() { return Transfers; }
        public ExternalBankTransferReportRs setTransfers(ArrayList<TransferHeader> value) { this.Transfers = value; return this; }
        public Integer getErrorCode() { return ErrorCode; }
        public ExternalBankTransferReportRs setErrorCode(Integer value) { this.ErrorCode = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public ExternalBankTransferReportRs setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Boolean getIsError() { return IsError; }
        public ExternalBankTransferReportRs setIsError(Boolean value) { this.IsError = value; return this; }
    }

    public static class TransferHeader
    {
        public Integer BatchId = null;
        public Integer TransactionId = null;
        public String CashAccount = null;
        public String TransferDate = null;
        public BigDecimal Amount = null;
        public String ClearedDate = null;
        public String Status = null;
        public String BankAccount = null;
        public ArrayList<TransferDetail> TransferDetail = null;
        
        public Integer getBatchId() { return BatchId; }
        public TransferHeader setBatchId(Integer value) { this.BatchId = value; return this; }
        public Integer getTransactionId() { return TransactionId; }
        public TransferHeader setTransactionId(Integer value) { this.TransactionId = value; return this; }
        public String getCashAccount() { return CashAccount; }
        public TransferHeader setCashAccount(String value) { this.CashAccount = value; return this; }
        public String getTransferDate() { return TransferDate; }
        public TransferHeader setTransferDate(String value) { this.TransferDate = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public TransferHeader setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getClearedDate() { return ClearedDate; }
        public TransferHeader setClearedDate(String value) { this.ClearedDate = value; return this; }
        public String getStatus() { return Status; }
        public TransferHeader setStatus(String value) { this.Status = value; return this; }
        public String getBankAccount() { return BankAccount; }
        public TransferHeader setBankAccount(String value) { this.BankAccount = value; return this; }
        public ArrayList<TransferDetail> getTransferDetail() { return TransferDetail; }
        public TransferHeader setTransferDetail(ArrayList<TransferDetail> value) { this.TransferDetail = value; return this; }
    }

    public static class TransferDetail
    {
        public String TransactionType = null;
        public Integer TransactionId = null;
        public String Member = null;
        public String ClientUserId = null;
        public String Company = null;
        public String OrderId = null;
        public String Frequency = null;
        public String ProcessedDate = null;
        public String CheckNumber = null;
        public BigDecimal Amount = null;
        public String MemberTypeDescription = null;
        public String ChapBillCatID = null;
        public String ChartOfAccountRefID = null;
        public String ChartOfAccountDescription = null;
        public String HeldPaymentTransactionId = null;
        
        public String getTransactionType() { return TransactionType; }
        public TransferDetail setTransactionType(String value) { this.TransactionType = value; return this; }
        public Integer getTransactionId() { return TransactionId; }
        public TransferDetail setTransactionId(Integer value) { this.TransactionId = value; return this; }
        public String getMember() { return Member; }
        public TransferDetail setMember(String value) { this.Member = value; return this; }
        public String getClientUserId() { return ClientUserId; }
        public TransferDetail setClientUserId(String value) { this.ClientUserId = value; return this; }
        public String getCompany() { return Company; }
        public TransferDetail setCompany(String value) { this.Company = value; return this; }
        public String getOrderId() { return OrderId; }
        public TransferDetail setOrderId(String value) { this.OrderId = value; return this; }
        public String getFrequency() { return Frequency; }
        public TransferDetail setFrequency(String value) { this.Frequency = value; return this; }
        public String getProcessedDate() { return ProcessedDate; }
        public TransferDetail setProcessedDate(String value) { this.ProcessedDate = value; return this; }
        public String getCheckNumber() { return CheckNumber; }
        public TransferDetail setCheckNumber(String value) { this.CheckNumber = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public TransferDetail setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getMemberTypeDescription() { return MemberTypeDescription; }
        public TransferDetail setMemberTypeDescription(String value) { this.MemberTypeDescription = value; return this; }
        public String getChapBillCatID() { return ChapBillCatID; }
        public TransferDetail setChapBillCatID(String value) { this.ChapBillCatID = value; return this; }
        public String getChartOfAccountRefID() { return ChartOfAccountRefID; }
        public TransferDetail setChartOfAccountRefID(String value) { this.ChartOfAccountRefID = value; return this; }
        public String getChartOfAccountDescription() { return ChartOfAccountDescription; }
        public TransferDetail setChartOfAccountDescription(String value) { this.ChartOfAccountDescription = value; return this; }
        public String getHeldPaymentTransactionId() { return HeldPaymentTransactionId; }
        public TransferDetail setHeldPaymentTransactionId(String value) { this.HeldPaymentTransactionId = value; return this; }
    }

}

Java 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
}