Registrar Web Services

<back to all web services

R_Invoices

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Invoices
GET,OPTIONS/R_Invoices/{Ids}
GET,OPTIONS/R_Invoices/SubscriptionIds/{SubscriptionIds}
GET,OPTIONS/R_Invoices/InvoiceIds/{InvoiceIds}
GET, OPTIONS/R_Invoices/StartDate/{StartChargeOnDateTicks}/EndDate/{EndChargeOnDateTicks}
GET, OPTIONS/R_Invoices/PaidDate/Start/{StartPaidOnDateTicks}/End/{EndPaidOnDateTicks}
R_Invoices Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdspathList<long>No
InvoiceIdspathList<long>No
AccountHolderIdsqueryList<long>No
IdspathList<long>No
StartChargeOnDateTickspathlong?No
EndChargeOnDateTickspathlong?No
StartPaidOnDateTickspathlong?No
EndPaidOnDateTickspathlong?No

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/reply/R_Invoices HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/csv
Content-Length: length

{"SubscriptionIds":[0],"InvoiceIds":[0],"AccountHolderIds":[0],"Ids":[0],"StartChargeOnDateTicks":0,"EndChargeOnDateTicks":0,"StartPaidOnDateTicks":0,"EndPaidOnDateTicks":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"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}]