HostedSuite

ListAllChargesRequest

Get all client charges including scheduling

The following routes are available for this service:
All Verbs	/api/charges/all

**ListAllChargesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ClientId	query	string	No	The ID of the client you want charges for
StartDate	query	string	Yes	The start of the date range for charges.
EndDate	query	string	Yes	The end of the date range for charges.
DateSelector	query	ChargeDateSelectors	No	Specify which date field to query based on ('DateOfCharge', 'DateLastModified', 'DateCreated').
IncludeSchedulingCharges	query	bool	No	Include scheduling charges
IncludeManualCharges	query	bool	No	Include one-off charges

**RequestBase<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerName	form	string	Yes	The HostedSuite Customer Name
UserName	form	string	Yes	The HostedSuite User Name. Data visibility and security is based on this user's permissions.
Password	form	string	Yes	The HostedSuite User's Password

**ChargeDateSelectors** Enum:
DateOfCharge
DateCreated
DateLastModified

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 /api/charges/all HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientId: String,
	StartDate: String,
	EndDate: String,
	DateSelector: DateOfCharge,
	IncludeSchedulingCharges: False,
	IncludeManualCharges: False,
	CustomerName: String,
	UserName: String,
	Password: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		EntityStatus: String,
		Id: String,
		ClientId: String,
		ClientName: String,
		DateCreated: String,
		DateOfCharge: String,
		DateLastModified: String,
		Service: String,
		ServiceId: String,
		Quantity: 0,
		Cost: 0,
		Description: String,
		Notes: String,
		Memorized: False,
		BillingCode: String
	}
]