Registrar Web Services

<back to all web services

R_InvoiceSummary

Requires Authentication
Required role:Admin
R_InvoiceSummary Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
InvoicequeryR_InvoiceNo
LineItemsqueryList<R_InvoiceLineItem>No
R_Invoice Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
SubscriptionIdformlongNo
InvoiceStatusTypeIdformlongNo
CreateDateformDateTimeNo
ChargeOnDateformDateTimeNo
NotificationDateformDateTime?No
PaidDateformDateTime?No
ChargedOnDateformDateTime?No
ServiceStartDateformDateTimeNo
ServiceEndDateformDateTimeNo
ClearedformboolNo
DunningLevelIdformlongNo
IdformlongNo
R_InvoiceLineItem Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DescriptionformstringNo
InvoiceIdformlongNo
PriceIdformlongNo
AmountformdecimalNo
CurrencyTypeIdformlongNo
UnitIdformstringNo

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: regapi.pumpalarm.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>

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

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