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.*


open class ExternalBankTransferReportRq
{
    var ClientId:Int? = null
    var GroupId:String? = null
    var StartDate:Date? = null
    var EndDate:Date? = null
}

open class ExternalBankTransferReportRs
{
    var GroupId:String? = null
    var GroupNickName:String? = null
    var GroupName:String? = null
    var StartDate:String? = null
    var EndDate:String? = null
    var TotalAmount:BigDecimal? = null
    var Transfers:ArrayList<TransferHeader> = ArrayList<TransferHeader>()
    var ErrorCode:Int? = null
    var ErrorMessage:String? = null
    @ApiMember(ExcludeInSchema=true)
    var IsError:Boolean? = null
}

open class TransferHeader
{
    var BatchId:Int? = null
    var TransactionId:Int? = null
    var CashAccount:String? = null
    var TransferDate:String? = null
    var Amount:BigDecimal? = null
    var ClearedDate:String? = null
    var Status:String? = null
    var BankAccount:String? = null
    var TransferDetail:ArrayList<TransferDetail> = ArrayList<TransferDetail>()
}

open class TransferDetail
{
    var TransactionType:String? = null
    var TransactionId:Int? = null
    var Member:String? = null
    var ClientUserId:String? = null
    var Company:String? = null
    var OrderId:String? = null
    var Frequency:String? = null
    var ProcessedDate:String? = null
    var CheckNumber:String? = null
    var Amount:BigDecimal? = null
    var MemberTypeDescription:String? = null
    var ChapBillCatID:String? = null
    var ChartOfAccountRefID:String? = null
    var ChartOfAccountDescription:String? = null
    var HeldPaymentTransactionId:String? = null
}

Kotlin ExternalBankTransferReportRq DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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}