Billhighway Cloud API

<back to all web services

FinancialActivitySummaryRq

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

public class FinancialActivitySummaryRq : Codable
{
    public var clientId:Int?
    public var groupId:String?
    public var startDate:Date?
    public var endDate:Date?

    required public init(){}
}

public class FinancialActivitySummaryRs : Codable
{
    public var groupId:String?
    public var groupNickName:String?
    public var groupName:String?
    public var startDate:String?
    public var endDate:String?
    public var activitySummary:ActivitySummary?
    public var errorCode:Int?
    public var errorMessage:String?
    // @ApiMember(ExcludeInSchema=true)
    public var isError:Bool?

    required public init(){}
}

public class ActivitySummary : Codable
{
    public var salesCount:Int?
    public var salesGrossAmount:Double?
    public var salesGrossFees:Double?
    public var refundsCount:Int?
    public var refundsGrossAmount:Double?
    public var refundsGrossFees:Double?
    public var disputesCount:Int?
    public var disputesGrossAmount:Double?
    public var disputesGrossFees:Double?
    public var disputeReversalsCount:Int?
    public var disputeReversalsGrossAmount:Double?
    public var disputeReversalsGrossFees:Double?
    public var netActivityAmount:Double?
    public var transfers:[Transfer] = []

    required public init(){}
}

public class Transfer : Codable
{
    public var accountName:String?
    public var transfersCount:Int?
    public var transfersGrossAmount:Double?
    public var transfersReversals:Double?

    required public init(){}
}

Swift FinancialActivitySummaryRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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