Billhighway Cloud API

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