Billhighway Cloud API

<back to all web services

FinancialActivitySummaryRq

The following routes are available for this service:
GET/financial/reporting/activitysummary
import 'package:servicestack/servicestack.dart';
import 'dart:collection';

class Transfer implements IConvertible
{
    String? AccountName;
    int? TransfersCount;
    double? TransfersGrossAmount;
    double? TransfersReversals;

    Transfer({this.AccountName,this.TransfersCount,this.TransfersGrossAmount,this.TransfersReversals});
    Transfer.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AccountName = json['AccountName'];
        TransfersCount = json['TransfersCount'];
        TransfersGrossAmount = JsonConverters.toDouble(json['TransfersGrossAmount']);
        TransfersReversals = JsonConverters.toDouble(json['TransfersReversals']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AccountName': AccountName,
        'TransfersCount': TransfersCount,
        'TransfersGrossAmount': TransfersGrossAmount,
        'TransfersReversals': TransfersReversals
    };

    getTypeName() => "Transfer";
    TypeContext? context = _ctx;
}

class ActivitySummary implements IConvertible
{
    int? SalesCount;
    double? SalesGrossAmount;
    double? SalesGrossFees;
    int? RefundsCount;
    double? RefundsGrossAmount;
    double? RefundsGrossFees;
    int? DisputesCount;
    double? DisputesGrossAmount;
    double? DisputesGrossFees;
    int? DisputeReversalsCount;
    double? DisputeReversalsGrossAmount;
    double? DisputeReversalsGrossFees;
    double? NetActivityAmount;
    List<Transfer>? Transfers;

    ActivitySummary({this.SalesCount,this.SalesGrossAmount,this.SalesGrossFees,this.RefundsCount,this.RefundsGrossAmount,this.RefundsGrossFees,this.DisputesCount,this.DisputesGrossAmount,this.DisputesGrossFees,this.DisputeReversalsCount,this.DisputeReversalsGrossAmount,this.DisputeReversalsGrossFees,this.NetActivityAmount,this.Transfers});
    ActivitySummary.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SalesCount = json['SalesCount'];
        SalesGrossAmount = JsonConverters.toDouble(json['SalesGrossAmount']);
        SalesGrossFees = JsonConverters.toDouble(json['SalesGrossFees']);
        RefundsCount = json['RefundsCount'];
        RefundsGrossAmount = JsonConverters.toDouble(json['RefundsGrossAmount']);
        RefundsGrossFees = JsonConverters.toDouble(json['RefundsGrossFees']);
        DisputesCount = json['DisputesCount'];
        DisputesGrossAmount = JsonConverters.toDouble(json['DisputesGrossAmount']);
        DisputesGrossFees = JsonConverters.toDouble(json['DisputesGrossFees']);
        DisputeReversalsCount = json['DisputeReversalsCount'];
        DisputeReversalsGrossAmount = JsonConverters.toDouble(json['DisputeReversalsGrossAmount']);
        DisputeReversalsGrossFees = JsonConverters.toDouble(json['DisputeReversalsGrossFees']);
        NetActivityAmount = JsonConverters.toDouble(json['NetActivityAmount']);
        Transfers = JsonConverters.fromJson(json['Transfers'],'List<Transfer>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SalesCount': SalesCount,
        'SalesGrossAmount': SalesGrossAmount,
        'SalesGrossFees': SalesGrossFees,
        'RefundsCount': RefundsCount,
        'RefundsGrossAmount': RefundsGrossAmount,
        'RefundsGrossFees': RefundsGrossFees,
        'DisputesCount': DisputesCount,
        'DisputesGrossAmount': DisputesGrossAmount,
        'DisputesGrossFees': DisputesGrossFees,
        'DisputeReversalsCount': DisputeReversalsCount,
        'DisputeReversalsGrossAmount': DisputeReversalsGrossAmount,
        'DisputeReversalsGrossFees': DisputeReversalsGrossFees,
        'NetActivityAmount': NetActivityAmount,
        'Transfers': JsonConverters.toJson(Transfers,'List<Transfer>',context!)
    };

    getTypeName() => "ActivitySummary";
    TypeContext? context = _ctx;
}

class FinancialActivitySummaryRs implements IConvertible
{
    String? GroupId;
    String? GroupNickName;
    String? GroupName;
    String? StartDate;
    String? EndDate;
    ActivitySummary? ActivitySummary;
    int? ErrorCode;
    String? ErrorMessage;
    // @ApiMember(ExcludeInSchema=true)
    bool? IsError;

    FinancialActivitySummaryRs({this.GroupId,this.GroupNickName,this.GroupName,this.StartDate,this.EndDate,this.ActivitySummary,this.ErrorCode,this.ErrorMessage,this.IsError});
    FinancialActivitySummaryRs.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GroupId = json['GroupId'];
        GroupNickName = json['GroupNickName'];
        GroupName = json['GroupName'];
        StartDate = json['StartDate'];
        EndDate = json['EndDate'];
        ActivitySummary = JsonConverters.fromJson(json['ActivitySummary'],'ActivitySummary',context!);
        ErrorCode = json['ErrorCode'];
        ErrorMessage = json['ErrorMessage'];
        IsError = json['IsError'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GroupId': GroupId,
        'GroupNickName': GroupNickName,
        'GroupName': GroupName,
        'StartDate': StartDate,
        'EndDate': EndDate,
        'ActivitySummary': JsonConverters.toJson(ActivitySummary,'ActivitySummary',context!),
        'ErrorCode': ErrorCode,
        'ErrorMessage': ErrorMessage,
        'IsError': IsError
    };

    getTypeName() => "FinancialActivitySummaryRs";
    TypeContext? context = _ctx;
}

class FinancialActivitySummaryRq implements IConvertible
{
    int? ClientId;
    String? GroupId;
    DateTime? StartDate;
    DateTime? EndDate;

    FinancialActivitySummaryRq({this.ClientId,this.GroupId,this.StartDate,this.EndDate});
    FinancialActivitySummaryRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ClientId = json['ClientId'];
        GroupId = json['GroupId'];
        StartDate = JsonConverters.fromJson(json['StartDate'],'DateTime',context!);
        EndDate = JsonConverters.fromJson(json['EndDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ClientId': ClientId,
        'GroupId': GroupId,
        'StartDate': JsonConverters.toJson(StartDate,'DateTime',context!),
        'EndDate': JsonConverters.toJson(EndDate,'DateTime',context!)
    };

    getTypeName() => "FinancialActivitySummaryRq";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'Transfer': TypeInfo(TypeOf.Class, create:() => Transfer()),
    'ActivitySummary': TypeInfo(TypeOf.Class, create:() => ActivitySummary()),
    'List<Transfer>': TypeInfo(TypeOf.Class, create:() => <Transfer>[]),
    'FinancialActivitySummaryRs': TypeInfo(TypeOf.Class, create:() => FinancialActivitySummaryRs()),
    'FinancialActivitySummaryRq': TypeInfo(TypeOf.Class, create:() => FinancialActivitySummaryRq()),
});

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