Cdn API - CPG Source

ChargeApiUsageBillingRunRequest

Cdn.Api

The following routes are available for this service:
POST	/ChargeApiUsageBillingRunRequest

**ChargeApiUsageBillingRunRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BillingRunId	body	long	No
CreditCardId	body	long?	No

**ApiUsageBillingRunsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<ApiUsageBillingRunDto>	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

**ApiUsageBillingRunDto** Parameters:
Name	Parameter	Data Type	Required
CustomerId	form	long	No
CustomerName	form	string	No
CompanyName	form	string	No
BillingMonth	form	int	No
BillingYear	form	int	No
BillingPeriodLabel	form	string	No
BasicCalls	form	int	No
AdvancedCalls	form	int	No
BasicAmount	form	decimal	No
AdvancedAmount	form	decimal	No
TotalAmount	form	decimal	No
AttemptedOn	form	DateTime?	No
SucceededOn	form	DateTime?	No
FailedOn	form	DateTime?	No
RetryCount	form	int	No
Status	form	string	No
PaymentId	form	long?	No
OrderId	form	long?	No
ErrorMessage	form	string	No

**DtoBase** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Active	form	bool	No
LastMod	form	DateTime	No
LastModBy	form	string	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.

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

<ChargeApiUsageBillingRunRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <BillingRunId>0</BillingRunId>
  <CreditCardId>0</CreditCardId>
</ChargeApiUsageBillingRunRequest>

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

<ApiUsageBillingRunsResponse 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>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:ApiUsageBillingRunDto>
      <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
      <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
      <d2p1:AdvancedAmount>0</d2p1:AdvancedAmount>
      <d2p1:AdvancedCalls>0</d2p1:AdvancedCalls>
      <d2p1:AttemptedOn>0001-01-01T00:00:00</d2p1:AttemptedOn>
      <d2p1:BasicAmount>0</d2p1:BasicAmount>
      <d2p1:BasicCalls>0</d2p1:BasicCalls>
      <d2p1:BillingMonth>0</d2p1:BillingMonth>
      <d2p1:BillingPeriodLabel>String</d2p1:BillingPeriodLabel>
      <d2p1:BillingYear>0</d2p1:BillingYear>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:CustomerId>0</d2p1:CustomerId>
      <d2p1:CustomerName>String</d2p1:CustomerName>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
      <d2p1:FailedOn>0001-01-01T00:00:00</d2p1:FailedOn>
      <d2p1:OrderId>0</d2p1:OrderId>
      <d2p1:PaymentId>0</d2p1:PaymentId>
      <d2p1:RetryCount>0</d2p1:RetryCount>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:SucceededOn>0001-01-01T00:00:00</d2p1:SucceededOn>
      <d2p1:TotalAmount>0</d2p1:TotalAmount>
    </d2p1:ApiUsageBillingRunDto>
  </Data>
</ApiUsageBillingRunsResponse>