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}
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type InvoiceItemBalanceResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val rate_id:Int32 = new Int32() with get,set
        member val rate_code:String = null with get,set
        member val rate_description:String = null with get,set
        member val balance_amount:Decimal = new Decimal() with get,set
        member val charge_amount:Decimal = new Decimal() with get,set
        member val credit_amount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type InvoiceItemAdminResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val invoiceItemUUID:String = null with get,set
        member val rate_id:Int32 = new Int32() with get,set
        member val rate_code:String = null with get,set
        member val rate_description:String = null with get,set
        member val is_required:Boolean = new Boolean() with get,set
        member val is_optional:Boolean = new Boolean() with get,set
        member val charge:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val credit:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type FinanceAdjustmentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val openFiscalDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val invoiceItemBalances:ResizeArray<InvoiceItemBalanceResponse> = new ResizeArray<InvoiceItemBalanceResponse>() with get,set
        member val availableInvoiceItems:ResizeArray<InvoiceItemAdminResponse> = new ResizeArray<InvoiceItemAdminResponse>() with get,set

    [<AllowNullLiteral>]
    type FinanceAdjustmentRequest() = 
        member val uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val is_financial_aid:Boolean = new Boolean() with get,set
        member val authorizing_uuid:String = null with get,set

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

{"uuid":"String","reporting_term":"String","is_financial_aid":false,"authorizing_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,"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}]}