Billhighway Cloud API

<back to all web services

ExternalBankTransferReportRq

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

public class ExternalBankTransferReportRq : Codable
{
    public var clientId:Int?
    public var groupId:String?
    public var startDate:Date?
    public var endDate:Date?

    required public init(){}
}

public class ExternalBankTransferReportRs : Codable
{
    public var groupId:String?
    public var groupNickName:String?
    public var groupName:String?
    public var startDate:String?
    public var endDate:String?
    public var totalAmount:Double?
    public var transfers:[TransferHeader] = []
    public var errorCode:Int?
    public var errorMessage:String?
    // @ApiMember(ExcludeInSchema=true)
    public var isError:Bool?

    required public init(){}
}

public class TransferHeader : Codable
{
    public var batchId:Int?
    public var transactionId:Int?
    public var cashAccount:String?
    public var transferDate:String?
    public var amount:Double?
    public var clearedDate:String?
    public var status:String?
    public var bankAccount:String?
    public var transferDetail:[TransferDetail] = []

    required public init(){}
}

public class TransferDetail : Codable
{
    public var transactionType:String?
    public var transactionId:Int?
    public var member:String?
    public var clientUserId:String?
    public var company:String?
    public var orderId:String?
    public var frequency:String?
    public var processedDate:String?
    public var checkNumber:String?
    public var amount:Double?
    public var memberTypeDescription:String?
    public var chapBillCatID:String?
    public var chartOfAccountRefID:String?
    public var chartOfAccountDescription:String?
    public var heldPaymentTransactionId:String?

    required public init(){}
}

Swift ExternalBankTransferReportRq DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

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