Trendsic Platform Service

<back to all web services

BillingRunsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/billing/runs
BillingRunsRequest Parameters:
NameParameterData TypeRequiredDescription
TopqueryintNo
BillingRunsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RunsformList<BillingRun>No
BillingRun Parameters:
NameParameterData TypeRequiredDescription
BillingRunIDformintNo
TenantIdformGuid?No
BranchIdformGuid?No
BranchNameformstringNo
RunTypeformstringNo
PeriodKeyformstringNo
StatusformstringNo
InvoicesCreatedformintNo
CreditsAppliedformintNo
ErrorformstringNo
CreatedByformstringNo
StartedAtformDateTime?No
CompletedAtformDateTime?No

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"}]}