Get a fee for the project record
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}
Request
Path Parameters
-
publicSectorProjectRecordFeePaymentsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, ProjectCode and RecordKey ---for the Project Record Fee Payments resource and used to uniquely identify an instance of Project Record Fee Payments. The client should not generate the hash key value. Instead, the client should query on the Project Record Fee Payments collection resource with a filter on the primary key values in order to navigate to a specific instance of Project Record Fee Payments.
For example: publicSectorProjectRecordFeePayments?q=AgencyId=<value1>;ProjectCode=<value2>;RecordKey=<value3>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorProjectRecordFeePayments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
Classification(optional):
string
Maximum Length:
3
The classification of the record type. -
CreatedBy(optional):
string
Maximum Length:
64
The name of the user who created the record. -
CreationDate(optional):
string(date-time)
The date and time when the record was created.
-
FeeRecordDisplay(optional):
array Record Fee Payments
Title:
Record Fee Payments
The project record fee payments resource is used to view the individual fee items of the transactions that are assigned to a project. -
LastUpdateDate(optional):
string(date-time)
The date and time when the record was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The name of the user who last updated the assignment. -
links(optional):
array Items
Title:
Items
Link Relations -
ProjectCode(optional):
string
Maximum Length:
30
The unique identifier of the project. -
RecordId(optional):
string
Maximum Length:
50
The identifier of the application record. The value is generated based on the auto number rule configured for the type of record. -
RecordKey(optional):
integer(int64)
The unique identifier of the record.
Nested Schema : Record Fee Payments
Type:
array
Title:
Record Fee Payments
The project record fee payments resource is used to view the individual fee items of the transactions that are assigned to a project.
Show Source
Nested Schema : publicSectorProjectRecordFeePayments-FeeRecordDisplay-item
Type:
Show Source
object
-
AccountingEventStatus(optional):
string
Title:
Accounting Event Status
Maximum Length:3
The status of the accounting event. -
AgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier of the public sector agency. -
AssessedDate(optional):
string(date)
Title:
Assessed Date
The date when the fee item was assessed. -
BillType(optional):
string
Title:
Bill Type
Maximum Length:15
Determines the default invoice values for the invoice form and invoice number ID. The values are taken from the source application. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the record was created. -
CurrencyCode(optional):
string
Title:
Currency
Maximum Length:3
The default currency code for the fee schedule. -
DepartmentDescription(optional):
string
Maximum Length:
100
The description of the department. -
DepartmentId(optional):
string
Title:
Department
Maximum Length:30
The department identifier of the fee item. -
Description(optional):
string
Title:
Fee Description
Maximum Length:50
The description of the fee item. -
FeeAmount(optional):
number
Title:
Amount
The fee amount. -
FeeItemId(optional):
string
Title:
Fee Item
Maximum Length:30
The unique identifier of the fee that can be assessed for one or more record types. -
FeeMemo(optional):
string
Title:
Memo
Maximum Length:200
The memo content for the fee item. -
FeeQuantity(optional):
number
Title:
Fee Quantity
The fee quantity. -
FeeRecordKey(optional):
integer(int64)
Title:
Fee Record
The unique identifier of the fee record. -
FeeSource(optional):
string
Title:
Source
Maximum Length:3
The source from which the fee is collected. -
FeeStatus(optional):
string
Title:
Status
Maximum Length:6
The fee status. -
Invoice(optional):
string
Title:
Invoice
Maximum Length:50
The invoice number for the associated bill header. -
InvoiceLine(optional):
integer(int32)
Title:
Invoice Line
The invoice line number. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the fee was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of user who last updated the fee item. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record.
-
PaymentDate(optional):
string(date-time)
Title:
Payment Date
The date when the payment was made. -
PaymentMethodCode(optional):
string
Title:
Payment Method
Maximum Length:30
The payment method code that is configured for the current payment option. -
PaymentReferenceId(optional):
string
Title:
Payment Reference
Maximum Length:50
The unique identifier of the payment. -
ReceiptNumber(optional):
string
Title:
Receipt
Maximum Length:50
The receipt number. -
RefundedAmount(optional):
number
The total amount refunded for the fee item.
-
RefundedCurrencyCode(optional):
string
Maximum Length:
3
The currency code for the refund. -
RefundReason(optional):
string
Maximum Length:
30
The reason for the refund. -
RevrecDateOption(optional):
string
Title:
Revenue Recognition Date
Maximum Length:30
Indicates the options for the revenue recognition accounting date. The options are Fee Paid, Fee Assessed, and Fee Refunded. The default value is None.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.