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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"GroupId":"String","GroupNickName":"String","GroupName":"String","StartDate":"String","EndDate":"String","ActivitySummary":{"SalesCount":0,"SalesGrossAmount":0,"SalesGrossFees":0,"RefundsCount":0,"RefundsGrossAmount":0,"RefundsGrossFees":0,"DisputesCount":0,"DisputesGrossAmount":0,"DisputesGrossFees":0,"DisputeReversalsCount":0,"DisputeReversalsGrossAmount":0,"DisputeReversalsGrossFees":0,"NetActivityAmount":0,"Transfers":[{"AccountName":"String","TransfersCount":0,"TransfersGrossAmount":0,"TransfersReversals":0}]},"ErrorCode":0,"ErrorMessage":"String","IsError":false}