| Required role: | REGISUserRole |
| POST | /Finance/AccountLate/{reporting_term}/Jobs |
|---|
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 FinanceAccountLateChargeJobStartRequest:
authorizing_uuid: Optional[str] = None
reporting_term: Optional[str] = None
operation_id: Optional[str] = None
calculation_date: datetime.datetime = datetime.datetime(1, 1, 1)
preview_only: bool = False
skip_exact_balance: Optional[Decimal] = None
send_emails: bool = False
Python FinanceAccountLateChargeJobStartRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 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,
calculation_date: 0001-01-01,
preview_only: False,
skip_exact_balance: 0,
send_emails: False
}
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
}
},
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
}
]
}