Trendsic Platform Service

<back to all web services

BillingRunStatusRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/billing/run/{BillingRunID}

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 BillingRunStatusResponse
{
    public ResponseStatus: ResponseStatus;
    public BillingRun: BillingRun;

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

export class BillingRunStatusRequest
{
    public BillingRunID: number;

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

TypeScript BillingRunStatusRequest DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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