AbodeONE

<back to all web services

AddBillingRent

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/billing_rent/add
AddBillingRent Parameters:
NameParameterData TypeRequiredDescription
StudentIdqueryintNo
TermIdqueryintNo
ResidentIdqueryint?No
RoomRateIdqueryint?No
BillingStartDtqueryDateTimeNo
BillingEndDtqueryDateTimeNo
RentTypequerystringNo
RentPeriodquerystringNo
OverrideWarningsquerybool?No
BillingRentResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformBillingRentDTONo
ResponseStatusformResponseStatusNo
BillingRentDTO Parameters:
NameParameterData TypeRequiredDescription
ActionTypeformstringNo
StudentIdformintNo
ResidentIdformint?No
RoomRateIdformint?No
BillingRentIdformintNo
TermIdformintNo
BuildingIdformintNo
TypeformstringNo
BuildingNameformstringNo
BillingStartDtformDateTimeNo
BillingEndDtformDateTimeNo
RentTypeformstringNo
RentPeriodformstringNo
ChargeDtformDateTime?No
ChargeGenDtformDateTime?No
BillingOverrideformboolNo
CreatedDtformDateTime?No
CreatedByformstringNo
LastModifiedDtformDateTime?No
LastModifiedByformstringNo
IsReservationformbool?No
UseInternalBillingformboolNo
ResidencyStartDtformDateTime?No
ResidencyEndDtformDateTime?No
ResidencyDaysStayedformintNo
BillingDaysformintNo
BillingDaysInTermformint?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 /billing_rent/add HTTP/1.1 
Host: api.oau.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddBillingRent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <BillingEndDt>0001-01-01T00:00:00</BillingEndDt>
  <BillingStartDt>0001-01-01T00:00:00</BillingStartDt>
  <OverrideWarnings>false</OverrideWarnings>
  <RentPeriod>String</RentPeriod>
  <RentType>String</RentType>
  <ResidentId>0</ResidentId>
  <RoomRateId>0</RoomRateId>
  <StudentId>0</StudentId>
  <TermId>0</TermId>
</AddBillingRent>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BillingRentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <ActionType>String</ActionType>
    <BillingDays>0</BillingDays>
    <BillingDaysInTerm>0</BillingDaysInTerm>
    <BillingEndDt>0001-01-01T00:00:00</BillingEndDt>
    <BillingOverride>false</BillingOverride>
    <BillingRentId>0</BillingRentId>
    <BillingStartDt>0001-01-01T00:00:00</BillingStartDt>
    <BuildingId>0</BuildingId>
    <BuildingName>String</BuildingName>
    <ChargeDt>0001-01-01T00:00:00</ChargeDt>
    <ChargeGenDt>0001-01-01T00:00:00</ChargeGenDt>
    <CreatedBy>String</CreatedBy>
    <CreatedDt>0001-01-01T00:00:00</CreatedDt>
    <IsReservation>false</IsReservation>
    <LastModifiedBy>String</LastModifiedBy>
    <LastModifiedDt>0001-01-01T00:00:00</LastModifiedDt>
    <RentPeriod>String</RentPeriod>
    <RentType>String</RentType>
    <ResidencyDaysStayed>0</ResidencyDaysStayed>
    <ResidencyEndDt>0001-01-01T00:00:00</ResidencyEndDt>
    <ResidencyStartDt>0001-01-01T00:00:00</ResidencyStartDt>
    <ResidentId>0</ResidentId>
    <RoomRateId>0</RoomRateId>
    <StudentId>0</StudentId>
    <TermId>0</TermId>
    <Type>String</Type>
    <UseInternalBilling>false</UseInternalBilling>
  </Result>
</BillingRentResponse>