Registrar Web Services

<back to all web services

R_Invoice

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST,OPTIONS/R_Invoices
PUT,OPTIONS/R_Invoices/{Id}
DELETE,OPTIONS/R_Invoices/{Id}
R_Invoice Parameters:
NameParameterData TypeRequiredDescription
DescriptionbodystringNo
SubscriptionIdbodylongNo
InvoiceStatusTypeIdbodylongNo
CreateDatebodyDateTimeNo
ChargeOnDatebodyDateTimeNo
NotificationDatebodyDateTime?No
PaidDatebodyDateTime?No
ChargedOnDatebodyDateTime?No
ServiceStartDatebodyDateTimeNo
ServiceEndDatebodyDateTimeNo
ClearedbodyboolNo
DunningLevelIdbodylongNo
IdpathlongNo
R_Invoice Parameters:
NameParameterData TypeRequiredDescription
DescriptionbodystringNo
SubscriptionIdbodylongNo
InvoiceStatusTypeIdbodylongNo
CreateDatebodyDateTimeNo
ChargeOnDatebodyDateTimeNo
NotificationDatebodyDateTime?No
PaidDatebodyDateTime?No
ChargedOnDatebodyDateTime?No
ServiceStartDatebodyDateTimeNo
ServiceEndDatebodyDateTimeNo
ClearedbodyboolNo
DunningLevelIdbodylongNo
IdpathlongNo

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_Invoice HTTP/1.1 
Host: regapi.pumpalarm.com 
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}
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}