regis

<back to all web services

FinanceBalanceRequest

Requires Authentication
Required permission:ReadAccountBalance
The following routes are available for this service:
POST/Finance/Balance/{uuid}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class FinanceBalanceRequest
{
    var uuid:String? = null
}

open class FinanceBalanceResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var first_name:String? = null
    var last_name:String? = null
    var email:String? = null
    var current_program:String? = null
    var first_regent_term:String? = null
    var first_registered_date:Date? = null
    var last_registered_date:Date? = null
    var uuid:String? = null
    var total_payments:BigDecimal? = null
    var total_charges:BigDecimal? = null
    var balance:BigDecimal? = null
    var gp_raw_balance:BigDecimal? = null
    var is_vendor:Boolean? = null
    var is_customer:Boolean? = null
}

Kotlin FinanceBalanceRequest DTOs

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 /Finance/Balance/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"first_name":"String","last_name":"String","email":"String","current_program":"String","first_regent_term":"String","first_registered_date":"0001-01-01T00:00:00.0000000","last_registered_date":"0001-01-01T00:00:00.0000000","uuid":"String","total_payments":0,"total_charges":0,"balance":0,"gp_raw_balance":0,"is_vendor":false,"is_customer":false}