Billhighway Cloud API

ExternalBankTransferReportRq

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

**ExternalBankTransferReportRq** Parameters:
Name	Parameter	Data Type	Required
ClientId	query	int	No
GroupId	query	string	No
StartDate	query	DateTime?	No
EndDate	query	DateTime?	No

**ExternalBankTransferReportRs** Parameters:
Name	Parameter	Data Type	Required
GroupId	form	string	No
GroupNickName	form	string	No
GroupName	form	string	No
StartDate	form	string	No
EndDate	form	string	No
TotalAmount	form	decimal	No
Transfers	form	List<TransferHeader>	No
ErrorCode	form	int	No
ErrorMessage	form	string	No
IsError	form	bool	No

**TransferHeader** Parameters:
Name	Parameter	Data Type	Required
BatchId	form	int	No
TransactionId	form	int	No
CashAccount	form	string	No
TransferDate	form	string	No
Amount	form	decimal	No
ClearedDate	form	string	No
Status	form	string	No
BankAccount	form	string	No
TransferDetail	form	List<TransferDetail>	No

**TransferDetail** Parameters:
Name	Parameter	Data Type	Required
TransactionType	form	string	No
TransactionId	form	int	No
Member	form	string	No
ClientUserId	form	string	No
Company	form	string	No
OrderId	form	string	No
Frequency	form	string	No
ProcessedDate	form	string	No
CheckNumber	form	string	No
Amount	form	decimal	No
MemberTypeDescription	form	string	No
ChapBillCatID	form	string	No
ChartOfAccountRefID	form	string	No
ChartOfAccountDescription	form	string	No
HeldPaymentTransactionId	form	string	No

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

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ExternalBankTransferReportRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Financial.Response">
  <EndDate>String</EndDate>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <GroupId>String</GroupId>
  <GroupName>String</GroupName>
  <GroupNickName>String</GroupNickName>
  <StartDate>String</StartDate>
  <TotalAmount>0</TotalAmount>
  <Transfers>
    <TransferHeader>
      <Amount>0</Amount>
      <BankAccount>String</BankAccount>
      <BatchId>0</BatchId>
      <CashAccount>String</CashAccount>
      <ClearedDate>String</ClearedDate>
      <Status>String</Status>
      <TransactionId>0</TransactionId>
      <TransferDate>String</TransferDate>
      <TransferDetail>
        <TransferDetail>
          <Amount>0</Amount>
          <ChapBillCatID>String</ChapBillCatID>
          <ChartOfAccountDescription>String</ChartOfAccountDescription>
          <ChartOfAccountRefID>String</ChartOfAccountRefID>
          <CheckNumber>String</CheckNumber>
          <ClientUserId>String</ClientUserId>
          <Company>String</Company>
          <Frequency>String</Frequency>
          <HeldPaymentTransactionId>String</HeldPaymentTransactionId>
          <Member>String</Member>
          <MemberTypeDescription>String</MemberTypeDescription>
          <OrderId>String</OrderId>
          <ProcessedDate>String</ProcessedDate>
          <TransactionId>0</TransactionId>
          <TransactionType>String</TransactionType>
        </TransferDetail>
      </TransferDetail>
    </TransferHeader>
  </Transfers>
</ExternalBankTransferReportRs>