AbodeONE

<back to all web services

FindBillingRents

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/billing_rents
FindBillingRents Parameters:
NameParameterData TypeRequiredDescription
StudentIdqueryint?No
TermIdqueryint?No
BuildingIdsqueryArrayOfIntNo
FindBillingRentsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<BillingRentDTO>No
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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //billing_rents HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	studentId: 0,
	termId: 0,
	buildingIds: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			actionType: String,
			studentId: 0,
			residentId: 0,
			roomRateId: 0,
			billingRentId: 0,
			termId: 0,
			buildingId: 0,
			type: String,
			buildingName: String,
			billingStartDt: 0001-01-01,
			billingEndDt: 0001-01-01,
			rentType: String,
			rentPeriod: String,
			chargeDt: 0001-01-01,
			chargeGenDt: 0001-01-01,
			billingOverride: False,
			createdDt: 0001-01-01,
			createdBy: String,
			lastModifiedDt: 0001-01-01,
			lastModifiedBy: String,
			isReservation: False,
			useInternalBilling: False,
			residencyStartDt: 0001-01-01,
			residencyEndDt: 0001-01-01,
			residencyDaysStayed: 0,
			billingDays: 0,
			billingDaysInTerm: 0
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}