Registrar Web Services

<back to all web services

R_ProtectedInvoiceSummaries

Requires Authentication
Required role:User
The following routes are available for this service:
GET, OPTIONS/UserApi/R_InvoiceSummaries
GET, OPTIONS/UserApi/R_InvoiceSummaries/{Ids}
R_ProtectedInvoiceSummaries Parameters:
NameParameterData TypeRequiredDescription
IdspathList<long>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 /xml/reply/R_ProtectedInvoiceSummaries HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_ProtectedInvoiceSummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
</R_ProtectedInvoiceSummaries>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_InvoiceSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
  <R_InvoiceSummary>
    <Id>0</Id>
    <Invoice xmlns:d3p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
      <d3p1:ChargeOnDate>0001-01-01T00:00:00</d3p1:ChargeOnDate>
      <d3p1:ChargedOnDate>0001-01-01T00:00:00</d3p1:ChargedOnDate>
      <d3p1:Cleared>false</d3p1:Cleared>
      <d3p1:CreateDate>0001-01-01T00:00:00</d3p1:CreateDate>
      <d3p1:Description>String</d3p1:Description>
      <d3p1:DunningLevelId>0</d3p1:DunningLevelId>
      <d3p1:Id>0</d3p1:Id>
      <d3p1:InvoiceStatusTypeId>0</d3p1:InvoiceStatusTypeId>
      <d3p1:NotificationDate>0001-01-01T00:00:00</d3p1:NotificationDate>
      <d3p1:PaidDate>0001-01-01T00:00:00</d3p1:PaidDate>
      <d3p1:ServiceEndDate>0001-01-01T00:00:00</d3p1:ServiceEndDate>
      <d3p1:ServiceStartDate>0001-01-01T00:00:00</d3p1:ServiceStartDate>
      <d3p1:SubscriptionId>0</d3p1:SubscriptionId>
    </Invoice>
    <LineItems xmlns:d3p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
      <d3p1:R_InvoiceLineItem>
        <d3p1:Amount>0</d3p1:Amount>
        <d3p1:CurrencyTypeId>0</d3p1:CurrencyTypeId>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:InvoiceId>0</d3p1:InvoiceId>
        <d3p1:PriceId>0</d3p1:PriceId>
        <d3p1:UnitId>String</d3p1:UnitId>
      </d3p1:R_InvoiceLineItem>
    </LineItems>
  </R_InvoiceSummary>
</ArrayOfR_InvoiceSummary>