regis

<back to all web services

FinancePaymentsRequest

Requires Authentication
Required permission:ReadAccountReport
The following routes are available for this service:
POST/Finance/Payments
FinancePaymentsRequest Parameters:
NameParameterData TypeRequiredDescription
from_datebodyDateTime?No
to_datebodyDateTime?No
FinancePaymentsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
paymentsformList<FinancePaymentResponse>No
from_dateformDateTimeNo
to_dateformDateTimeNo
FinancePaymentResponse Parameters:
NameParameterData TypeRequiredDescription
paymentUUIDformstringNo
order_idformstringNo
external_payment_idformintNo
added_dateformDateTimeNo
regent_idformintNo
uuidformstringNo
amountformdecimalNo
payment_typeformstringNo
is_pushed_to_glformboolNo
current_statusformstringNo
current_status_dateformDateTime?No

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

{"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"payments":[{"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"}],"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000"}