Update a fee refund record
patch
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/{FeeRecordKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
FeeRecordKey: integer
The unique identifier of the fee record.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorFeeRefunds-item
Type:
Show Source
object
-
AccountingDate(optional):
string(date)
The accounting date of the fee record.
-
AcctEventStatus(optional):
string
Maximum Length:
3
The accounting event status. The status indicates whether this fee has been sent to the accounting event transaction table or not. -
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier of the public sector agency to which this fee record belongs. -
AssessedDate(optional):
string(date)
The date when the set value of the fee is calculated.
-
BillType(optional):
string
Title:
Bill Type
Maximum Length:15
The bill type associated with the fee record. -
CurrencyCode(optional):
string
Title:
Currency
Maximum Length:3
The currency code. -
DepartmentId(optional):
string
Maximum Length:
30
The department identifier specified at the fee item level. If not specified at the fee item level, the department that is specified on the record type is used. -
EventId(optional):
integer(int64)
The accounting event identifier for the fee record.
-
FeeAmount(optional):
number
The fee amount.
-
FeeItemId(optional):
string
Maximum Length:
30
The fee Item from the common fee item table. If the fee item exists in the table, then the value from the decision model is used. If the fee item does not exist in the table, then the default fee item specified on the fee schedule is used. -
FeeMemo(optional):
string
Maximum Length:
200
The text field where the agency staff can enter a comment or memo regarding the fee. -
FeeQuantity(optional):
number
The number of fee items. This value is presently 1, but may be used in the future for multiple fees of the same type.
-
FeeRecordKey(optional):
integer(int64)
The unique identifier of the fee record.
-
FeeReferenceKey(optional):
integer(int64)
The parent fee transaction record.
-
FeeScheduleId(optional):
string
Maximum Length:
20
The unique identifier of the fee schedule. -
FeeScheduleLine(optional):
integer(int64)
The line number of the current fee schedule.
-
FeeSource(optional):
string
Maximum Length:
3
The source of the fee. The source indicates that the fee was created either by the system or by a user. -
FeeStatus(optional):
string
Maximum Length:
6
The status of the fee record. -
Invoice(optional):
string
Maximum Length:
50
The invoice number that comes from the billing service. -
InvoiceLine(optional):
integer(int32)
The invoice line that comes from the billing service.
-
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
The logical record identifier of the parent. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record with the parent ID of the fee record.
-
PaymentDate(optional):
string(date-time)
The date when the fee was paid.
-
PaymentMethodCode(optional):
string
Maximum Length:
30
The payment method used. This information comes from the payment service. -
PaymentReferenceId(optional):
string
Maximum Length:
50
The identifier generated by the payment service once the payment has been confirmed. The reference ID helps to identify groupings for invoice purposes. -
ReceiptNumber(optional):
string
Maximum Length:
50
The receipt number that comes from the billing service. -
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
Maximum Length:
30
The revenue recognition accounting date option from the common fee item table for the selected fee item.
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.
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 : publicSectorFeeRefunds-item
Type:
Show Source
object
-
AccountingDate(optional):
string(date)
The accounting date of the fee record.
-
AcctEventStatus(optional):
string
Maximum Length:
3
The accounting event status. The status indicates whether this fee has been sent to the accounting event transaction table or not. -
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier of the public sector agency to which this fee record belongs. -
AssessedDate(optional):
string(date)
The date when the set value of the fee is calculated.
-
BillType(optional):
string
Title:
Bill Type
Maximum Length:15
The bill type associated with the fee record. -
CurrencyCode(optional):
string
Title:
Currency
Maximum Length:3
The currency code. -
DepartmentId(optional):
string
Maximum Length:
30
The department identifier specified at the fee item level. If not specified at the fee item level, the department that is specified on the record type is used. -
EventId(optional):
integer(int64)
The accounting event identifier for the fee record.
-
FeeAmount(optional):
number
The fee amount.
-
FeeItemId(optional):
string
Maximum Length:
30
The fee Item from the common fee item table. If the fee item exists in the table, then the value from the decision model is used. If the fee item does not exist in the table, then the default fee item specified on the fee schedule is used. -
FeeMemo(optional):
string
Maximum Length:
200
The text field where the agency staff can enter a comment or memo regarding the fee. -
FeeQuantity(optional):
number
The number of fee items. This value is presently 1, but may be used in the future for multiple fees of the same type.
-
FeeRecordKey(optional):
integer(int64)
The unique identifier of the fee record.
-
FeeReferenceKey(optional):
integer(int64)
The parent fee transaction record.
-
FeeScheduleId(optional):
string
Maximum Length:
20
The unique identifier of the fee schedule. -
FeeScheduleLine(optional):
integer(int64)
The line number of the current fee schedule.
-
FeeSource(optional):
string
Maximum Length:
3
The source of the fee. The source indicates that the fee was created either by the system or by a user. -
FeeStatus(optional):
string
Maximum Length:
6
The status of the fee record. -
Invoice(optional):
string
Maximum Length:
50
The invoice number that comes from the billing service. -
InvoiceLine(optional):
integer(int32)
The invoice line that comes from the billing service.
-
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
The logical record identifier of the parent. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record with the parent ID of the fee record.
-
PaymentDate(optional):
string(date-time)
The date when the fee was paid.
-
PaymentMethodCode(optional):
string
Maximum Length:
30
The payment method used. This information comes from the payment service. -
PaymentReferenceId(optional):
string
Maximum Length:
50
The identifier generated by the payment service once the payment has been confirmed. The reference ID helps to identify groupings for invoice purposes. -
ReceiptNumber(optional):
string
Maximum Length:
50
The receipt number that comes from the billing service. -
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
Maximum Length:
30
The revenue recognition accounting date option from the common fee item table for the selected fee item.
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.