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 .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.

GET /v1/billing/run/{BillingRunID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<BillingRunStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BillingRun>
    <BillingRunID>0</BillingRunID>
    <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
    <BranchName>String</BranchName>
    <CompletedAt>0001-01-01T00:00:00</CompletedAt>
    <CreatedBy>String</CreatedBy>
    <CreditsApplied>0</CreditsApplied>
    <Error>String</Error>
    <InvoicesCreated>0</InvoicesCreated>
    <PeriodKey>String</PeriodKey>
    <RunType>String</RunType>
    <StartedAt>0001-01-01T00:00:00</StartedAt>
    <Status>String</Status>
    <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
  </BillingRun>
  <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>
</BillingRunStatusResponse>