Trendsic Platform Service

<back to all web services

RunBillingSystemRequest

The following routes are available for this service:
POST/v1/billing/run/system
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class RunBillingSystemRequest
    {
        public virtual string RunType { get; set; }
        public virtual string PeriodKey { get; set; }
        public virtual Guid? TenantId { get; set; }
        public virtual int ReclaimStaleMinutes { get; set; }
    }

    public partial class RunBillingSystemResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int TenantsSwept { get; set; }
        public virtual int RunsStarted { get; set; }
        public virtual int Reclaimed { get; set; }
        public virtual List<RunBillingSystemTenantResult> Results { get; set; } = [];
    }

    public partial class RunBillingSystemTenantResult
    {
        public virtual Guid TenantId { get; set; }
        public virtual int BillingRunID { get; set; }
        public virtual bool Started { get; set; }
        public virtual string Message { get; set; }
    }

}

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

POST /v1/billing/run/system HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RunType: String,
	PeriodKey: String,
	TenantId: 00000000000000000000000000000000,
	ReclaimStaleMinutes: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	TenantsSwept: 0,
	RunsStarted: 0,
	Reclaimed: 0,
	Results: 
	[
		{
			TenantId: 00000000000000000000000000000000,
			BillingRunID: 0,
			Started: False,
			Message: String
		}
	]
}