Registrar Web Services

<back to all web services

R_InvoiceReportInfo

Requires Authentication
Requires any of the roles:Admin, User
The following routes are available for this service:
OPTIONS/R_InvoiceReportInfo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/R_InvoiceReportInfo HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/json
Content-Length: length

{"Id":0,"Invoice":{"Description":"String","SubscriptionId":0,"InvoiceStatusTypeId":0,"CreateDate":"\/Date(-62135596800000-0000)\/","ChargeOnDate":"\/Date(-62135596800000-0000)\/","NotificationDate":"\/Date(-62135596800000-0000)\/","PaidDate":"\/Date(-62135596800000-0000)\/","ChargedOnDate":"\/Date(-62135596800000-0000)\/","ServiceStartDate":"\/Date(-62135596800000-0000)\/","ServiceEndDate":"\/Date(-62135596800000-0000)\/","Cleared":false,"DunningLevelId":0,"Id":0},"Customer":{"Id":0,"AccountId":0,"CreationDateTime":"\/Date(-62135596800000-0000)\/","Email":"String","PhoneNumber":"String","FirstName":"String","LastName":"String","Address1":"String","Address2":"String","City":"String","StateProvince":"String","ZipCode":"String","Country":"String","CreditCardNumber":"String","CardCode":"String","ExpirationMonth":0,"ExpirationYear":0,"NeedToUpdatePaymentInfo":false,"UpdatePaymentInfoDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0},"TotalInvoiceAmount":0,"PaymentInfo":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"Invoice":{"Description":"String","SubscriptionId":0,"InvoiceStatusTypeId":0,"CreateDate":"\/Date(-62135596800000-0000)\/","ChargeOnDate":"\/Date(-62135596800000-0000)\/","NotificationDate":"\/Date(-62135596800000-0000)\/","PaidDate":"\/Date(-62135596800000-0000)\/","ChargedOnDate":"\/Date(-62135596800000-0000)\/","ServiceStartDate":"\/Date(-62135596800000-0000)\/","ServiceEndDate":"\/Date(-62135596800000-0000)\/","Cleared":false,"DunningLevelId":0,"Id":0},"Customer":{"Id":0,"AccountId":0,"CreationDateTime":"\/Date(-62135596800000-0000)\/","Email":"String","PhoneNumber":"String","FirstName":"String","LastName":"String","Address1":"String","Address2":"String","City":"String","StateProvince":"String","ZipCode":"String","Country":"String","CreditCardNumber":"String","CardCode":"String","ExpirationMonth":0,"ExpirationYear":0,"NeedToUpdatePaymentInfo":false,"UpdatePaymentInfoDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0},"TotalInvoiceAmount":0,"PaymentInfo":"String"}