AbodeONE

<back to all web services

PostBillingRegisterToExternal

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/post_billing_register
PostBillingRegisterToExternal Parameters:
NameParameterData TypeRequiredDescription
TermIdqueryintNo
FilenamequerystringNo
IsPreviewqueryboolNo
BillingRegistersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<BillingRegisterDTO>No
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

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 /post_billing_register HTTP/1.1 
Host: api.oau.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	termId: 0,
	filename: String,
	isPreview: False
}
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
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}