Billhighway Cloud API

ExternalBankTransferReportRq

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

namespace BH.CloudAPI.Common4.DTO.Financial.Request

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TransferDetail() = 
        member val TransactionType:String = null with get,set
        member val TransactionId:Int32 = new Int32() with get,set
        member val Member:String = null with get,set
        member val ClientUserId:String = null with get,set
        member val Company:String = null with get,set
        member val OrderId:String = null with get,set
        member val Frequency:String = null with get,set
        member val ProcessedDate:String = null with get,set
        member val CheckNumber:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val MemberTypeDescription:String = null with get,set
        member val ChapBillCatID:String = null with get,set
        member val ChartOfAccountRefID:String = null with get,set
        member val ChartOfAccountDescription:String = null with get,set
        member val HeldPaymentTransactionId:String = null with get,set

    [<AllowNullLiteral>]
    type TransferHeader() = 
        member val BatchId:Int32 = new Int32() with get,set
        member val TransactionId:Int32 = new Int32() with get,set
        member val CashAccount:String = null with get,set
        member val TransferDate:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val ClearedDate:String = null with get,set
        member val Status:String = null with get,set
        member val BankAccount:String = null with get,set
        member val TransferDetail:ResizeArray<TransferDetail> = new ResizeArray<TransferDetail>() with get,set

    [<AllowNullLiteral>]
    type ExternalBankTransferReportRs() = 
        member val GroupId:String = null with get,set
        member val GroupNickName:String = null with get,set
        member val GroupName:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set
        member val TotalAmount:Decimal = new Decimal() with get,set
        member val Transfers:ResizeArray<TransferHeader> = new ResizeArray<TransferHeader>() with get,set
        member val ErrorCode:Int32 = new Int32() with get,set
        member val ErrorMessage:String = null with get,set
        [<ApiMember(ExcludeInSchema=true)>]
        member val IsError:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ExternalBankTransferReportRq() = 
        member val ClientId:Int32 = new Int32() with get,set
        member val GroupId:String = null with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# 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>