Billhighway Cloud API

ExternalBankTransferReportRq

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


export class TransferDetail
{
    public TransactionType?: string;
    public TransactionId?: number;
    public Member?: string;
    public ClientUserId?: string;
    public Company?: string;
    public OrderId?: string;
    public Frequency?: string;
    public ProcessedDate?: string;
    public CheckNumber?: string;
    public Amount?: number;
    public MemberTypeDescription?: string;
    public ChapBillCatID?: string;
    public ChartOfAccountRefID?: string;
    public ChartOfAccountDescription?: string;
    public HeldPaymentTransactionId?: string;

    public constructor(init?: Partial<TransferDetail>) { (Object as any).assign(this, init); }
}

export class TransferHeader
{
    public BatchId?: number;
    public TransactionId?: number;
    public CashAccount?: string;
    public TransferDate?: string;
    public Amount?: number;
    public ClearedDate?: string;
    public Status?: string;
    public BankAccount?: string;
    public TransferDetail?: TransferDetail[];

    public constructor(init?: Partial<TransferHeader>) { (Object as any).assign(this, init); }
}

export class ExternalBankTransferReportRs
{
    public GroupId?: string;
    public GroupNickName?: string;
    public GroupName?: string;
    public StartDate?: string;
    public EndDate?: string;
    public TotalAmount?: number;
    public Transfers?: TransferHeader[];
    public ErrorCode?: number;
    public ErrorMessage?: string;
    // @ApiMember(ExcludeInSchema=true)
    public IsError?: boolean;

    public constructor(init?: Partial<ExternalBankTransferReportRs>) { (Object as any).assign(this, init); }
}

export class ExternalBankTransferReportRq
{
    public ClientId?: number;
    public GroupId?: string;
    public StartDate?: string;
    public EndDate?: string;

    public constructor(init?: Partial<ExternalBankTransferReportRq>) { (Object as any).assign(this, init); }
}

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