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 .xml suffix or ?format=xml

HTTP + XML

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

<RunBillingSystemRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <PeriodKey>String</PeriodKey>
  <ReclaimStaleMinutes>0</ReclaimStaleMinutes>
  <RunType>String</RunType>
  <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
</RunBillingSystemRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RunBillingSystemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Reclaimed>0</Reclaimed>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Results>
    <RunBillingSystemTenantResult>
      <BillingRunID>0</BillingRunID>
      <Message>String</Message>
      <Started>false</Started>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
    </RunBillingSystemTenantResult>
  </Results>
  <RunsStarted>0</RunsStarted>
  <TenantsSwept>0</TenantsSwept>
</RunBillingSystemResponse>