Get all higher education payments
get
/fscmRestApi/resources/11.13.18.05/hedPayments
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds all higher education payments that match the primary key criteria specified.
Finder Variables:- PaymentId; integer; Unique identifier for a higher education payment.
- PrimaryKey: Finds all higher education payments that match the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AmountDue; number; Amount due is the fee amount after the discount is applied.
- ApplicationRegistrationCode; string; The API key assigned to the registered application.
- CountryCode; string; A short alphabetic code representing the country that is used as the default address.
- CurrencyCode; string; The currency that the fee will be charged in.
- CurrencySymbol; string; Currency symbol of the currency code in which the transactions are charged in.
- DiscountAmount; number; Discount amount to be stored if any.
- InstrumentPaymentUseId; integer; The unique identifier of the payment method.
- ManualDiscountId; integer; The unique identifier of a manual discount.
- ManualOverrideAmount; number; The amount that is manually provided to override the current discount.
- OverallAmount; number; Overall amount is the actual fee before the discount is applied.
- PaymentAmountFlag; boolean; Indicator to identify whether payment is required or not.
- PaymentId; integer; Identifier of the payment request.
- ReceiptConfirmationMessage; string; Receipt confirmation message passed to the consumer with receipt details.
- ReceiptStatus; string; Status of the receipt such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
- RelatedPartyId; integer; Party identifier of the learner.
- TransactionConfirmationMessage; string; Transaction confirmation message passed to the consumer with transaction details.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : hedPayments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedPayments-item-response
Type:
Show Source
object
-
AccountType: string
Type of the account specified.
-
AllowDiscountFlag: boolean
Indicates whether a discount can be applied to a chargeable item in the current request. The default value is based on the current system and fee settings.
-
Amount: number
Amount to be stored if any.
-
AmountDue: number
Amount due is the fee amount after the discount is applied.
-
ApplicationRegistrationCode: string
The API key assigned to the registered application.
-
AppliedDiscountId: integer
The unique identifier of an automatic discount.
-
AppliedDiscountName: string
The name of an automatic discount.
-
AutoSubmitFlag: boolean
Default Value:
true
This indicates that the service has determined the admissions application doesn't require payment, so it automatically completes the transaction. The default setting is true. -
BankAccountNumber: string
Bank account number specified.
-
BranchNumber: string
Branch number specified.
-
BusinessUnit: string
Business unit specified.
-
BuyerPartyId: integer
Party identifier of the student.
-
CountryCode: string
A short alphabetic code representing the country that is used as the default address.
-
CurrencyCode: string
The currency that the fee will be charged in.
-
CurrencySymbol: string
Currency symbol of the currency code in which the transactions are charged in.
-
DiscountAmount: number
Discount amount to be stored if any.
-
DiscountPercent: number
The percentage by which a fee is reduced.
-
ExternalTrxReference: string
Transaction number for third party payment transactions. This value is passed from the external system once the payment is successful.
-
ExternalTrxReferenceDate: string
(date)
Transaction date for third party payment transactions. This value is passed from the external system once the payment is successful.
-
InstrumentPaymentUseId: integer
The unique identifier of the payment method.
-
InvoiceConfirmationMessage: string
Invoice confirmation message passed to the consumer with invoice details.
-
InvoiceStatus: string
Status of the processed invoice such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualDiscountId: integer
The unique identifier of a manual discount.
-
ManualOverrideAmount: number
The amount that is manually provided to override the current discount.
-
ObjectId: integer
Identifier of the object that initiates the transaction.
-
OrderId: integer
Identifier passed by the credit card payment provider.
-
OverallAmount: number
Overall amount is the actual fee before the discount is applied.
-
PayerPartyId: integer
Party identifier of the proxy.
-
PaymentAmountFlag: boolean
Indicator to identify whether payment is required or not.
-
PaymentConfirmationMessage: string
Payment confirmation message passed to the consumer with receipt details.
-
PaymentId: integer
Identifier of the payment request.
-
PaymentStatus: string
Status of the processed payment such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
-
PayPointCode: string
Code that identifies the pay point. A pay point can be an instance of the shopping cart, My Finances, and so on.
-
PayPointOption: string
Payment option depending on the selected pay point. A payment option for My Finances can be paying the billed amount, total amount, or another amount.
-
PromotionCode: string
Code that must be entered by the user to obtain a promotion type discount.
-
ReceiptConfirmationMessage: string
Receipt confirmation message passed to the consumer with receipt details.
-
ReceiptStatus: string
Status of the receipt such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
-
ReferenceKey: string
Randomly generated transaction reference key used by student to make a payment using a third party payment service provider.
-
RelatedPartyId: integer
Party identifier of the learner.
-
TransactionConfirmationMessage: string
Transaction confirmation message passed to the consumer with transaction details.
-
TransactionReferenceId: integer
Transaction identifier for third party payment transactions.
-
TransactionStatus: string
Status of the reference key that is generated such as ORA_PENDING, ORA_VALIDATED, ORA_EXPIRED, ORA_POSTED, ORA_ERROR, or ORA_MESSAGES.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.