regis

FinancePaymentsRequest

**Requires Authentication**
Required permission:	ReadAccountReport

The following routes are available for this service:
POST	/Finance/Payments

"use strict";
export class FinancePaymentResponse {
    /** @param {{paymentUUID?:string,order_id?:string,external_payment_id?:number,added_date?:string,regent_id?:number,uuid?:string,amount?:number,payment_type?:string,is_pushed_to_gl?:boolean,current_status?:string,current_status_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    paymentUUID;
    /** @type {string} */
    order_id;
    /** @type {number} */
    external_payment_id;
    /** @type {string} */
    added_date;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {number} */
    amount;
    /** @type {string} */
    payment_type;
    /** @type {boolean} */
    is_pushed_to_gl;
    /** @type {string} */
    current_status;
    /** @type {?string} */
    current_status_date;
}
export class FinancePaymentsResponse {
    /** @param {{responseStatus?:ResponseStatus,payments?:FinancePaymentResponse[],from_date?:string,to_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {FinancePaymentResponse[]} */
    payments;
    /** @type {string} */
    from_date;
    /** @type {string} */
    to_date;
}
export class FinancePaymentsRequest {
    /** @param {{from_date?:string,to_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    from_date;
    /** @type {?string} */
    to_date;
}

JavaScript FinancePaymentsRequest 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/Payments HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinancePaymentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <from_date>0001-01-01T00:00:00</from_date>
  <to_date>0001-01-01T00:00:00</to_date>
</FinancePaymentsRequest>

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

<FinancePaymentsResponse 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>
  <from_date>0001-01-01T00:00:00</from_date>
  <payments>
    <FinancePaymentResponse>
      <added_date>0001-01-01T00:00:00</added_date>
      <amount>0</amount>
      <current_status>String</current_status>
      <current_status_date>0001-01-01T00:00:00</current_status_date>
      <external_payment_id>0</external_payment_id>
      <is_pushed_to_gl>false</is_pushed_to_gl>
      <order_id>String</order_id>
      <paymentUUID>String</paymentUUID>
      <payment_type>String</payment_type>
      <regent_id>0</regent_id>
      <uuid>String</uuid>
    </FinancePaymentResponse>
  </payments>
  <to_date>0001-01-01T00:00:00</to_date>
</FinancePaymentsResponse>