Billhighway Cloud API

FinancialActivitySummaryRq

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.Financial.Request
Imports BH.CloudAPI.Common4.DTO.Financial.Response

Namespace Global

    Namespace BH.CloudAPI.Common4.DTO.Financial.Request

        Public Partial Class FinancialActivitySummaryRq
            Public Overridable Property ClientId As Integer
            Public Overridable Property GroupId As String
            Public Overridable Property StartDate As Nullable(Of Date)
            Public Overridable Property EndDate As Nullable(Of Date)
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.Financial.Response

        Public Partial Class ActivitySummary
            Public Sub New()
                Transfers = New List(Of Transfer)
            End Sub

            Public Overridable Property SalesCount As Integer
            Public Overridable Property SalesGrossAmount As Decimal
            Public Overridable Property SalesGrossFees As Decimal
            Public Overridable Property RefundsCount As Integer
            Public Overridable Property RefundsGrossAmount As Decimal
            Public Overridable Property RefundsGrossFees As Decimal
            Public Overridable Property DisputesCount As Integer
            Public Overridable Property DisputesGrossAmount As Decimal
            Public Overridable Property DisputesGrossFees As Decimal
            Public Overridable Property DisputeReversalsCount As Integer
            Public Overridable Property DisputeReversalsGrossAmount As Decimal
            Public Overridable Property DisputeReversalsGrossFees As Decimal
            Public Overridable Property NetActivityAmount As Decimal
            Public Overridable Property Transfers As List(Of Transfer)
        End Class

        Public Partial Class FinancialActivitySummaryRs
            Public Overridable Property GroupId As String
            Public Overridable Property GroupNickName As String
            Public Overridable Property GroupName As String
            Public Overridable Property StartDate As String
            Public Overridable Property EndDate As String
            Public Overridable Property ActivitySummary As ActivitySummary
            Public Overridable Property ErrorCode As Integer
            Public Overridable Property ErrorMessage As String
            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property IsError As Boolean
        End Class

        Public Partial Class Transfer
            Public Overridable Property AccountName As String
            Public Overridable Property TransfersCount As Integer
            Public Overridable Property TransfersGrossAmount As Decimal
            Public Overridable Property TransfersReversals As Decimal
        End Class
    End Namespace
End Namespace

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