POST | /api/charges |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientId | body | string | No | The ID of the client you want charges for |
StartDate | body | string | Yes | The start of the date range for charges. |
EndDate | body | string | Yes | The end of the date range for charges. |
DateSelector | body | ChargeDateSelectors | No | Specify which date field to query based on ('DateOfCharge', 'DateLastModified', 'DateCreated'). |
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 |
DateOfCharge |
DateCreated |
DateLastModified |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/charges HTTP/1.1
Host: cpo.hostedsuite.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ClientId":"String","StartDate":"String","EndDate":"String","DateSelector":"DateOfCharge","CustomerName":"String","UserName":"String","Password":"String"}
HTTP/1.1 200 OK Content-Type: application/json 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"}]