regis

FinanceAdjustmentRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/{uuid}/Adjustment/{reporting_term}

import Foundation
import ServiceStack

public class FinanceAdjustmentRequest : Codable
{
    public var uuid:String
    public var reporting_term:String
    public var is_financial_aid:Bool
    public var authorizing_uuid:String

    required public init(){}
}

public class FinanceAdjustmentResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var reporting_term:String
    public var openFiscalDate:Date?
    public var invoiceItemBalances:[InvoiceItemBalanceResponse] = []
    public var availableInvoiceItems:[InvoiceItemAdminResponse] = []

    required public init(){}
}

public class InvoiceItemBalanceResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var rate_id:Int
    public var rate_code:String
    public var rate_description:String
    public var balance_amount:Double
    public var charge_amount:Double
    public var credit_amount:Double

    required public init(){}
}

public class InvoiceItemAdminResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var invoiceItemUUID:String
    public var rate_id:Int
    public var rate_code:String
    public var rate_description:String
    public var is_required:Bool
    public var is_optional:Bool
    public var charge:Double?
    public var credit:Double?

    required public init(){}
}

Swift 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}]}