regis

<back to all web services

FinancePaymentsRequest

Requires Authentication
Required permission:ReadAccountReport
The following routes are available for this service:
POST/Finance/Payments
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 FinancePaymentsRequest
    {
        public virtual DateTime? from_date { get; set; }
        public virtual DateTime? to_date { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class FinancePaymentResponse
    {
        public virtual string paymentUUID { get; set; }
        public virtual string order_id { get; set; }
        public virtual int external_payment_id { get; set; }
        public virtual DateTime added_date { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual decimal amount { get; set; }
        public virtual string payment_type { get; set; }
        public virtual bool is_pushed_to_gl { get; set; }
        public virtual string current_status { get; set; }
        public virtual DateTime? current_status_date { get; set; }
    }

    public partial class FinancePaymentsResponse
    {
        public FinancePaymentsResponse()
        {
            payments = new List<FinancePaymentResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<FinancePaymentResponse> payments { get; set; }
        public virtual DateTime from_date { get; set; }
        public virtual DateTime to_date { get; set; }
    }

}

C# FinancePaymentsRequest 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/Payments HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"payments":[{"paymentUUID":"String","order_id":"String","external_payment_id":0,"added_date":"0001-01-01T00:00:00.0000000","regent_id":0,"uuid":"String","amount":0,"payment_type":"String","is_pushed_to_gl":false,"current_status":"String","current_status_date":"0001-01-01T00:00:00.0000000"}],"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000"}