Billhighway Cloud API

FinancialActivitySummaryRq

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

**FinancialActivitySummaryRq** Parameters:
Name	Parameter	Data Type	Required
ClientId	query	int	No
GroupId	query	string	No
StartDate	query	DateTime?	No
EndDate	query	DateTime?	No

**FinancialActivitySummaryRs** Parameters:
Name	Parameter	Data Type	Required
GroupId	form	string	No
GroupNickName	form	string	No
GroupName	form	string	No
StartDate	form	string	No
EndDate	form	string	No
ActivitySummary	form	ActivitySummary	No
ErrorCode	form	int	No
ErrorMessage	form	string	No
IsError	form	bool	No

**ActivitySummary** Parameters:
Name	Parameter	Data Type	Required
SalesCount	form	int	No
SalesGrossAmount	form	decimal	No
SalesGrossFees	form	decimal	No
RefundsCount	form	int	No
RefundsGrossAmount	form	decimal	No
RefundsGrossFees	form	decimal	No
DisputesCount	form	int	No
DisputesGrossAmount	form	decimal	No
DisputesGrossFees	form	decimal	No
DisputeReversalsCount	form	int	No
DisputeReversalsGrossAmount	form	decimal	No
DisputeReversalsGrossFees	form	decimal	No
NetActivityAmount	form	decimal	No
Transfers	form	List<Transfer>	No

**Transfer** Parameters:
Name	Parameter	Data Type	Required
AccountName	form	string	No
TransfersCount	form	int	No
TransfersGrossAmount	form	decimal	No
TransfersReversals	form	decimal	No

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
}