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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class BillingRun
    {
        public virtual int BillingRunID { get; set; }
        public virtual Guid? TenantId { get; set; }
        public virtual Guid? BranchId { get; set; }
        public virtual string BranchName { get; set; }
        public virtual string RunType { get; set; }
        public virtual string PeriodKey { get; set; }
        public virtual string Status { get; set; }
        public virtual int InvoicesCreated { get; set; }
        public virtual int CreditsApplied { get; set; }
        public virtual string Error { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual DateTime? StartedAt { get; set; }
        public virtual DateTime? CompletedAt { get; set; }
    }

    public partial class BillingRunStatusRequest
    {
        public virtual int BillingRunID { get; set; }
    }

    public partial class BillingRunStatusResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual BillingRun BillingRun { get; set; }
    }

}

C# 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
	}
}