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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/R_Invoice HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	Description: String,
	SubscriptionId: 0,
	InvoiceStatusTypeId: 0,
	CreateDate: 0001-01-01,
	ChargeOnDate: 0001-01-01,
	NotificationDate: 0001-01-01,
	PaidDate: 0001-01-01,
	ChargedOnDate: 0001-01-01,
	ServiceStartDate: 0001-01-01,
	ServiceEndDate: 0001-01-01,
	Cleared: False,
	DunningLevelId: 0,
	Id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Description: String,
	SubscriptionId: 0,
	InvoiceStatusTypeId: 0,
	CreateDate: 0001-01-01,
	ChargeOnDate: 0001-01-01,
	NotificationDate: 0001-01-01,
	PaidDate: 0001-01-01,
	ChargedOnDate: 0001-01-01,
	ServiceStartDate: 0001-01-01,
	ServiceEndDate: 0001-01-01,
	Cleared: False,
	DunningLevelId: 0,
	Id: 0
}