| Required role: | Admin |
| All Verbs | /billing_register/generate |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TermId | query | int | No | |
| BillingRentId | query | int? | No | |
| OverrideWarnings | query | bool? | No | |
| IsPreview | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | List<BillingRegisterDTO> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST //billing_register/generate HTTP/1.1
Host: api.lsu-staging.abodehms.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
termId: 0,
billingRentId: 0,
overrideWarnings: False,
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,
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
}
}
}