Billhighway Cloud API

<back to all web services

ExternalBankTransferReportRq

The following routes are available for this service:
GET/financial/reporting/ebt
namespace BH.CloudAPI.Common4.DTO.Financial.Request

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TransferDetail() = 
        member val TransactionType:String = null with get,set
        member val TransactionId:Int32 = new Int32() with get,set
        member val Member:String = null with get,set
        member val ClientUserId:String = null with get,set
        member val Company:String = null with get,set
        member val OrderId:String = null with get,set
        member val Frequency:String = null with get,set
        member val ProcessedDate:String = null with get,set
        member val CheckNumber:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val MemberTypeDescription:String = null with get,set
        member val ChapBillCatID:String = null with get,set
        member val ChartOfAccountRefID:String = null with get,set
        member val ChartOfAccountDescription:String = null with get,set
        member val HeldPaymentTransactionId:String = null with get,set

    [<AllowNullLiteral>]
    type TransferHeader() = 
        member val BatchId:Int32 = new Int32() with get,set
        member val TransactionId:Int32 = new Int32() with get,set
        member val CashAccount:String = null with get,set
        member val TransferDate:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val ClearedDate:String = null with get,set
        member val Status:String = null with get,set
        member val BankAccount:String = null with get,set
        member val TransferDetail:ResizeArray<TransferDetail> = new ResizeArray<TransferDetail>() with get,set

    [<AllowNullLiteral>]
    type ExternalBankTransferReportRs() = 
        member val GroupId:String = null with get,set
        member val GroupNickName:String = null with get,set
        member val GroupName:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set
        member val TotalAmount:Decimal = new Decimal() with get,set
        member val Transfers:ResizeArray<TransferHeader> = new ResizeArray<TransferHeader>() with get,set
        member val ErrorCode:Int32 = new Int32() with get,set
        member val ErrorMessage:String = null with get,set
        [<ApiMember(ExcludeInSchema=true)>]
        member val IsError:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ExternalBankTransferReportRq() = 
        member val ClientId:Int32 = new Int32() with get,set
        member val GroupId:String = null with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# 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
}