Billhighway Cloud API

FinancialActivitySummaryRq

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class FinancialActivitySummaryRq
{
    var ClientId:Int? = null
    var GroupId:String? = null
    var StartDate:Date? = null
    var EndDate:Date? = null
}

open class FinancialActivitySummaryRs
{
    var GroupId:String? = null
    var GroupNickName:String? = null
    var GroupName:String? = null
    var StartDate:String? = null
    var EndDate:String? = null
    var ActivitySummary:ActivitySummary? = null
    var ErrorCode:Int? = null
    var ErrorMessage:String? = null
    @ApiMember(ExcludeInSchema=true)
    var IsError:Boolean? = null
}

open class ActivitySummary
{
    var SalesCount:Int? = null
    var SalesGrossAmount:BigDecimal? = null
    var SalesGrossFees:BigDecimal? = null
    var RefundsCount:Int? = null
    var RefundsGrossAmount:BigDecimal? = null
    var RefundsGrossFees:BigDecimal? = null
    var DisputesCount:Int? = null
    var DisputesGrossAmount:BigDecimal? = null
    var DisputesGrossFees:BigDecimal? = null
    var DisputeReversalsCount:Int? = null
    var DisputeReversalsGrossAmount:BigDecimal? = null
    var DisputeReversalsGrossFees:BigDecimal? = null
    var NetActivityAmount:BigDecimal? = null
    var Transfers:ArrayList<Transfer> = ArrayList<Transfer>()
}

open class Transfer
{
    var AccountName:String? = null
    var TransfersCount:Int? = null
    var TransfersGrossAmount:BigDecimal? = null
    var TransfersReversals:BigDecimal? = null
}

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