AbodeONE

<back to all web services

GenerateBillingRegisterCharges

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/billing_register/generate
GenerateBillingRegisterCharges Parameters:
NameParameterData TypeRequiredDescription
TermIdqueryintNo
BillingRentIdqueryint?No
OverrideWarningsquerybool?No
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 .csv suffix or ?format=csv

HTTP + CSV

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.oau.abodehms.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"termId":0,"billingRentId":0,"overrideWarnings":false,"isPreview":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":[{"billingId":0,"termId":0,"studentId":0,"residentId":0,"buildingId":0,"disciplineId":0,"billingRentId":0,"chargeDt":"0001-01-01T00:00:00.0000000","amount":0,"description":"String","chargeType":"String","postBatchId":0,"postDt":"0001-01-01T00:00:00.0000000","accountRef":"String","refundable":false,"refunded":false,"locked":false,"relatedRow":0,"createdDt":"0001-01-01T00:00:00.0000000","createdBy":"String","lastModifiedDt":"0001-01-01T00:00:00.0000000","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"}}}