Trendsic Platform Service

<back to all web services

RunBillingSystemRequest

The following routes are available for this service:
POST/v1/billing/run/system
"use strict";
export class RunBillingSystemTenantResult {
    /** @param {{TenantId?:string,BillingRunID?:number,Started?:boolean,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TenantId;
    /** @type {number} */
    BillingRunID;
    /** @type {boolean} */
    Started;
    /** @type {string} */
    Message;
}
export class RunBillingSystemResponse {
    /** @param {{ResponseStatus?:ResponseStatus,TenantsSwept?:number,RunsStarted?:number,Reclaimed?:number,Results?:RunBillingSystemTenantResult[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    TenantsSwept;
    /** @type {number} */
    RunsStarted;
    /** @type {number} */
    Reclaimed;
    /** @type {RunBillingSystemTenantResult[]} */
    Results = [];
}
export class RunBillingSystemRequest {
    /** @param {{RunType?:string,PeriodKey?:string,TenantId?:string,ReclaimStaleMinutes?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RunType;
    /** @type {string} */
    PeriodKey;
    /** @type {?string} */
    TenantId;
    /** @type {number} */
    ReclaimStaleMinutes;
}

JavaScript RunBillingSystemRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"RunType":"String","PeriodKey":"String","TenantId":"00000000000000000000000000000000","ReclaimStaleMinutes":0}

HTTP/1.1 200 OK
Content-Type: application/json
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"}]}