Get all overdue case fee records

get

/fscmRestApi/resources/11.13.18.05/publicSectorOverdueCaseFees

Request

Query Parameters
  • 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).
  • 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
  • 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 the overdue case fee record that matches the specified search criteria.
      Finder Variables:
      • FeeRecordKey; integer; The unique identifier of the overdue case fee record.
    • findByBRFCriteria: Finds the overdue case fee record that matches the specified search criteria.
      Finder Variables:
      • Caller; string.
      • Criteria; string.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AgencyId; integer; The agency identifier of the overdue case fee record.
    • AssessedDate; string; The assessed date for the overdue case fee record.
    • CaseComplianceDueDate; string; The compliance due date of the case.
    • CaseId; string; The unique identifier of the case.
    • CaseKey; integer; The unique identifier of the case.
    • CaseNoticeId; string; The unique identifier of the case notice associated with the overdue case fee record.
    • CaseOpenCodeReferenceCount; number; The number of open code references associated with the case.
    • CasePriority; string; The priority of the case.
    • CaseStatus; string; The status of the case.
    • CaseSubmitDate; string; The submit date of the case.
    • CurrencyCode; string; The currency code for the overdue case fee record.
    • DaysOverdue; integer; The number of days since the case fee record has been overdue.
    • DaysSinceLateFeeAssessment; integer; The number of days since the late fee for the overdue case fee record has been assessed.
    • DepartmentId; string; The department identifier of the overdue case fee record.
    • DueDate; string; The due date for the overdue case fee record.
    • FeeCodeReferenceCount; integer; The number of open code references associated with the fee.
    • FeeItemId; string; The fee item identifier of the overdue case fee record.
    • FeeMemo; string; The fee comments for the overdue case fee record.
    • FeeQuantity; number; The fee quantity of the overdue case fee record.
    • FeeRecordId; string; The unique identifier of the overdue case fee record.
    • FeeRecordKey; integer; The unique identifier of the overdue case fee record.
    • FeeScheduleId; string; The fee schedule identifier of the overdue case fee record.
    • FeeSource; string; The fee source of the overdue case fee record.
    • FeeStatus; string; The fee status of the overdue case fee record.
    • GeneratedDate; string; The generation date of the case notice associated with the overdue case fee record.
    • IntakeKey; integer; The unique identifier of the intake.
    • IssueSubtypeCode; string; The unique identifier of the issue subtype of the case.
    • IssueSubtypeId; string; The unique identifier of the case subtype issue.
    • IssueTypeId; string; The unique identifier of the issue type of the case.
    • LastUpdateDate; string; The date and time when the row was last updated.
    • LastUpdatedBy; string; The name of the user who last updated the row.
    • NoticeCount; integer; The count of the case notice associated with the overdue case fee record.
    • NoticeSource; string; The source of the case notice associated with the overdue case fee record.
    • NoticeStatus; string; The status of the case notice associated with the overdue case fee record.
    • NoticeTypeCode; string; The notice type code of the case notice associated with the overdue case fee record.
    • ReceivedDate; string; The received date of the case notice associated with the overdue case fee record.
    • TotalFeeAmount; number; The total fee amount for the overdue case fee record.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorOverdueCaseFees
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorOverdueCaseFees-item-response
Type: object
Show Source
Back to Top