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 .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/oneway/R_InvoiceSummary 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
	},
	LineItems: 
	[
		{
			Id: 0,
			Description: String,
			InvoiceId: 0,
			PriceId: 0,
			Amount: 0,
			CurrencyTypeId: 0,
			UnitId: String
		}
	]
}