regis

<back to all web services

FinanceAdjustmentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/{uuid}/Adjustment/{reporting_term}
FinanceAdjustmentRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
reporting_termpathstringNo
is_financial_aidbodyboolNo
authorizing_uuidbodystringNo
FinanceAdjustmentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
reporting_termformstringNo
openFiscalDateformDateTime?No
invoiceItemBalancesformList<InvoiceItemBalanceResponse>No
availableInvoiceItemsformList<InvoiceItemAdminResponse>No
InvoiceItemBalanceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
rate_idformintNo
rate_codeformstringNo
rate_descriptionformstringNo
balance_amountformdecimalNo
charge_amountformdecimalNo
credit_amountformdecimalNo
InvoiceItemAdminResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
invoiceItemUUIDformstringNo
rate_idformintNo
rate_codeformstringNo
rate_descriptionformstringNo
is_requiredformboolNo
is_optionalformboolNo
chargeformdecimal?No
creditformdecimal?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/{uuid}/Adjustment/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","reporting_term":"String","is_financial_aid":false,"authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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,"uuid":"String","reporting_term":"String","openFiscalDate":"0001-01-01T00:00:00.0000000","invoiceItemBalances":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"rate_id":0,"rate_code":"String","rate_description":"String","balance_amount":0,"charge_amount":0,"credit_amount":0}],"availableInvoiceItems":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"invoiceItemUUID":"String","rate_id":0,"rate_code":"String","rate_description":"String","is_required":false,"is_optional":false,"charge":0,"credit":0}]}