GET api/{version}/PaymentHub/GetRequestInvoice?requestUid={requestUid}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| requestUid | string |
Required |
|
| version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
PaymentRequestInvoice| Name | Description | Type | Additional information |
|---|---|---|---|
| ParentOrderItem | Collection of PaymentRequestInvoiceItem |
None. |
|
| ChildOrderItem | Collection of PaymentRequestInvoiceItem |
None. |
|
| TotalAmount | decimal number |
None. |
|
| StudentFirstName | string |
None. |
|
| StudentLastName | string |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| InvoiceNo | integer |
None. |
|
| DueDate | date |
None. |
|
| DisplayRequestAmount | string |
None. |
|
| DisplayDueDate | string |
None. |
|
| PaymentStatus | string |
None. |
|
| DisplaySubTotal | string |
None. |
|
| SubTotal | decimal number |
None. |
|
| DisplaySalesTax | string |
None. |
|
| DisplayShipCharges | string |
None. |
|
| CompanyOrUniversity | string |
None. |
|
| DisplayInvoiceNo | string |
None. |
|
| ShipCharges | decimal number |
None. |
|
| city | string |
None. |
|
| state | string |
None. |
|
| country | string |
None. |
|
| PostalCode | string |
None. |
|
| FullAddress | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ParentOrderItem": [
{
"StudentProductId": 1,
"itemType": "sample string 2",
"SponsorPaymentRequestItemId": 3,
"ItemName": "sample string 4",
"Quantity": 5,
"UnitPrice": 6.1,
"DisplayUnitPrice": "sample string 7",
"ItemType": "sample string 8",
"SponsorPaymentRequestId": 9,
"FinalAmount": 10.1,
"DisplayFinalAmount": "sample string 11",
"ItemTaxAmount": 12.1
},
{
"StudentProductId": 1,
"itemType": "sample string 2",
"SponsorPaymentRequestItemId": 3,
"ItemName": "sample string 4",
"Quantity": 5,
"UnitPrice": 6.1,
"DisplayUnitPrice": "sample string 7",
"ItemType": "sample string 8",
"SponsorPaymentRequestId": 9,
"FinalAmount": 10.1,
"DisplayFinalAmount": "sample string 11",
"ItemTaxAmount": 12.1
}
],
"ChildOrderItem": [
{
"StudentProductId": 1,
"itemType": "sample string 2",
"SponsorPaymentRequestItemId": 3,
"ItemName": "sample string 4",
"Quantity": 5,
"UnitPrice": 6.1,
"DisplayUnitPrice": "sample string 7",
"ItemType": "sample string 8",
"SponsorPaymentRequestId": 9,
"FinalAmount": 10.1,
"DisplayFinalAmount": "sample string 11",
"ItemTaxAmount": 12.1
},
{
"StudentProductId": 1,
"itemType": "sample string 2",
"SponsorPaymentRequestItemId": 3,
"ItemName": "sample string 4",
"Quantity": 5,
"UnitPrice": 6.1,
"DisplayUnitPrice": "sample string 7",
"ItemType": "sample string 8",
"SponsorPaymentRequestId": 9,
"FinalAmount": 10.1,
"DisplayFinalAmount": "sample string 11",
"ItemTaxAmount": 12.1
}
],
"TotalAmount": 1.1,
"StudentFirstName": "sample string 2",
"StudentLastName": "sample string 3",
"Address1": "sample string 4",
"Address2": "sample string 5",
"InvoiceNo": 6,
"DueDate": "2026-04-02T20:39:32.4812508-04:00",
"DisplayRequestAmount": "sample string 8",
"DisplayDueDate": "sample string 9",
"PaymentStatus": "sample string 10",
"DisplaySubTotal": "sample string 11",
"SubTotal": 12.1,
"DisplaySalesTax": "sample string 13",
"DisplayShipCharges": "sample string 14",
"CompanyOrUniversity": "sample string 15",
"DisplayInvoiceNo": "sample string 16",
"ShipCharges": 17.1,
"city": "sample string 18",
"state": "sample string 19",
"country": "sample string 20",
"PostalCode": "sample string 21",
"FullAddress": "sample string 22"
}