Registrar Web Services

<back to all web services

R_InvoiceSummary

Requires Authentication
Required role:Admin
The following routes are available for this service:
OPTIONS/R_InvoiceSummary
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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/oneway/R_InvoiceSummary HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/csv
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},"LineItems":[{"Id":0,"Description":"String","InvoiceId":0,"PriceId":0,"Amount":0,"CurrencyTypeId":0,"UnitId":"String"}]}