Trendsic Platform Service

<back to all web services

BillingRunsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/billing/runs
"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 BillingRunsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Runs?:BillingRun[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {BillingRun[]} */
    Runs = [];
}
export class BillingRunsRequest {
    /** @param {{Top?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Top;
}

JavaScript BillingRunsRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/billing/runs HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Runs":[{"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-01T00:00:00.0000000","CompletedAt":"0001-01-01T00:00:00.0000000"}]}