Billhighway Cloud API

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