Trendsic Platform Service

<back to all web services

RunBillingSystemRequest

The following routes are available for this service:
POST/v1/billing/run/system
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RunBillingSystemTenantResult() = 
        member val TenantId:Guid = new Guid() with get,set
        member val BillingRunID:Int32 = new Int32() with get,set
        member val Started:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type RunBillingSystemResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val TenantsSwept:Int32 = new Int32() with get,set
        member val RunsStarted:Int32 = new Int32() with get,set
        member val Reclaimed:Int32 = new Int32() with get,set
        member val Results:ResizeArray<RunBillingSystemTenantResult> = new ResizeArray<RunBillingSystemTenantResult>() with get,set

    [<AllowNullLiteral>]
    type RunBillingSystemRequest() = 
        member val RunType:String = null with get,set
        member val PeriodKey:String = null with get,set
        member val TenantId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val ReclaimStaleMinutes:Int32 = new Int32() with get,set

F# RunBillingSystemRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"RunType":"String","PeriodKey":"String","TenantId":"00000000000000000000000000000000","ReclaimStaleMinutes":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}