regis

FinanceAdjustmentRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FinanceAdjustmentRequest
    {
        public String uuid = null;
        public String reporting_term = null;
        public Boolean is_financial_aid = null;
        public String authorizing_uuid = null;
        
        public String getUuid() { return uuid; }
        public FinanceAdjustmentRequest setUuid(String value) { this.uuid = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public FinanceAdjustmentRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Boolean getIsFinancialAid() { return is_financial_aid; }
        public FinanceAdjustmentRequest setIsFinancialAid(Boolean value) { this.is_financial_aid = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public FinanceAdjustmentRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
    }

    public static class FinanceAdjustmentResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String uuid = null;
        public String reporting_term = null;
        public Date openFiscalDate = null;
        public ArrayList<InvoiceItemBalanceResponse> invoiceItemBalances = null;
        public ArrayList<InvoiceItemAdminResponse> availableInvoiceItems = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public FinanceAdjustmentResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public FinanceAdjustmentResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public FinanceAdjustmentResponse setUuid(String value) { this.uuid = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public FinanceAdjustmentResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Date getOpenFiscalDate() { return openFiscalDate; }
        public FinanceAdjustmentResponse setOpenFiscalDate(Date value) { this.openFiscalDate = value; return this; }
        public ArrayList<InvoiceItemBalanceResponse> getInvoiceItemBalances() { return invoiceItemBalances; }
        public FinanceAdjustmentResponse setInvoiceItemBalances(ArrayList<InvoiceItemBalanceResponse> value) { this.invoiceItemBalances = value; return this; }
        public ArrayList<InvoiceItemAdminResponse> getAvailableInvoiceItems() { return availableInvoiceItems; }
        public FinanceAdjustmentResponse setAvailableInvoiceItems(ArrayList<InvoiceItemAdminResponse> value) { this.availableInvoiceItems = value; return this; }
    }

    public static class InvoiceItemBalanceResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer rate_id = null;
        public String rate_code = null;
        public String rate_description = null;
        public BigDecimal balance_amount = null;
        public BigDecimal charge_amount = null;
        public BigDecimal credit_amount = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public InvoiceItemBalanceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRateId() { return rate_id; }
        public InvoiceItemBalanceResponse setRateId(Integer value) { this.rate_id = value; return this; }
        public String getRateCode() { return rate_code; }
        public InvoiceItemBalanceResponse setRateCode(String value) { this.rate_code = value; return this; }
        public String getRateDescription() { return rate_description; }
        public InvoiceItemBalanceResponse setRateDescription(String value) { this.rate_description = value; return this; }
        public BigDecimal getBalanceAmount() { return balance_amount; }
        public InvoiceItemBalanceResponse setBalanceAmount(BigDecimal value) { this.balance_amount = value; return this; }
        public BigDecimal getChargeAmount() { return charge_amount; }
        public InvoiceItemBalanceResponse setChargeAmount(BigDecimal value) { this.charge_amount = value; return this; }
        public BigDecimal getCreditAmount() { return credit_amount; }
        public InvoiceItemBalanceResponse setCreditAmount(BigDecimal value) { this.credit_amount = value; return this; }
    }

    public static class InvoiceItemAdminResponse
    {
        public ResponseStatus responseStatus = null;
        public String invoiceItemUUID = null;
        public Integer rate_id = null;
        public String rate_code = null;
        public String rate_description = null;
        public Boolean is_required = null;
        public Boolean is_optional = null;
        public BigDecimal charge = null;
        public BigDecimal credit = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public InvoiceItemAdminResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getInvoiceItemUUID() { return invoiceItemUUID; }
        public InvoiceItemAdminResponse setInvoiceItemUUID(String value) { this.invoiceItemUUID = value; return this; }
        public Integer getRateId() { return rate_id; }
        public InvoiceItemAdminResponse setRateId(Integer value) { this.rate_id = value; return this; }
        public String getRateCode() { return rate_code; }
        public InvoiceItemAdminResponse setRateCode(String value) { this.rate_code = value; return this; }
        public String getRateDescription() { return rate_description; }
        public InvoiceItemAdminResponse setRateDescription(String value) { this.rate_description = value; return this; }
        public Boolean getIsRequired() { return is_required; }
        public InvoiceItemAdminResponse setIsRequired(Boolean value) { this.is_required = value; return this; }
        public Boolean getIsOptional() { return is_optional; }
        public InvoiceItemAdminResponse setIsOptional(Boolean value) { this.is_optional = value; return this; }
        public BigDecimal getCharge() { return charge; }
        public InvoiceItemAdminResponse setCharge(BigDecimal value) { this.charge = value; return this; }
        public BigDecimal getCredit() { return credit; }
        public InvoiceItemAdminResponse setCredit(BigDecimal value) { this.credit = value; return this; }
    }

}

Java 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>