Registrar Web Services

<back to all web services

R_InvoiceSummaries

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET, OPTIONS/R_InvoiceSummaries
GET, OPTIONS/R_InvoiceSummaries/{Ids}
GET, OPTIONS/R_InvoiceSummaries/StartDate/{StartChargeOnDateTicks}/EndDate/{EndChargeOnDateTicks}
GET, OPTIONS/R_InvoiceSummaries/PaidDate/Start/{StartPaidOnDateTicks}/End/{EndPaidOnDateTicks}
R_InvoiceSummaries Parameters:
NameParameterData TypeRequiredDescription
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 .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_InvoiceSummaries HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	Ids: 
	[
		0
	],
	StartChargeOnDateTicks: 0,
	EndChargeOnDateTicks: 0,
	StartPaidOnDateTicks: 0,
	EndPaidOnDateTicks: 0
}

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