AbodeONE

<back to all web services

GetBillingRegister

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/billing_register/{BillingId}
GetBillingRegister Parameters:
NameParameterData TypeRequiredDescription
BillingIdpathintNo
GetBillingRegisterResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformBillingRegisterDTONo
ResponseStatusformResponseStatusNo
BillingRegisterDTO Parameters:
NameParameterData TypeRequiredDescription
BillingIdformintNo
TermIdformint?No
StudentIdformintNo
ResidentIdformint?No
BuildingIdformint?No
DisciplineIdformint?No
BillingRentIdformint?No
ChargeDtformDateTimeNo
AmountformdecimalNo
DescriptionformstringNo
ChargeTypeformstringNo
PostBatchIdformint?No
PostDtformDateTime?No
AccountRefformstringNo
RefundableformboolNo
RefundedformboolNo
LockedformboolNo
RelatedRowformint?No
CreatedDtformDateTime?No
CreatedByformstringNo
LastModifiedDtformDateTime?No
LastModifiedByformstringNo
BuildingNameformstringNo
TotalBilledformdecimal?No
SchoolIdformstringNo
FirstnameformstringNo
LastnameformstringNo

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.

GET //billing_register/{BillingId} HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		billingId: 0,
		termId: 0,
		studentId: 0,
		residentId: 0,
		buildingId: 0,
		disciplineId: 0,
		billingRentId: 0,
		chargeDt: 0001-01-01,
		amount: 0,
		description: String,
		chargeType: String,
		postBatchId: 0,
		postDt: 0001-01-01,
		accountRef: String,
		refundable: False,
		refunded: False,
		locked: False,
		relatedRow: 0,
		createdDt: 0001-01-01,
		createdBy: String,
		lastModifiedDt: 0001-01-01,
		lastModifiedBy: String,
		buildingName: String,
		totalBilled: 0,
		schoolId: String,
		firstname: String,
		lastname: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}