Create a set of fee refund records
post
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountingDate: string
(date)
The accounting date of the fee record.
-
AcctEventStatus: string
Title:
Accounting Event Status
Maximum Length:3
Default Value:I
The accounting event status. The status indicates whether this fee has been sent to the accounting event transaction table or not. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the public sector agency to which this fee record belongs. -
AssessedDate: string
(date)
Title:
Assessed Date
The date when the set value of the fee is calculated. -
BillType: string
Title:
Bill Type
Maximum Length:15
The bill type associated with the fee record. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
The currency code. -
DepartmentId: string
Title:
Department
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: integer
(int64)
The accounting event identifier for the fee record.
-
FeeAmount: number
Title:
Amount
The fee amount. -
FeeItemId: string
Title:
Fee Item
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: string
Title:
Memo
Maximum Length:200
The text field where the agency staff can enter a comment or memo regarding the fee. -
FeeQuantity: number
Title:
Fee Quantity
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: integer
(int64)
Title:
Fee Record
The unique identifier of the fee record. -
FeeReferenceKey: integer
(int64)
The parent fee transaction record.
-
FeeScheduleId: string
Title:
Fee Schedule
Maximum Length:20
The unique identifier of the fee schedule. -
FeeScheduleLine: integer
(int64)
Title:
Fee Items
The line number of the current fee schedule. -
FeeSource: string
Title:
Source
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: string
Title:
Status
Maximum Length:6
The status of the fee record. -
Invoice: string
Title:
Invoice
Maximum Length:50
The invoice number that comes from the billing service. -
InvoiceLine: integer
(int64)
Title:
Invoice Line
The invoice line that comes from the billing service. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The logical record identifier of the parent. -
LnpRecordKey: integer
(int64)
The unique identifier of the record with the parent ID of the fee record.
-
PaymentDate: string
(date-time)
Title:
Payment Date
The date when the fee was paid. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
The payment method used. This information comes from the payment service. -
PaymentReferenceId: string
Title:
Payment Reference
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: string
Title:
Receipt
Maximum Length:50
The receipt number that comes from the billing service. -
RefundedAmount: number
The total amount refunded for the fee item.
-
RefundedCurrencyCode: string
Maximum Length:
3
The currency code for the refund. -
RefundReason: string
Maximum Length:
30
The reason for the refund. -
ReversalReason: string
Maximum Length:
30
The reason for the reversal. -
RevrecDateOption: string
Title:
Revenue Recognition Date
Maximum Length:30
The revenue recognition accounting date option from the common fee item table for the selected fee item.
Response
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 : publicSectorFeeRefunds-item-response
Type:
Show Source
object
-
AccountingDate: string
(date)
The accounting date of the fee record.
-
AcctEventStatus: string
Title:
Accounting Event Status
Maximum Length:3
Default Value:I
The accounting event status. The status indicates whether this fee has been sent to the accounting event transaction table or not. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the public sector agency to which this fee record belongs. -
AssessedDate: string
(date)
Title:
Assessed Date
The date when the set value of the fee is calculated. -
BillType: string
Title:
Bill Type
Maximum Length:15
The bill type associated with the fee record. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
The currency code. -
DepartmentId: string
Title:
Department
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: integer
(int64)
The accounting event identifier for the fee record.
-
FeeAmount: number
Title:
Amount
The fee amount. -
FeeItemId: string
Title:
Fee Item
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: string
Title:
Memo
Maximum Length:200
The text field where the agency staff can enter a comment or memo regarding the fee. -
FeeQuantity: number
Title:
Fee Quantity
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: integer
(int64)
Title:
Fee Record
The unique identifier of the fee record. -
FeeReferenceKey: integer
(int64)
The parent fee transaction record.
-
FeeScheduleId: string
Title:
Fee Schedule
Maximum Length:20
The unique identifier of the fee schedule. -
FeeScheduleLine: integer
(int64)
Title:
Fee Items
The line number of the current fee schedule. -
FeeSource: string
Title:
Source
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: string
Title:
Status
Maximum Length:6
The status of the fee record. -
Invoice: string
Title:
Invoice
Maximum Length:50
The invoice number that comes from the billing service. -
InvoiceLine: integer
(int64)
Title:
Invoice Line
The invoice line that comes from the billing service. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The logical record identifier of the parent. -
LnpRecordKey: integer
(int64)
The unique identifier of the record with the parent ID of the fee record.
-
PaymentDate: string
(date-time)
Title:
Payment Date
The date when the fee was paid. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
The payment method used. This information comes from the payment service. -
PaymentReferenceId: string
Title:
Payment Reference
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: string
Title:
Receipt
Maximum Length:50
The receipt number that comes from the billing service. -
RefundedAmount: number
The total amount refunded for the fee item.
-
RefundedCurrencyCode: string
Maximum Length:
3
The currency code for the refund. -
RefundReason: string
Maximum Length:
30
The reason for the refund. -
ReversalReason: string
Maximum Length:
30
The reason for the reversal. -
RevrecDateOption: string
Title:
Revenue Recognition Date
Maximum Length:30
The revenue recognition accounting date option from the common fee item table for the selected fee item.
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.