Registrar Web Services

<back to all web services

R_InvoiceReportInfo

Requires Authentication
Requires any of the roles:Admin, User
R_InvoiceReportInfo Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
InvoicequeryR_InvoiceNo
CustomerqueryR_AccountHolderNo
TotalInvoiceAmountquerydecimalNo
PaymentInfoquerystringNo
R_Invoice Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
SubscriptionIdformlongNo
InvoiceStatusTypeIdformlongNo
CreateDateformDateTimeNo
ChargeOnDateformDateTimeNo
NotificationDateformDateTime?No
PaidDateformDateTime?No
ChargedOnDateformDateTime?No
ServiceStartDateformDateTimeNo
ServiceEndDateformDateTimeNo
ClearedformboolNo
DunningLevelIdformlongNo
IdformlongNo
R_AccountHolder Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
CreationDateTimeformDateTime?No
EmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateProvinceformstringNo
ZipCodeformstringNo
CountryformstringNo
CreditCardNumberformstringNo
CardCodeformstringNo
ExpirationMonthformint?No
ExpirationYearformint?No
NeedToUpdatePaymentInfoformboolNo
UpdatePaymentInfoDateformDateTime?No
TotalNumberOfRecordsformlongNo
R_InvoiceReportInfo Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
InvoicequeryR_InvoiceNo
CustomerqueryR_AccountHolderNo
TotalInvoiceAmountquerydecimalNo
PaymentInfoquerystringNo

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_InvoiceReportInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:CardCode>String</d2p1:CardCode>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:CreationDateTime>0001-01-01T00:00:00</d2p1:CreationDateTime>
    <d2p1:CreditCardNumber>String</d2p1:CreditCardNumber>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:ExpirationMonth>0</d2p1:ExpirationMonth>
    <d2p1:ExpirationYear>0</d2p1:ExpirationYear>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:NeedToUpdatePaymentInfo>false</d2p1:NeedToUpdatePaymentInfo>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:StateProvince>String</d2p1:StateProvince>
    <d2p1:TotalNumberOfRecords>0</d2p1:TotalNumberOfRecords>
    <d2p1:UpdatePaymentInfoDate>0001-01-01T00:00:00</d2p1:UpdatePaymentInfoDate>
    <d2p1:ZipCode>String</d2p1:ZipCode>
  </Customer>
  <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>
  <PaymentInfo>String</PaymentInfo>
  <TotalInvoiceAmount>0</TotalInvoiceAmount>
</R_InvoiceReportInfo>

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

<R_InvoiceReportInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:CardCode>String</d2p1:CardCode>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:CreationDateTime>0001-01-01T00:00:00</d2p1:CreationDateTime>
    <d2p1:CreditCardNumber>String</d2p1:CreditCardNumber>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:ExpirationMonth>0</d2p1:ExpirationMonth>
    <d2p1:ExpirationYear>0</d2p1:ExpirationYear>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:NeedToUpdatePaymentInfo>false</d2p1:NeedToUpdatePaymentInfo>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:StateProvince>String</d2p1:StateProvince>
    <d2p1:TotalNumberOfRecords>0</d2p1:TotalNumberOfRecords>
    <d2p1:UpdatePaymentInfoDate>0001-01-01T00:00:00</d2p1:UpdatePaymentInfoDate>
    <d2p1:ZipCode>String</d2p1:ZipCode>
  </Customer>
  <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>
  <PaymentInfo>String</PaymentInfo>
  <TotalInvoiceAmount>0</TotalInvoiceAmount>
</R_InvoiceReportInfo>

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