Trendsic Platform Service

<back to all web services

BillingRunsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/billing/runs
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 BillingRunsRequest
    {
        public virtual int Top { get; set; }
    }

    public partial class BillingRunsResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<BillingRun> Runs { get; set; } = [];
    }

}

C# BillingRunsRequest 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.

GET /v1/billing/runs HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
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"}},"Runs":[{"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-01T00:00:00.0000000","CompletedAt":"0001-01-01T00:00:00.0000000"}]}