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