Trendsic Platform Service

<back to all web services

RunBillingSystemRequest

The following routes are available for this service:
POST/v1/billing/run/system

export class RunBillingSystemTenantResult
{
    public TenantId: string;
    public BillingRunID: number;
    public Started: boolean;
    public Message: string;

    public constructor(init?: Partial<RunBillingSystemTenantResult>) { (Object as any).assign(this, init); }
}

export class RunBillingSystemResponse
{
    public ResponseStatus: ResponseStatus;
    public TenantsSwept: number;
    public RunsStarted: number;
    public Reclaimed: number;
    public Results: RunBillingSystemTenantResult[] = [];

    public constructor(init?: Partial<RunBillingSystemResponse>) { (Object as any).assign(this, init); }
}

export class RunBillingSystemRequest
{
    public RunType: string;
    public PeriodKey: string;
    public TenantId?: string;
    public ReclaimStaleMinutes: number;

    public constructor(init?: Partial<RunBillingSystemRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	]
}