Cdn API - CPG Source

<back to all web services

ChargeApiUsageBillingRunRequest

Cdn.Api

The following routes are available for this service:
POST/ChargeApiUsageBillingRunRequest
ChargeApiUsageBillingRunRequest Parameters:
NameParameterData TypeRequiredDescription
BillingRunIdbodylongNo
CreditCardIdbodylong?No
ApiUsageBillingRunsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<ApiUsageBillingRunDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
ApiUsageBillingRunDto Parameters:
NameParameterData TypeRequiredDescription
CustomerIdformlongNo
CustomerNameformstringNo
CompanyNameformstringNo
BillingMonthformintNo
BillingYearformintNo
BillingPeriodLabelformstringNo
BasicCallsformintNo
AdvancedCallsformintNo
BasicAmountformdecimalNo
AdvancedAmountformdecimalNo
TotalAmountformdecimalNo
AttemptedOnformDateTime?No
SucceededOnformDateTime?No
FailedOnformDateTime?No
RetryCountformintNo
StatusformstringNo
PaymentIdformlong?No
OrderIdformlong?No
ErrorMessageformstringNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo

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.

POST /ChargeApiUsageBillingRunRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BillingRunId: 0,
	CreditCardId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			CustomerId: 0,
			CustomerName: String,
			CompanyName: String,
			BillingMonth: 0,
			BillingYear: 0,
			BillingPeriodLabel: String,
			BasicCalls: 0,
			AdvancedCalls: 0,
			BasicAmount: 0,
			AdvancedAmount: 0,
			TotalAmount: 0,
			AttemptedOn: 0001-01-01,
			SucceededOn: 0001-01-01,
			FailedOn: 0001-01-01,
			RetryCount: 0,
			Status: String,
			PaymentId: 0,
			OrderId: 0,
			ErrorMessage: String,
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}