HostedSuite

<back to all web services

UpdatePaymentStatusRequest

Update the payment status associated with a reservation

The following routes are available for this service:
POST/api/scheduling/update-payment-status
UpdatePaymentStatusRequest Parameters:
NameParameterData TypeRequiredDescription
ReservationIdbodystringNoThe ID of the reservation you want to update
OriginalDatebodystringNoThe date of the reservation you want to update. This needs to be specified for recurring reservation instances. Check the IsRecurring property of the reservation info.
PaymentStatusbodyPaymentStatusNoThe payment status to use
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
ReservationInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
EntityStatusformstringNo
CenterIdformstringNo
CenterNameformstringNo
CenterAddressformstringNo
MeetingRoomIdformstringNo
MeetingRoomNameformstringNo
StartTimeformstringNo
EndTimeformstringNo
SubjectformstringNo
StatusformstringNo
NotesformstringNo
PaymentStatusformstringNo
ClientIdformstringNo
ClientNameformstringNo
IsRecurringformboolNo
OriginalDateformstringNo
DateLastModifiedformstringNo
LastModifiedByformstringNo
AttendeesformList<AttendeeInfo>No
NumAttendeesformintNo
OrganizerformAttendeeInfoNo
CustomFieldsformList<CustomFieldInfo>No
AttendeeInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EmailAddressformstringNo
CustomFieldInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
PaymentStatus Enum:
None
NotPaid
PartiallyPaid
Overdue
Paid
Included
Cancelled
NoCharge
Confirmed
BillOther
Other
ReservationInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
EntityStatusformstringNo
CenterIdformstringNo
CenterNameformstringNo
CenterAddressformstringNo
MeetingRoomIdformstringNo
MeetingRoomNameformstringNo
StartTimeformstringNo
EndTimeformstringNo
SubjectformstringNo
StatusformstringNo
NotesformstringNo
PaymentStatusformstringNo
ClientIdformstringNo
ClientNameformstringNo
IsRecurringformboolNo
OriginalDateformstringNo
DateLastModifiedformstringNo
LastModifiedByformstringNo
AttendeesformList<AttendeeInfo>No
NumAttendeesformintNo
OrganizerformAttendeeInfoNo
CustomFieldsformList<CustomFieldInfo>No

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/scheduling/update-payment-status HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdatePaymentStatusRequest 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>
  <OriginalDate>String</OriginalDate>
  <PaymentStatus>None</PaymentStatus>
  <ReservationId>String</ReservationId>
</UpdatePaymentStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReservationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <Attendees>
    <AttendeeInfo>
      <EmailAddress>String</EmailAddress>
      <Name>String</Name>
    </AttendeeInfo>
  </Attendees>
  <CenterAddress>String</CenterAddress>
  <CenterId>String</CenterId>
  <CenterName>String</CenterName>
  <ClientId>String</ClientId>
  <ClientName>String</ClientName>
  <CustomFields>
    <CustomFieldInfo>
      <Name>String</Name>
      <Value>String</Value>
    </CustomFieldInfo>
  </CustomFields>
  <DateLastModified>String</DateLastModified>
  <EndTime>String</EndTime>
  <EntityStatus>String</EntityStatus>
  <Id>String</Id>
  <IsRecurring>false</IsRecurring>
  <LastModifiedBy>String</LastModifiedBy>
  <MeetingRoomId>String</MeetingRoomId>
  <MeetingRoomName>String</MeetingRoomName>
  <Notes>String</Notes>
  <NumAttendees>0</NumAttendees>
  <Organizer>
    <EmailAddress>String</EmailAddress>
    <Name>String</Name>
  </Organizer>
  <OriginalDate>String</OriginalDate>
  <PaymentStatus>String</PaymentStatus>
  <StartTime>String</StartTime>
  <Status>String</Status>
  <Subject>String</Subject>
</ReservationInfo>