AbodeONE

CreateBillingRegister

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/billing_register

**CreateBillingRegister** Parameters:
Name	Parameter	Data Type	Required
StudentId	body	int	Yes
Amount	body	decimal	Yes
AccountRef	body	string	Yes
ChargeDt	body	DateTime	Yes
ChargeType	body	ChargeTypeEnum	Yes
Locked	body	bool	Yes
Refunded	body	bool	Yes
Refundable	body	bool	Yes
TermId	body	int?	No
ResidentId	body	int?	No
BuildingId	body	int?	No
RoomId	body	int?	No
DisciplineId	body	int?	No
BillingRentId	body	int?	No
Description	body	string	No

**ChargeTypeEnum** Enum:
DEPOSIT
RENT
FINE
OTHER

**CreateBillingRegisterResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	BillingRegisterDTO	No
ResponseStatus	form	ResponseStatus	No

**BillingRegisterDTO** Parameters:
Name	Parameter	Data Type	Required
BillingId	form	int	No
TermId	form	int?	No
StudentId	form	int	No
ResidentId	form	int?	No
BuildingId	form	int?	No
DisciplineId	form	int?	No
BillingRentId	form	int?	No
ChargeDt	form	DateTime	No
Amount	form	decimal	No
Description	form	string	No
ChargeType	form	string	No
PostBatchId	form	int?	No
PostDt	form	DateTime?	No
AccountRef	form	string	No
Refundable	form	bool	No
Refunded	form	bool	No
Locked	form	bool	No
RelatedRow	form	int?	No
CreatedDt	form	DateTime?	No
CreatedBy	form	string	No
LastModifiedDt	form	DateTime?	No
LastModifiedBy	form	string	No
BuildingName	form	string	No
TotalBilled	form	decimal?	No
SchoolId	form	string	No
Firstname	form	string	No
Lastname	form	string	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_register HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	studentId: 0,
	amount: 0,
	accountRef: String,
	chargeDt: 0001-01-01,
	chargeType: DEPOSIT,
	locked: False,
	refunded: False,
	refundable: False,
	termId: 0,
	residentId: 0,
	buildingId: 0,
	roomId: 0,
	disciplineId: 0,
	billingRentId: 0,
	description: String
}

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
		}
	}
}