regis

FinanceAdjustmentRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class InvoiceItemBalanceResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? rate_id;
    String? rate_code;
    String? rate_description;
    double? balance_amount;
    double? charge_amount;
    double? credit_amount;

    InvoiceItemBalanceResponse({this.responseStatus,this.rate_id,this.rate_code,this.rate_description,this.balance_amount,this.charge_amount,this.credit_amount});
    InvoiceItemBalanceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        rate_id = json['rate_id'];
        rate_code = json['rate_code'];
        rate_description = json['rate_description'];
        balance_amount = JsonConverters.toDouble(json['balance_amount']);
        charge_amount = JsonConverters.toDouble(json['charge_amount']);
        credit_amount = JsonConverters.toDouble(json['credit_amount']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'rate_id': rate_id,
        'rate_code': rate_code,
        'rate_description': rate_description,
        'balance_amount': balance_amount,
        'charge_amount': charge_amount,
        'credit_amount': credit_amount
    };

    getTypeName() => "InvoiceItemBalanceResponse";
    TypeContext? context = _ctx;
}

class InvoiceItemAdminResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? invoiceItemUUID;
    int? rate_id;
    String? rate_code;
    String? rate_description;
    bool? is_required;
    bool? is_optional;
    double? charge;
    double? credit;

    InvoiceItemAdminResponse({this.responseStatus,this.invoiceItemUUID,this.rate_id,this.rate_code,this.rate_description,this.is_required,this.is_optional,this.charge,this.credit});
    InvoiceItemAdminResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        invoiceItemUUID = json['invoiceItemUUID'];
        rate_id = json['rate_id'];
        rate_code = json['rate_code'];
        rate_description = json['rate_description'];
        is_required = json['is_required'];
        is_optional = json['is_optional'];
        charge = JsonConverters.toDouble(json['charge']);
        credit = JsonConverters.toDouble(json['credit']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'invoiceItemUUID': invoiceItemUUID,
        'rate_id': rate_id,
        'rate_code': rate_code,
        'rate_description': rate_description,
        'is_required': is_required,
        'is_optional': is_optional,
        'charge': charge,
        'credit': credit
    };

    getTypeName() => "InvoiceItemAdminResponse";
    TypeContext? context = _ctx;
}

class FinanceAdjustmentResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? uuid;
    String? reporting_term;
    DateTime? openFiscalDate;
    List<InvoiceItemBalanceResponse>? invoiceItemBalances;
    List<InvoiceItemAdminResponse>? availableInvoiceItems;

    FinanceAdjustmentResponse({this.responseStatus,this.regent_id,this.uuid,this.reporting_term,this.openFiscalDate,this.invoiceItemBalances,this.availableInvoiceItems});
    FinanceAdjustmentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        uuid = json['uuid'];
        reporting_term = json['reporting_term'];
        openFiscalDate = JsonConverters.fromJson(json['openFiscalDate'],'DateTime',context!);
        invoiceItemBalances = JsonConverters.fromJson(json['invoiceItemBalances'],'List<InvoiceItemBalanceResponse>',context!);
        availableInvoiceItems = JsonConverters.fromJson(json['availableInvoiceItems'],'List<InvoiceItemAdminResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'uuid': uuid,
        'reporting_term': reporting_term,
        'openFiscalDate': JsonConverters.toJson(openFiscalDate,'DateTime',context!),
        'invoiceItemBalances': JsonConverters.toJson(invoiceItemBalances,'List<InvoiceItemBalanceResponse>',context!),
        'availableInvoiceItems': JsonConverters.toJson(availableInvoiceItems,'List<InvoiceItemAdminResponse>',context!)
    };

    getTypeName() => "FinanceAdjustmentResponse";
    TypeContext? context = _ctx;
}

class FinanceAdjustmentRequest implements IConvertible
{
    String? uuid;
    String? reporting_term;
    bool? is_financial_aid;
    String? authorizing_uuid;

    FinanceAdjustmentRequest({this.uuid,this.reporting_term,this.is_financial_aid,this.authorizing_uuid});
    FinanceAdjustmentRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        reporting_term = json['reporting_term'];
        is_financial_aid = json['is_financial_aid'];
        authorizing_uuid = json['authorizing_uuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'reporting_term': reporting_term,
        'is_financial_aid': is_financial_aid,
        'authorizing_uuid': authorizing_uuid
    };

    getTypeName() => "FinanceAdjustmentRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'InvoiceItemBalanceResponse': TypeInfo(TypeOf.Class, create:() => InvoiceItemBalanceResponse()),
    'InvoiceItemAdminResponse': TypeInfo(TypeOf.Class, create:() => InvoiceItemAdminResponse()),
    'FinanceAdjustmentResponse': TypeInfo(TypeOf.Class, create:() => FinanceAdjustmentResponse()),
    'List<InvoiceItemBalanceResponse>': TypeInfo(TypeOf.Class, create:() => <InvoiceItemBalanceResponse>[]),
    'List<InvoiceItemAdminResponse>': TypeInfo(TypeOf.Class, create:() => <InvoiceItemAdminResponse>[]),
    'FinanceAdjustmentRequest': TypeInfo(TypeOf.Class, create:() => FinanceAdjustmentRequest()),
});

Dart FinanceAdjustmentRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FinanceAdjustmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <is_financial_aid>false</is_financial_aid>
  <reporting_term>String</reporting_term>
  <uuid>String</uuid>
</FinanceAdjustmentRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinanceAdjustmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <availableInvoiceItems>
    <InvoiceItemAdminResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <charge>0</charge>
      <credit>0</credit>
      <invoiceItemUUID>String</invoiceItemUUID>
      <is_optional>false</is_optional>
      <is_required>false</is_required>
      <rate_code>String</rate_code>
      <rate_description>String</rate_description>
      <rate_id>0</rate_id>
    </InvoiceItemAdminResponse>
  </availableInvoiceItems>
  <invoiceItemBalances>
    <InvoiceItemBalanceResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <balance_amount>0</balance_amount>
      <charge_amount>0</charge_amount>
      <credit_amount>0</credit_amount>
      <rate_code>String</rate_code>
      <rate_description>String</rate_description>
      <rate_id>0</rate_id>
    </InvoiceItemBalanceResponse>
  </invoiceItemBalances>
  <openFiscalDate>0001-01-01T00:00:00</openFiscalDate>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
  <uuid>String</uuid>
</FinanceAdjustmentResponse>