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

{
	Id: 0,
	Invoice: 
	{
		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
	},
	Customer: 
	{
		Id: 0,
		AccountId: 0,
		CreationDateTime: 0001-01-01,
		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: 0001-01-01,
		TotalNumberOfRecords: 0
	},
	TotalInvoiceAmount: 0,
	PaymentInfo: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Invoice: 
	{
		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
	},
	Customer: 
	{
		Id: 0,
		AccountId: 0,
		CreationDateTime: 0001-01-01,
		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: 0001-01-01,
		TotalNumberOfRecords: 0
	},
	TotalInvoiceAmount: 0,
	PaymentInfo: String
}