Billhighway Cloud API

<back to all web services

ExternalBankTransferReportRq

The following routes are available for this service:
GET/financial/reporting/ebt
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.Financial.Request;
using BH.CloudAPI.Common4.DTO.Financial.Response;

namespace BH.CloudAPI.Common4.DTO.Financial.Request
{
    public partial class ExternalBankTransferReportRq
    {
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual DateTime? StartDate { get; set; }
        public virtual DateTime? EndDate { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Financial.Response
{
    public partial class ExternalBankTransferReportRs
    {
        public ExternalBankTransferReportRs()
        {
            Transfers = new List<TransferHeader>{};
        }

        public virtual string GroupId { get; set; }
        public virtual string GroupNickName { get; set; }
        public virtual string GroupName { get; set; }
        public virtual string StartDate { get; set; }
        public virtual string EndDate { get; set; }
        public virtual decimal TotalAmount { get; set; }
        public virtual List<TransferHeader> Transfers { get; set; }
        public virtual int ErrorCode { get; set; }
        public virtual string ErrorMessage { get; set; }
        [ApiMember(ExcludeInSchema=true)]
        public virtual bool IsError { get; set; }
    }

    public partial class TransferDetail
    {
        public virtual string TransactionType { get; set; }
        public virtual int TransactionId { get; set; }
        public virtual string Member { get; set; }
        public virtual string ClientUserId { get; set; }
        public virtual string Company { get; set; }
        public virtual string OrderId { get; set; }
        public virtual string Frequency { get; set; }
        public virtual string ProcessedDate { get; set; }
        public virtual string CheckNumber { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string MemberTypeDescription { get; set; }
        public virtual string ChapBillCatID { get; set; }
        public virtual string ChartOfAccountRefID { get; set; }
        public virtual string ChartOfAccountDescription { get; set; }
        public virtual string HeldPaymentTransactionId { get; set; }
    }

    public partial class TransferHeader
    {
        public TransferHeader()
        {
            TransferDetail = new List<TransferDetail>{};
        }

        public virtual int BatchId { get; set; }
        public virtual int TransactionId { get; set; }
        public virtual string CashAccount { get; set; }
        public virtual string TransferDate { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string ClearedDate { get; set; }
        public virtual string Status { get; set; }
        public virtual string BankAccount { get; set; }
        public virtual List<TransferDetail> TransferDetail { get; set; }
    }

}

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