Billhighway Cloud API

<back to all web services

FinancialActivitySummaryRq

The following routes are available for this service:
GET/financial/reporting/activitysummary
namespace BH.CloudAPI.Common4.DTO.Financial.Request

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Transfer() = 
        member val AccountName:String = null with get,set
        member val TransfersCount:Int32 = new Int32() with get,set
        member val TransfersGrossAmount:Decimal = new Decimal() with get,set
        member val TransfersReversals:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type ActivitySummary() = 
        member val SalesCount:Int32 = new Int32() with get,set
        member val SalesGrossAmount:Decimal = new Decimal() with get,set
        member val SalesGrossFees:Decimal = new Decimal() with get,set
        member val RefundsCount:Int32 = new Int32() with get,set
        member val RefundsGrossAmount:Decimal = new Decimal() with get,set
        member val RefundsGrossFees:Decimal = new Decimal() with get,set
        member val DisputesCount:Int32 = new Int32() with get,set
        member val DisputesGrossAmount:Decimal = new Decimal() with get,set
        member val DisputesGrossFees:Decimal = new Decimal() with get,set
        member val DisputeReversalsCount:Int32 = new Int32() with get,set
        member val DisputeReversalsGrossAmount:Decimal = new Decimal() with get,set
        member val DisputeReversalsGrossFees:Decimal = new Decimal() with get,set
        member val NetActivityAmount:Decimal = new Decimal() with get,set
        member val Transfers:ResizeArray<Transfer> = new ResizeArray<Transfer>() with get,set

    [<AllowNullLiteral>]
    type FinancialActivitySummaryRs() = 
        member val GroupId:String = null with get,set
        member val GroupNickName:String = null with get,set
        member val GroupName:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set
        member val ActivitySummary:ActivitySummary = null with get,set
        member val ErrorCode:Int32 = new Int32() with get,set
        member val ErrorMessage:String = null with get,set
        [<ApiMember(ExcludeInSchema=true)>]
        member val IsError:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type FinancialActivitySummaryRq() = 
        member val ClientId:Int32 = new Int32() with get,set
        member val GroupId:String = null with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# 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
}