Billhighway Cloud API

<back to all web services

FinancialActivitySummaryRq

The following routes are available for this service:
GET/financial/reporting/activitysummary
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.Financial.Request;
using BH.CloudAPI.Common4.DTO.Financial.Response;

namespace BH.CloudAPI.Common4.DTO.Financial.Request
{
    public partial class FinancialActivitySummaryRq
    {
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual DateTime? StartDate { get; set; }
        public virtual DateTime? EndDate { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Financial.Response
{
    public partial class ActivitySummary
    {
        public ActivitySummary()
        {
            Transfers = new List<Transfer>{};
        }

        public virtual int SalesCount { get; set; }
        public virtual decimal SalesGrossAmount { get; set; }
        public virtual decimal SalesGrossFees { get; set; }
        public virtual int RefundsCount { get; set; }
        public virtual decimal RefundsGrossAmount { get; set; }
        public virtual decimal RefundsGrossFees { get; set; }
        public virtual int DisputesCount { get; set; }
        public virtual decimal DisputesGrossAmount { get; set; }
        public virtual decimal DisputesGrossFees { get; set; }
        public virtual int DisputeReversalsCount { get; set; }
        public virtual decimal DisputeReversalsGrossAmount { get; set; }
        public virtual decimal DisputeReversalsGrossFees { get; set; }
        public virtual decimal NetActivityAmount { get; set; }
        public virtual List<Transfer> Transfers { get; set; }
    }

    public partial class FinancialActivitySummaryRs
    {
        public virtual string GroupId { get; set; }
        public virtual string GroupNickName { get; set; }
        public virtual string GroupName { get; set; }
        public virtual string StartDate { get; set; }
        public virtual string EndDate { get; set; }
        public virtual ActivitySummary ActivitySummary { get; set; }
        public virtual int ErrorCode { get; set; }
        public virtual string ErrorMessage { get; set; }
        [ApiMember(ExcludeInSchema=true)]
        public virtual bool IsError { get; set; }
    }

    public partial class Transfer
    {
        public virtual string AccountName { get; set; }
        public virtual int TransfersCount { get; set; }
        public virtual decimal TransfersGrossAmount { get; set; }
        public virtual decimal TransfersReversals { get; set; }
    }

}

C# 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>