regis

FinancePaymentLogRequest

**Requires Authentication**
Required permission:	CreatePayments

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

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 FinancePaymentLogRequest:
    process: Optional[str] = None
    action: Optional[str] = None
    note: Optional[str] = None
    message: Optional[str] = None
    order_id: Optional[str] = None
    external_payment_id: int = 0
    regent_id: int = 0
    amount: Decimal = decimal.Decimal(0)
    payment_type: Optional[str] = None
    customer_ip: Optional[str] = None
    name: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    code: Optional[str] = None
    current_status: Optional[str] = None
    current_status_date: Optional[datetime.datetime] = None
    pushed_to_gl: bool = False
    pushed_to_gl_date: Optional[datetime.datetime] = None

Python FinancePaymentLogRequest 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/Payment/Log HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinancePaymentLogRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <action>String</action>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <amount>0</amount>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <current_status>String</current_status>
  <current_status_date>0001-01-01T00:00:00</current_status_date>
  <customer_ip>String</customer_ip>
  <email>String</email>
  <external_payment_id>0</external_payment_id>
  <message>String</message>
  <name>String</name>
  <note>String</note>
  <order_id>String</order_id>
  <payment_type>String</payment_type>
  <phone>String</phone>
  <process>String</process>
  <pushed_to_gl>false</pushed_to_gl>
  <pushed_to_gl_date>0001-01-01T00:00:00</pushed_to_gl_date>
  <regent_id>0</regent_id>
  <state>String</state>
</FinancePaymentLogRequest>

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

<FinancePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <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>