Cdn API - CPG Source

<back to all web services

ApiUserInvoiceRequest

Cdn.Api

The following routes are available for this service:
GET/ApiUserInvoiceRequest
ApiUserInvoiceRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerIdquerylongNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
ApiUserInvoiceResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<ApiUserInvoiceItem>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
ApiUserInvoiceItem Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
CustomerIdformlongNo
RowTypeformstringNo
BillingMonthformintNo
BillingYearformintNo
BillingPeriodLabelformstringNo
BasicCallsformintNo
AdvancedCallsformintNo
BasicAmountformdecimalNo
AdvancedAmountformdecimalNo
TotalAmountformdecimalNo
StatusformstringNo
SucceededOnformDateTime?No
PaymentIdformlong?No
OrderIdformlong?No
ApiUserInvoiceResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<ApiUserInvoiceItem>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 /ApiUserInvoiceRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiUserInvoiceResponse 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>
    <ApiUserInvoiceItem>
      <AdvancedAmount>0</AdvancedAmount>
      <AdvancedCalls>0</AdvancedCalls>
      <BasicAmount>0</BasicAmount>
      <BasicCalls>0</BasicCalls>
      <BillingMonth>0</BillingMonth>
      <BillingPeriodLabel>String</BillingPeriodLabel>
      <BillingYear>0</BillingYear>
      <CustomerId>0</CustomerId>
      <Id>0</Id>
      <OrderId>0</OrderId>
      <PaymentId>0</PaymentId>
      <RowType>String</RowType>
      <Status>String</Status>
      <SucceededOn>0001-01-01T00:00:00</SucceededOn>
      <TotalAmount>0</TotalAmount>
    </ApiUserInvoiceItem>
  </Data>
</ApiUserInvoiceResponse>