Billhighway Cloud API

<back to all web services

ExternalBankTransferReportRq

The following routes are available for this service:
GET/financial/reporting/ebt
ExternalBankTransferReportRq Parameters:
NameParameterData TypeRequiredDescription
ClientIdqueryintNo
GroupIdquerystringNo
StartDatequeryDateTime?No
EndDatequeryDateTime?No
ExternalBankTransferReportRs Parameters:
NameParameterData TypeRequiredDescription
GroupIdformstringNo
GroupNickNameformstringNo
GroupNameformstringNo
StartDateformstringNo
EndDateformstringNo
TotalAmountformdecimalNo
TransfersformList<TransferHeader>No
ErrorCodeformintNo
ErrorMessageformstringNo
IsErrorformboolNo
TransferHeader Parameters:
NameParameterData TypeRequiredDescription
BatchIdformintNo
TransactionIdformintNo
CashAccountformstringNo
TransferDateformstringNo
AmountformdecimalNo
ClearedDateformstringNo
StatusformstringNo
BankAccountformstringNo
TransferDetailformList<TransferDetail>No
TransferDetail Parameters:
NameParameterData TypeRequiredDescription
TransactionTypeformstringNo
TransactionIdformintNo
MemberformstringNo
ClientUserIdformstringNo
CompanyformstringNo
OrderIdformstringNo
FrequencyformstringNo
ProcessedDateformstringNo
CheckNumberformstringNo
AmountformdecimalNo
MemberTypeDescriptionformstringNo
ChapBillCatIDformstringNo
ChartOfAccountRefIDformstringNo
ChartOfAccountDescriptionformstringNo
HeldPaymentTransactionIdformstringNo

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}