regis

FinanceAccountLateChargeJobResultRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/AccountLate/{reporting_term}/Jobs/Result

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAccountLateChargeOutcome:
    regent_id: int = 0
    status: Optional[str] = None
    charge_amount: Optional[Decimal] = None
    charge_status: Optional[str] = None
    email_status: Optional[str] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAccountLateChargeJobResponse:
    response_status: Optional[ResponseStatus] = None
    operation_id: Optional[str] = None
    reporting_term: Optional[str] = None
    calculation_date: datetime.datetime = datetime.datetime(1, 1, 1)
    preview_only: bool = False
    skip_exact_balance: Optional[Decimal] = None
    state: Optional[str] = None
    total: Optional[int] = None
    current_regent_id: Optional[int] = None
    processed: int = 0
    succeeded: int = 0
    skipped: int = 0
    failed: int = 0
    created_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    updated_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    message: Optional[str] = None
    report_available: bool = False
    outcomes: Optional[List[FinanceAccountLateChargeOutcome]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAccountLateChargeResponse:
    response_status: Optional[ResponseStatus] = None
    skip_reason: Optional[str] = None
    charge_status: Optional[str] = None
    email_status: Optional[str] = None
    charge_error: Optional[str] = None
    email_error: Optional[str] = None
    regent_id: int = 0
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    uuid: Optional[str] = None
    has_late_reg_fee: bool = False
    amount_owing: Decimal = decimal.Decimal(0)
    late_fee: Decimal = decimal.Decimal(0)
    interest: Decimal = decimal.Decimal(0)
    active_financial_restrictions: Optional[str] = None
    new_financial_restriction: Optional[str] = None
    last_registration_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAccountLateChargeJobResultResponse:
    response_status: Optional[ResponseStatus] = None
    job: Optional[FinanceAccountLateChargeJobResponse] = None
    accounts: Optional[List[FinanceAccountLateChargeResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAccountLateChargeJobResultRequest:
    authorizing_uuid: Optional[str] = None
    reporting_term: Optional[str] = None
    operation_id: Optional[str] = None

Python FinanceAccountLateChargeJobResultRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	authorizing_uuid: String,
	reporting_term: String,
	operation_id: 00000000000000000000000000000000
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
		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-01,
		updated_utc: 0001-01-01,
		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-01
		}
	]
}