HostedSuite

<back to all web services

ListAllChargesRequest

Get all client charges including scheduling

The following routes are available for this service:
All Verbs/api/charges/all
ListAllChargesRequest Parameters:
NameParameterData TypeRequiredDescription
ClientIdquerystringNoThe ID of the client you want charges for
StartDatequerystringYesThe start of the date range for charges.
EndDatequerystringYesThe end of the date range for charges.
DateSelectorqueryChargeDateSelectorsNoSpecify which date field to query based on ('DateOfCharge', 'DateLastModified', 'DateCreated').
IncludeSchedulingChargesqueryboolNoInclude scheduling charges
IncludeManualChargesqueryboolNoInclude one-off charges
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
ChargeDateSelectors Enum:
DateOfCharge
DateCreated
DateLastModified

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ListAllChargesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <CustomerName>String</CustomerName>
  <Password>String</Password>
  <UserName>String</UserName>
  <ClientId>String</ClientId>
  <DateSelector>DateOfCharge</DateSelector>
  <EndDate>String</EndDate>
  <IncludeManualCharges>false</IncludeManualCharges>
  <IncludeSchedulingCharges>false</IncludeSchedulingCharges>
  <StartDate>String</StartDate>
</ListAllChargesRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfChargeInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <ChargeInfo>
    <BillingCode>String</BillingCode>
    <ClientId>String</ClientId>
    <ClientName>String</ClientName>
    <Cost>0</Cost>
    <DateCreated>String</DateCreated>
    <DateLastModified>String</DateLastModified>
    <DateOfCharge>String</DateOfCharge>
    <Description>String</Description>
    <EntityStatus>String</EntityStatus>
    <Id>String</Id>
    <Memorized>false</Memorized>
    <Notes>String</Notes>
    <Quantity>0</Quantity>
    <Service>String</Service>
    <ServiceId>String</ServiceId>
  </ChargeInfo>
</ArrayOfChargeInfo>