regis

<back to all web services

FinanceAdjustmentSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/{uuid}/Adjustment/{reporting_term}/Submit
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 FinanceAdjustmentRateSubmitRequest:
    rate_id: int = 0
    description: Optional[str] = None
    charge: Decimal = decimal.Decimal(0)
    credit: Decimal = decimal.Decimal(0)
    custom_gl: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAdjustmentSubmitRequest:
    uuid: Optional[str] = None
    reporting_term: Optional[str] = None
    rates: Optional[List[FinanceAdjustmentRateSubmitRequest]] = None
    description: Optional[str] = None
    authorizing_uuid: Optional[str] = None
    is_financial_aid: bool = False
    added_date: datetime.datetime = datetime.datetime(1, 1, 1)

Python FinanceAdjustmentSubmitRequest 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}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","reporting_term":"String","rates":[{"rate_id":0,"description":"String","charge":0,"credit":0,"custom_gl":"String"}],"description":"String","authorizing_uuid":"String","is_financial_aid":false,"added_date":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}