Get all fee records
get
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords
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:- FeeRecordsPUIDKey: This is an alternate key finder, which is used to identify the fee record other than the primary key.
Finder Variables:- FeeRecordPuid; string; This is a bind variable of the finder FeeRecordsPUIDKey, which is used to uniquely identify the fee record.
- PrimaryKey: Finds a fee record using the specified primary key.
Finder Variables:- FeeRecordKey; integer; The unique identifier for fee record.
- searchByLnpRecordId: Finds a fee record using the specified record identifier.
Finder Variables:- lnpRecord; string; The unique identifier for the fee record.
- FeeRecordsPUIDKey: This is an alternate key finder, which is used to identify the fee record other than the primary key.
-
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:- AccountingDate; string; The accounting date for the fee record.
- AccountingEventStatus; string; The accounting event status. The status indicates whether this fee has been sent to the accounting event transaction table or not.
- AgencyId; integer; The identifier for the public sector agency to which this fee record belongs.
- AssessedDate; string; The date when the set value of the fee is calculated.
- BillType; string; The bill type associated with the fee record.
- CreationDate; string; The date when the fee record was created.
- CurrencyCode; string; The currency code.
- DepartmentId; string; The department ID specified at the fee item level. If not specified at the fee item level, the department specified on the record type is used.
- DueDate; string; The date by which the fee should be paid.
- EventId; integer; The accounting event identifier for the fee record.
- FeeAmount; number; The fee amount.
- FeeItemId; string; 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; The text field where the agency staff can enter a comment or memo regarding the fee.
- FeeQuantity; number; The number of fees. This value is always 1, but may be used in the future for multiple fees of the same type.
- FeeRecordKey; integer; The unique identifier for fee record.
- FeeRecordPuid; string; This column represents a functional key of the transaction data to uniquely identify the fee transaction row during data migration.
- FeeScheduleId; string; The unique identifier for the fee schedule.
- FeeScheduleLine; integer; The line number for the current fee schedule.
- FeeSource; string; The source of the fee. The source indicates that the fee was created either by the system or a user.
- FeeStatus; string; The status of the fee record.
- Invoice; string; The invoice number that comes from the billing service.
- InvoiceLine; integer; The invoice line that comes from the billing service.
- LastUpdateDate; string; The date when the fee record was last updated.
- LicensePeriod; string; The period that applies to the transaction.
- LnpRecordKey; integer; The unique identifier for the record with the parent ID of the fee record.
- MappingSource; string; Indicates the feature that requires fee attribute mapping.
- PaymentDate; string; The date when the fee was paid. The timestamp comes from the payment service.
- PaymentMethodCode; string; The payment method used. This information comes from the payment service.
- PaymentReferenceId; string; 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; The receipt number that comes from the billing service.
- RecordNumber; string; The parent record number for the data migration transaction.
- RefundedAmount; number; The total amount refunded for the fee item.
- RefundedCurrencyCode; string; The currency code for the refund.
- ReversalReason; string; The reason for the reversal.
- ReversedAmount; number; The total amount reversed for the fee item.
- ReversedCurrencyCode; string; The currency code for the reversal.
- RevrecDateOption; string; The revenue recognition accounting date option from the common fee item table for the selected fee item.
- SearchId; string; The search identifier for the fee record.
-
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 : publicSectorFeeRecords
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 : publicSectorFeeRecords-item-response
Type:
Show Source
object
-
AccountingDate: string
(date)
The accounting date for the fee record.
-
AccountingEventStatus: 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 for 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. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the fee record was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
The currency code. -
DepartmentId: string
Title:
Department
Maximum Length:30
The department ID specified at the fee item level. If not specified at the fee item level, the department specified on the record type is used. -
DueDate: string
(date)
Title:
Due Date
The date by which the fee should be paid. -
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 fees. This value is always 1, but may be used in the future for multiple fees of the same type. -
FeeRecordKey: integer
(int64)
Title:
Fee Record
The unique identifier for fee record. -
FeeRecordPuid: string
Maximum Length:
480
This column represents a functional key of the transaction data to uniquely identify the fee transaction row during data migration. -
FeeScheduleId: string
Title:
Fee Schedule
Maximum Length:20
The unique identifier for the fee schedule. -
FeeScheduleLine: integer
(int64)
Title:
Fee Items
The line number for 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 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. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the fee record was last updated. -
LicensePeriod: string
Maximum Length:
100
The period that applies to the transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
The unique identifier for the record with the parent ID of the fee record.
-
MappingSource: string
Title:
Mapping Source
Maximum Length:10
Indicates the feature that requires fee attribute mapping. -
PaymentDate: string
(date-time)
Title:
Payment Date
The date when the fee was paid. The timestamp comes from the payment service. -
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. -
RecordNumber: string
Maximum Length:
64
The parent record number for the data migration transaction. -
RefundedAmount: number
The total amount refunded for the fee item.
-
RefundedCurrencyCode: string
Maximum Length:
3
The currency code for the refund. -
ReversalReason: string
Maximum Length:
30
The reason for the reversal. -
ReversedAmount: number
The total amount reversed for the fee item.
-
ReversedCurrencyCode: string
Maximum Length:
3
The currency code 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. -
SearchId: string
Maximum Length:
50
The search identifier for the fee record.
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.
Links
- calculateFees
-
Calculates fees based on values entered by the user on an intake form. It is display-only. The final fee charges are calculated after form submission.
- confirmPayment
-
Used by the payment service to execute callback application logic after payment.
- initExtFeeProcessing
-
Used to initiate external payment processing for fee items.
- initiateWorkflow
-
Initiate the workflow when there are no due fees to be paid.
- payNow
-
An agency user pays the fee directly on behalf of the applicant without accessing the applicant's payment cart.