regis

FinancePaymentsRequest

**Requires Authentication**
Required permission:	ReadAccountReport

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancePaymentResponse:
    payment_u_u_i_d: Optional[str] = None
    order_id: Optional[str] = None
    external_payment_id: int = 0
    added_date: datetime.datetime = datetime.datetime(1, 1, 1)
    regent_id: int = 0
    uuid: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    payment_type: Optional[str] = None
    is_pushed_to_gl: bool = False
    current_status: Optional[str] = None
    current_status_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancePaymentsResponse:
    response_status: Optional[ResponseStatus] = None
    payments: Optional[List[FinancePaymentResponse]] = None
    from_date: datetime.datetime = datetime.datetime(1, 1, 1)
    to_date: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancePaymentsRequest:
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None

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