Cdn API - CPG Source

<back to all web services

ChargeApiUsageBillingRunRequest

Cdn.Api

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 .soap12 suffix or ?format=soap12

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: cdnapidev.greysheet.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<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>

    </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<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>

    </soap12:Body>
</soap12:Envelope>