regis

<back to all web services

FinanceAccountLateChargeJobResultRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/AccountLate/{reporting_term}/Jobs/Result
namespace regis.ClassLibrary.Requests

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

    [<AllowNullLiteral>]
    type FinanceAccountLateChargeOutcome() = 
        member val regent_id:Int32 = new Int32() with get,set
        member val status:String = null with get,set
        member val charge_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val charge_status:String = null with get,set
        member val email_status:String = null with get,set
        member val message:String = null with get,set

    [<AllowNullLiteral>]
    type FinanceAccountLateChargeJobResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val operation_id:Guid = new Guid() with get,set
        member val reporting_term:String = null with get,set
        member val calculation_date:DateTime = new DateTime() with get,set
        member val preview_only:Boolean = new Boolean() with get,set
        member val skip_exact_balance:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val state:String = null with get,set
        member val total:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val current_regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val processed:Int32 = new Int32() with get,set
        member val succeeded:Int32 = new Int32() with get,set
        member val skipped:Int32 = new Int32() with get,set
        member val failed:Int32 = new Int32() with get,set
        member val created_utc:DateTime = new DateTime() with get,set
        member val updated_utc:DateTime = new DateTime() with get,set
        member val message:String = null with get,set
        member val report_available:Boolean = new Boolean() with get,set
        member val outcomes:ResizeArray<FinanceAccountLateChargeOutcome> = new ResizeArray<FinanceAccountLateChargeOutcome>() with get,set

    [<AllowNullLiteral>]
    type FinanceAccountLateChargeResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val skip_reason:String = null with get,set
        member val charge_status:String = null with get,set
        member val email_status:String = null with get,set
        member val charge_error:String = null with get,set
        member val email_error:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val uuid:String = null with get,set
        member val has_late_reg_fee:Boolean = new Boolean() with get,set
        member val amount_owing:Decimal = new Decimal() with get,set
        member val late_fee:Decimal = new Decimal() with get,set
        member val interest:Decimal = new Decimal() with get,set
        member val active_financial_restrictions:String = null with get,set
        member val new_financial_restriction:String = null with get,set
        member val last_registration_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type FinanceAccountLateChargeJobResultResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val job:FinanceAccountLateChargeJobResponse = null with get,set
        member val accounts:ResizeArray<FinanceAccountLateChargeResponse> = new ResizeArray<FinanceAccountLateChargeResponse>() with get,set

    [<AllowNullLiteral>]
    type FinanceAccountLateChargeJobResultRequest() = 
        member val authorizing_uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val operation_id:Guid = new Guid() with get,set

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

{"authorizing_uuid":"String","reporting_term":"String","operation_id":"00000000000000000000000000000000"}
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"}},"job":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"operation_id":"00000000000000000000000000000000","reporting_term":"String","calculation_date":"0001-01-01T00:00:00.0000000","preview_only":false,"skip_exact_balance":0,"state":"String","total":0,"current_regent_id":0,"processed":0,"succeeded":0,"skipped":0,"failed":0,"created_utc":"0001-01-01T00:00:00.0000000","updated_utc":"0001-01-01T00:00:00.0000000","message":"String","report_available":false,"outcomes":[{"regent_id":0,"status":"String","charge_amount":0,"charge_status":"String","email_status":"String","message":"String"}]},"accounts":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"skip_reason":"String","charge_status":"String","email_status":"String","charge_error":"String","email_error":"String","regent_id":0,"first_name":"String","last_name":"String","uuid":"String","has_late_reg_fee":false,"amount_owing":0,"late_fee":0,"interest":0,"active_financial_restrictions":"String","new_financial_restriction":"String","last_registration_date":"0001-01-01T00:00:00.0000000"}]}