Trendsic Platform Service

<back to all web services

BillingRunsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/billing/runs

export class BillingRun
{
    public BillingRunID: number;
    public TenantId?: string;
    public BranchId?: string;
    public BranchName: string;
    public RunType: string;
    public PeriodKey: string;
    public Status: string;
    public InvoicesCreated: number;
    public CreditsApplied: number;
    public Error: string;
    public CreatedBy: string;
    public StartedAt?: string;
    public CompletedAt?: string;

    public constructor(init?: Partial<BillingRun>) { (Object as any).assign(this, init); }
}

export class BillingRunsResponse
{
    public ResponseStatus: ResponseStatus;
    public Runs: BillingRun[] = [];

    public constructor(init?: Partial<BillingRunsResponse>) { (Object as any).assign(this, init); }
}

export class BillingRunsRequest
{
    public Top: number;

    public constructor(init?: Partial<BillingRunsRequest>) { (Object as any).assign(this, init); }
}

TypeScript BillingRunsRequest 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/runs HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BillingRunsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Runs>
    <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>
  </Runs>
</BillingRunsResponse>