Required permission: | ReadAccountReport |
POST | /Finance/Payments |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
from_date | body | DateTime? | No | |
to_date | body | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
payments | form | List<FinancePaymentResponse> | No | |
from_date | form | DateTime | No | |
to_date | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
paymentUUID | form | string | No | |
order_id | form | string | No | |
external_payment_id | form | int | No | |
added_date | form | DateTime | No | |
regent_id | form | int | No | |
uuid | form | string | No | |
amount | form | decimal | No | |
payment_type | form | string | No | |
is_pushed_to_gl | form | bool | No | |
current_status | form | string | No | |
current_status_date | form | DateTime? | No |
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/Payments HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
from_date: 0001-01-01,
to_date: 0001-01-01
}
HTTP/1.1 200 OK Content-Type: text/jsv 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-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 } ], from_date: 0001-01-01, to_date: 0001-01-01 }