Billhighway Cloud API

FinancialActivitySummaryRq

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


export class Transfer
{
    public AccountName?: string;
    public TransfersCount?: number;
    public TransfersGrossAmount?: number;
    public TransfersReversals?: number;

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

export class ActivitySummary
{
    public SalesCount?: number;
    public SalesGrossAmount?: number;
    public SalesGrossFees?: number;
    public RefundsCount?: number;
    public RefundsGrossAmount?: number;
    public RefundsGrossFees?: number;
    public DisputesCount?: number;
    public DisputesGrossAmount?: number;
    public DisputesGrossFees?: number;
    public DisputeReversalsCount?: number;
    public DisputeReversalsGrossAmount?: number;
    public DisputeReversalsGrossFees?: number;
    public NetActivityAmount?: number;
    public Transfers?: Transfer[];

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

export class FinancialActivitySummaryRs
{
    public GroupId?: string;
    public GroupNickName?: string;
    public GroupName?: string;
    public StartDate?: string;
    public EndDate?: string;
    public ActivitySummary?: ActivitySummary;
    public ErrorCode?: number;
    public ErrorMessage?: string;
    // @ApiMember(ExcludeInSchema=true)
    public IsError?: boolean;

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

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

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

TypeScript FinancialActivitySummaryRq 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/activitysummary HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancialActivitySummaryRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Financial.Response">
  <ActivitySummary>
    <DisputeReversalsCount>0</DisputeReversalsCount>
    <DisputeReversalsGrossAmount>0</DisputeReversalsGrossAmount>
    <DisputeReversalsGrossFees>0</DisputeReversalsGrossFees>
    <DisputesCount>0</DisputesCount>
    <DisputesGrossAmount>0</DisputesGrossAmount>
    <DisputesGrossFees>0</DisputesGrossFees>
    <NetActivityAmount>0</NetActivityAmount>
    <RefundsCount>0</RefundsCount>
    <RefundsGrossAmount>0</RefundsGrossAmount>
    <RefundsGrossFees>0</RefundsGrossFees>
    <SalesCount>0</SalesCount>
    <SalesGrossAmount>0</SalesGrossAmount>
    <SalesGrossFees>0</SalesGrossFees>
    <Transfers>
      <Transfer>
        <AccountName>String</AccountName>
        <TransfersCount>0</TransfersCount>
        <TransfersGrossAmount>0</TransfersGrossAmount>
        <TransfersReversals>0</TransfersReversals>
      </Transfer>
    </Transfers>
  </ActivitySummary>
  <EndDate>String</EndDate>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <GroupId>String</GroupId>
  <GroupName>String</GroupName>
  <GroupNickName>String</GroupNickName>
  <StartDate>String</StartDate>
</FinancialActivitySummaryRs>