Cdn API - CPG Source

ApiBillingPreviewRequest

Cdn.Api

The following routes are available for this service:
GET	/ApiBillingPreviewRequest

**ApiBillingPreviewRequest** Parameters:
Name	Parameter	Data Type	Required
BillingMonth	query	int	No
BillingYear	query	int	No
IncludeAlreadyBilled	query	bool	No

**BaseRequest<T>** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
OrderBy	form	string[]	No
OrderDirections	form	SortOrders[]	No

**ApiBillingPreviewResponse** Parameters:
Name	Parameter	Data Type	Required
BillingMonth	form	int	No
BillingYear	form	int	No
BillingPeriodLabel	form	string	No
PeriodStart	form	DateTime	No
PeriodEnd	form	DateTime	No
EligibleCustomerCount	form	int	No
ChargeableCount	form	int	No
TotalAmount	form	decimal	No
MissingPaymentInfoCount	form	int	No
TotalAtRiskAmount	form	decimal	No
AlreadyBilledCount	form	int	No
AlreadySkippedCount	form	int	No
RetryCount	form	int	No
MinimumAppliedCount	form	int	No
TotalBasicCalls	form	int	No
TotalAdvancedCalls	form	int	No
NoChargeCustomerCount	form	int	No
Data	form	List<ApiBillingPreviewItem>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**ApiBillingPreviewItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
LastName	form	string	No
FirstName	form	string	No
Company	form	string	No
BasicCalls	form	int	No
AdvancedCalls	form	int	No
TotalCalls	form	int	No
BasicAmount	form	decimal	No
AdvancedAmount	form	decimal	No
CalculatedAmount	form	decimal	No
TotalAmount	form	decimal	No
MinimumApplied	form	bool	No
Status	form	string	No
FailReason	form	string	No
IsRetry	form	bool	No
ApiBillingFailed	form	bool	No

**ApiBillingPreviewResponse** Parameters:
Name	Parameter	Data Type	Required
BillingMonth	form	int	No
BillingYear	form	int	No
BillingPeriodLabel	form	string	No
PeriodStart	form	DateTime	No
PeriodEnd	form	DateTime	No
EligibleCustomerCount	form	int	No
ChargeableCount	form	int	No
TotalAmount	form	decimal	No
MissingPaymentInfoCount	form	int	No
TotalAtRiskAmount	form	decimal	No
AlreadyBilledCount	form	int	No
AlreadySkippedCount	form	int	No
RetryCount	form	int	No
MinimumAppliedCount	form	int	No
TotalBasicCalls	form	int	No
TotalAdvancedCalls	form	int	No
NoChargeCustomerCount	form	int	No
Data	form	List<ApiBillingPreviewItem>	No

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /ApiBillingPreviewRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiBillingPreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <AlreadyBilledCount>0</AlreadyBilledCount>
  <AlreadySkippedCount>0</AlreadySkippedCount>
  <BillingMonth>0</BillingMonth>
  <BillingPeriodLabel>String</BillingPeriodLabel>
  <BillingYear>0</BillingYear>
  <ChargeableCount>0</ChargeableCount>
  <Data>
    <ApiBillingPreviewItem>
      <AdvancedAmount>0</AdvancedAmount>
      <AdvancedCalls>0</AdvancedCalls>
      <ApiBillingFailed>false</ApiBillingFailed>
      <BasicAmount>0</BasicAmount>
      <BasicCalls>0</BasicCalls>
      <CalculatedAmount>0</CalculatedAmount>
      <Company>String</Company>
      <FailReason>String</FailReason>
      <FirstName>String</FirstName>
      <Id>0</Id>
      <IsRetry>false</IsRetry>
      <LastName>String</LastName>
      <MinimumApplied>false</MinimumApplied>
      <Status>String</Status>
      <TotalAmount>0</TotalAmount>
    </ApiBillingPreviewItem>
  </Data>
  <EligibleCustomerCount>0</EligibleCustomerCount>
  <MinimumAppliedCount>0</MinimumAppliedCount>
  <MissingPaymentInfoCount>0</MissingPaymentInfoCount>
  <NoChargeCustomerCount>0</NoChargeCustomerCount>
  <PeriodEnd>0001-01-01T00:00:00</PeriodEnd>
  <PeriodStart>0001-01-01T00:00:00</PeriodStart>
  <RetryCount>0</RetryCount>
  <TotalAdvancedCalls>0</TotalAdvancedCalls>
  <TotalAmount>0</TotalAmount>
  <TotalAtRiskAmount>0</TotalAtRiskAmount>
  <TotalBasicCalls>0</TotalBasicCalls>
</ApiBillingPreviewResponse>