Billhighway Cloud API

ExternalBankTransferReportRq

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.Financial.Request
Imports BH.CloudAPI.Common4.DTO.Financial.Response

Namespace Global

    Namespace BH.CloudAPI.Common4.DTO.Financial.Request

        Public Partial Class ExternalBankTransferReportRq
            Public Overridable Property ClientId As Integer
            Public Overridable Property GroupId As String
            Public Overridable Property StartDate As Nullable(Of Date)
            Public Overridable Property EndDate As Nullable(Of Date)
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.Financial.Response

        Public Partial Class ExternalBankTransferReportRs
            Public Sub New()
                Transfers = New List(Of TransferHeader)
            End Sub

            Public Overridable Property GroupId As String
            Public Overridable Property GroupNickName As String
            Public Overridable Property GroupName As String
            Public Overridable Property StartDate As String
            Public Overridable Property EndDate As String
            Public Overridable Property TotalAmount As Decimal
            Public Overridable Property Transfers As List(Of TransferHeader)
            Public Overridable Property ErrorCode As Integer
            Public Overridable Property ErrorMessage As String
            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property IsError As Boolean
        End Class

        Public Partial Class TransferDetail
            Public Overridable Property TransactionType As String
            Public Overridable Property TransactionId As Integer
            Public Overridable Property Member As String
            Public Overridable Property ClientUserId As String
            Public Overridable Property Company As String
            Public Overridable Property OrderId As String
            Public Overridable Property Frequency As String
            Public Overridable Property ProcessedDate As String
            Public Overridable Property CheckNumber As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property MemberTypeDescription As String
            Public Overridable Property ChapBillCatID As String
            Public Overridable Property ChartOfAccountRefID As String
            Public Overridable Property ChartOfAccountDescription As String
            Public Overridable Property HeldPaymentTransactionId As String
        End Class

        Public Partial Class TransferHeader
            Public Sub New()
                TransferDetail = New List(Of TransferDetail)
            End Sub

            Public Overridable Property BatchId As Integer
            Public Overridable Property TransactionId As Integer
            Public Overridable Property CashAccount As String
            Public Overridable Property TransferDate As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property ClearedDate As String
            Public Overridable Property Status As String
            Public Overridable Property BankAccount As String
            Public Overridable Property TransferDetail As List(Of TransferDetail)
        End Class
    End Namespace
End Namespace

VB.NET ExternalBankTransferReportRq DTOs

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>