Required permission: | CreatePayments |
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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
process: String,
action: String,
note: String,
message: String,
order_id: String,
external_payment_id: 0,
regent_id: 0,
amount: 0,
payment_type: String,
customer_ip: String,
name: String,
email: String,
phone: String,
addr1: String,
addr2: String,
city: String,
state: String,
country: String,
code: String,
current_status: String,
current_status_date: 0001-01-01,
pushed_to_gl: False,
pushed_to_gl_date: 0001-01-01
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { paymentUUID: String, order_id: String, external_payment_id: 0, added_date: 0001-01-01, regent_id: 0, uuid: String, amount: 0, payment_type: String, is_pushed_to_gl: False, current_status: String, current_status_date: 0001-01-01 }