regis

<back to all web services

FinanceAdjustmentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/{uuid}/Adjustment/{reporting_term}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class FinanceAdjustmentRequest
    {
        public virtual string uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual bool is_financial_aid { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class FinanceAdjustmentResponse
    {
        public FinanceAdjustmentResponse()
        {
            invoiceItemBalances = new List<InvoiceItemBalanceResponse>{};
            availableInvoiceItems = new List<InvoiceItemAdminResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual DateTime? openFiscalDate { get; set; }
        public virtual List<InvoiceItemBalanceResponse> invoiceItemBalances { get; set; }
        public virtual List<InvoiceItemAdminResponse> availableInvoiceItems { get; set; }
    }

    public partial class InvoiceItemAdminResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string invoiceItemUUID { get; set; }
        public virtual int rate_id { get; set; }
        public virtual string rate_code { get; set; }
        public virtual string rate_description { get; set; }
        public virtual bool is_required { get; set; }
        public virtual bool is_optional { get; set; }
        public virtual decimal? charge { get; set; }
        public virtual decimal? credit { get; set; }
    }

    public partial class InvoiceItemBalanceResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int rate_id { get; set; }
        public virtual string rate_code { get; set; }
        public virtual string rate_description { get; set; }
        public virtual decimal balance_amount { get; set; }
        public virtual decimal charge_amount { get; set; }
        public virtual decimal credit_amount { get; set; }
    }

}

C# FinanceAdjustmentRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","reporting_term":"String","is_financial_aid":false,"authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}]}