HostedSuite

<back to all web services

NewChargeRequest

Create a new charge

The following routes are available for this service:
POST/api/charges/new
NewChargeRequest Parameters:
NameParameterData TypeRequiredDescription
ClientIdbodystringYesThe ID of the client you want to create the charge for
ServiceIdbodystringYesThe ID of the service you want to associate with the charge
DateOfChargebodystringYesThe date of the charge
NotesbodystringNoAny notes for the charge
QuantitybodydoubleNoThe quantity for the charge
Costbodydouble?NoSpecify the cost for the charge (leave null to have it calculated)
Memorizedbodybool?NoSet to true to make memorized (monthly)
RequestBase<TResponse> Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringYesThe HostedSuite Customer Name
UserNameformstringYesThe HostedSuite User Name. Data visibility and security is based on this user's permissions.
PasswordformstringYesThe HostedSuite User's Password
ChargeInfo Parameters:
NameParameterData TypeRequiredDescription
EntityStatusformstringNo
IdformstringNo
ClientIdformstringNo
ClientNameformstringNo
DateCreatedformstringNo
DateOfChargeformstringNo
DateLastModifiedformstringNo
ServiceformstringNo
ServiceIdformstringNo
QuantityformdoubleNo
Costformdouble?No
DescriptionformstringNo
NotesformstringNo
MemorizedformboolNo
BillingCodeformstringNo
ChargeInfo Parameters:
NameParameterData TypeRequiredDescription
EntityStatusformstringNo
IdformstringNo
ClientIdformstringNo
ClientNameformstringNo
DateCreatedformstringNo
DateOfChargeformstringNo
DateLastModifiedformstringNo
ServiceformstringNo
ServiceIdformstringNo
QuantityformdoubleNo
Costformdouble?No
DescriptionformstringNo
NotesformstringNo
MemorizedformboolNo
BillingCodeformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/charges/new HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ClientId":"String","ServiceId":"String","DateOfCharge":"String","Notes":"String","Quantity":0,"Cost":0,"Memorized":false,"CustomerName":"String","UserName":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}