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.*


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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}