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 .jsv suffix or ?format=jsv

HTTP + JSV

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