Billhighway Cloud API

<back to all web services

FinancialActivitySummaryRq

The following routes are available for this service:
GET/financial/reporting/activitysummary
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FinancialActivitySummaryRq
    {
        public Integer ClientId = null;
        public String GroupId = null;
        public Date StartDate = null;
        public Date EndDate = null;
        
        public Integer getClientId() { return ClientId; }
        public FinancialActivitySummaryRq setClientId(Integer value) { this.ClientId = value; return this; }
        public String getGroupId() { return GroupId; }
        public FinancialActivitySummaryRq setGroupId(String value) { this.GroupId = value; return this; }
        public Date getStartDate() { return StartDate; }
        public FinancialActivitySummaryRq setStartDate(Date value) { this.StartDate = value; return this; }
        public Date getEndDate() { return EndDate; }
        public FinancialActivitySummaryRq setEndDate(Date value) { this.EndDate = value; return this; }
    }

    public static class FinancialActivitySummaryRs
    {
        public String GroupId = null;
        public String GroupNickName = null;
        public String GroupName = null;
        public String StartDate = null;
        public String EndDate = null;
        public ActivitySummary ActivitySummary = null;
        public Integer ErrorCode = null;
        public String ErrorMessage = null;
        @ApiMember(ExcludeInSchema=true)
        public Boolean IsError = null;
        
        public String getGroupId() { return GroupId; }
        public FinancialActivitySummaryRs setGroupId(String value) { this.GroupId = value; return this; }
        public String getGroupNickName() { return GroupNickName; }
        public FinancialActivitySummaryRs setGroupNickName(String value) { this.GroupNickName = value; return this; }
        public String getGroupName() { return GroupName; }
        public FinancialActivitySummaryRs setGroupName(String value) { this.GroupName = value; return this; }
        public String getStartDate() { return StartDate; }
        public FinancialActivitySummaryRs setStartDate(String value) { this.StartDate = value; return this; }
        public String getEndDate() { return EndDate; }
        public FinancialActivitySummaryRs setEndDate(String value) { this.EndDate = value; return this; }
        public ActivitySummary getActivitySummary() { return ActivitySummary; }
        public FinancialActivitySummaryRs setActivitySummary(ActivitySummary value) { this.ActivitySummary = value; return this; }
        public Integer getErrorCode() { return ErrorCode; }
        public FinancialActivitySummaryRs setErrorCode(Integer value) { this.ErrorCode = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public FinancialActivitySummaryRs setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Boolean getIsError() { return IsError; }
        public FinancialActivitySummaryRs setIsError(Boolean value) { this.IsError = value; return this; }
    }

    public static class ActivitySummary
    {
        public Integer SalesCount = null;
        public BigDecimal SalesGrossAmount = null;
        public BigDecimal SalesGrossFees = null;
        public Integer RefundsCount = null;
        public BigDecimal RefundsGrossAmount = null;
        public BigDecimal RefundsGrossFees = null;
        public Integer DisputesCount = null;
        public BigDecimal DisputesGrossAmount = null;
        public BigDecimal DisputesGrossFees = null;
        public Integer DisputeReversalsCount = null;
        public BigDecimal DisputeReversalsGrossAmount = null;
        public BigDecimal DisputeReversalsGrossFees = null;
        public BigDecimal NetActivityAmount = null;
        public ArrayList<Transfer> Transfers = null;
        
        public Integer getSalesCount() { return SalesCount; }
        public ActivitySummary setSalesCount(Integer value) { this.SalesCount = value; return this; }
        public BigDecimal getSalesGrossAmount() { return SalesGrossAmount; }
        public ActivitySummary setSalesGrossAmount(BigDecimal value) { this.SalesGrossAmount = value; return this; }
        public BigDecimal getSalesGrossFees() { return SalesGrossFees; }
        public ActivitySummary setSalesGrossFees(BigDecimal value) { this.SalesGrossFees = value; return this; }
        public Integer getRefundsCount() { return RefundsCount; }
        public ActivitySummary setRefundsCount(Integer value) { this.RefundsCount = value; return this; }
        public BigDecimal getRefundsGrossAmount() { return RefundsGrossAmount; }
        public ActivitySummary setRefundsGrossAmount(BigDecimal value) { this.RefundsGrossAmount = value; return this; }
        public BigDecimal getRefundsGrossFees() { return RefundsGrossFees; }
        public ActivitySummary setRefundsGrossFees(BigDecimal value) { this.RefundsGrossFees = value; return this; }
        public Integer getDisputesCount() { return DisputesCount; }
        public ActivitySummary setDisputesCount(Integer value) { this.DisputesCount = value; return this; }
        public BigDecimal getDisputesGrossAmount() { return DisputesGrossAmount; }
        public ActivitySummary setDisputesGrossAmount(BigDecimal value) { this.DisputesGrossAmount = value; return this; }
        public BigDecimal getDisputesGrossFees() { return DisputesGrossFees; }
        public ActivitySummary setDisputesGrossFees(BigDecimal value) { this.DisputesGrossFees = value; return this; }
        public Integer getDisputeReversalsCount() { return DisputeReversalsCount; }
        public ActivitySummary setDisputeReversalsCount(Integer value) { this.DisputeReversalsCount = value; return this; }
        public BigDecimal getDisputeReversalsGrossAmount() { return DisputeReversalsGrossAmount; }
        public ActivitySummary setDisputeReversalsGrossAmount(BigDecimal value) { this.DisputeReversalsGrossAmount = value; return this; }
        public BigDecimal getDisputeReversalsGrossFees() { return DisputeReversalsGrossFees; }
        public ActivitySummary setDisputeReversalsGrossFees(BigDecimal value) { this.DisputeReversalsGrossFees = value; return this; }
        public BigDecimal getNetActivityAmount() { return NetActivityAmount; }
        public ActivitySummary setNetActivityAmount(BigDecimal value) { this.NetActivityAmount = value; return this; }
        public ArrayList<Transfer> getTransfers() { return Transfers; }
        public ActivitySummary setTransfers(ArrayList<Transfer> value) { this.Transfers = value; return this; }
    }

    public static class Transfer
    {
        public String AccountName = null;
        public Integer TransfersCount = null;
        public BigDecimal TransfersGrossAmount = null;
        public BigDecimal TransfersReversals = null;
        
        public String getAccountName() { return AccountName; }
        public Transfer setAccountName(String value) { this.AccountName = value; return this; }
        public Integer getTransfersCount() { return TransfersCount; }
        public Transfer setTransfersCount(Integer value) { this.TransfersCount = value; return this; }
        public BigDecimal getTransfersGrossAmount() { return TransfersGrossAmount; }
        public Transfer setTransfersGrossAmount(BigDecimal value) { this.TransfersGrossAmount = value; return this; }
        public BigDecimal getTransfersReversals() { return TransfersReversals; }
        public Transfer setTransfersReversals(BigDecimal value) { this.TransfersReversals = value; return this; }
    }

}

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