regis

FinanceAdjustmentRequest

**Requires Authentication**
Required role:	REGISUserRole

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class FinanceAdjustmentRequest
            Public Overridable Property uuid As String
            Public Overridable Property reporting_term As String
            Public Overridable Property is_financial_aid As Boolean
            Public Overridable Property authorizing_uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class FinanceAdjustmentResponse
            Public Sub New()
                invoiceItemBalances = New List(Of InvoiceItemBalanceResponse)
                availableInvoiceItems = New List(Of InvoiceItemAdminResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property reporting_term As String
            Public Overridable Property openFiscalDate As Nullable(Of Date)
            Public Overridable Property invoiceItemBalances As List(Of InvoiceItemBalanceResponse)
            Public Overridable Property availableInvoiceItems As List(Of InvoiceItemAdminResponse)
        End Class

        Public Partial Class InvoiceItemAdminResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property invoiceItemUUID As String
            Public Overridable Property rate_id As Integer
            Public Overridable Property rate_code As String
            Public Overridable Property rate_description As String
            Public Overridable Property is_required As Boolean
            Public Overridable Property is_optional As Boolean
            Public Overridable Property charge As Nullable(Of Decimal)
            Public Overridable Property credit As Nullable(Of Decimal)
        End Class

        Public Partial Class InvoiceItemBalanceResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property rate_id As Integer
            Public Overridable Property rate_code As String
            Public Overridable Property rate_description As String
            Public Overridable Property balance_amount As Decimal
            Public Overridable Property charge_amount As Decimal
            Public Overridable Property credit_amount As Decimal
        End Class
    End Namespace
End Namespace

VB.NET FinanceAdjustmentRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"uuid":"String","reporting_term":"String","is_financial_aid":false,"authorizing_uuid":"String"}

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

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","reporting_term":"String","openFiscalDate":"0001-01-01T00:00:00.0000000","invoiceItemBalances":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"rate_id":0,"rate_code":"String","rate_description":"String","balance_amount":0,"charge_amount":0,"credit_amount":0}],"availableInvoiceItems":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"invoiceItemUUID":"String","rate_id":0,"rate_code":"String","rate_description":"String","is_required":false,"is_optional":false,"charge":0,"credit":0}]}