HostedSuite

<back to all web services

ListChargesRequest

List all of the one-off (manual) charges optionally filtering by client

The following routes are available for this service:
POST/api/charges
ListChargesRequest Parameters:
NameParameterData TypeRequiredDescription
ClientIdbodystringNoThe ID of the client you want charges for
StartDatebodystringYesThe start of the date range for charges.
EndDatebodystringYesThe end of the date range for charges.
DateSelectorbodyChargeDateSelectorsNoSpecify which date field to query based on ('DateOfCharge', 'DateLastModified', 'DateCreated').
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 HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ListChargesRequest 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>
  <StartDate>String</StartDate>
</ListChargesRequest>

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>