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