Registrar Web Services

<back to all web services

R_Invoices

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

{
	SubscriptionIds: 
	[
		0
	],
	InvoiceIds: 
	[
		0
	],
	AccountHolderIds: 
	[
		0
	],
	Ids: 
	[
		0
	],
	StartChargeOnDateTicks: 0,
	EndChargeOnDateTicks: 0,
	StartPaidOnDateTicks: 0,
	EndPaidOnDateTicks: 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
	}
]