regis

<back to all web services

FinancePaymentLogRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/Payment/Log
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class FinancePaymentLogRequest
            Public Overridable Property process As String
            Public Overridable Property action As String
            Public Overridable Property note As String
            Public Overridable Property message As String
            Public Overridable Property order_id As String
            Public Overridable Property external_payment_id As Integer
            Public Overridable Property regent_id As Integer
            Public Overridable Property amount As Decimal
            Public Overridable Property payment_type As String
            Public Overridable Property customer_ip As String
            Public Overridable Property name As String
            Public Overridable Property email As String
            Public Overridable Property phone As String
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property city As String
            Public Overridable Property state As String
            Public Overridable Property country As String
            Public Overridable Property code As String
            Public Overridable Property current_status As String
            Public Overridable Property current_status_date As Nullable(Of Date)
            Public Overridable Property pushed_to_gl As Boolean
            Public Overridable Property pushed_to_gl_date As Nullable(Of Date)
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class FinancePaymentResponse
            Public Overridable Property paymentUUID As String
            Public Overridable Property order_id As String
            Public Overridable Property external_payment_id As Integer
            Public Overridable Property added_date As Date
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property amount As Decimal
            Public Overridable Property payment_type As String
            Public Overridable Property is_pushed_to_gl As Boolean
            Public Overridable Property current_status As String
            Public Overridable Property current_status_date As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

VB.NET FinancePaymentLogRequest 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/Payment/Log HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
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-01T00:00:00.0000000","pushed_to_gl":false,"pushed_to_gl_date":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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"}