Trendsic Platform Service

BillingRunStatusRequest

The following routes are available for this service:
GET,OPTIONS	/v1/billing/run/{BillingRunID}

"use strict";
export class BillingRun {
    /** @param {{BillingRunID?:number,TenantId?:string,BranchId?:string,BranchName?:string,RunType?:string,PeriodKey?:string,Status?:string,InvoicesCreated?:number,CreditsApplied?:number,Error?:string,CreatedBy?:string,StartedAt?:string,CompletedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    BillingRunID;
    /** @type {?string} */
    TenantId;
    /** @type {?string} */
    BranchId;
    /** @type {string} */
    BranchName;
    /** @type {string} */
    RunType;
    /** @type {string} */
    PeriodKey;
    /** @type {string} */
    Status;
    /** @type {number} */
    InvoicesCreated;
    /** @type {number} */
    CreditsApplied;
    /** @type {string} */
    Error;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    StartedAt;
    /** @type {?string} */
    CompletedAt;
}
export class BillingRunStatusResponse {
    /** @param {{ResponseStatus?:ResponseStatus,BillingRun?:BillingRun}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {BillingRun} */
    BillingRun;
}
export class BillingRunStatusRequest {
    /** @param {{BillingRunID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    BillingRunID;
}

JavaScript BillingRunStatusRequest 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 /v1/billing/run/{BillingRunID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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
		}
	},
	BillingRun: 
	{
		BillingRunID: 0,
		TenantId: 00000000000000000000000000000000,
		BranchId: 00000000000000000000000000000000,
		BranchName: String,
		RunType: String,
		PeriodKey: String,
		Status: String,
		InvoicesCreated: 0,
		CreditsApplied: 0,
		Error: String,
		CreatedBy: String,
		StartedAt: 0001-01-01,
		CompletedAt: 0001-01-01
	}
}