Jump to

• Request
• Response

Get all overdue case fee records

get

/fscmRestApi/resources/11.13.18.05/publicSectorOverdueCaseFees

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:
  
  

  • 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.
• 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:
  

  • 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.
  • IssueSubtypeCode; string; The unique identifier of the issue subtype of the case.
  • 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.
• 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 Top

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.

Body ()

Root Schema : publicSectorOverdueCaseFees

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorOverdueCaseFees-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorOverdueCaseFees-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorOverdueCaseFees-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorOverdueCaseFees-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  The agency identifier of the overdue case fee record.
• AssessedDate: string (date-time)
  Title: Assessed Date

  Read Only: true

  The assessed date for the overdue case fee record.
• CaseComplianceDueDate: string (date)
  Title: Case Compliance Date

  Read Only: true

  The compliance due date of the case.
• CaseId: string
  Title: Case ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the case.
• CaseKey: integer (int64)
  Read Only: true

  The unique identifier of the case.
• CaseNoticeId: string
  Title: Notice ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the case notice associated with the overdue case fee record.
• CaseOpenCodeReferenceCount: number
  Title: Case Open Code Violation Count

  Read Only: true

  The number of open code references associated with the case.
• CasePriority: string
  Title: Case Priority

  Read Only: true

  Maximum Length: 30

  The priority of the case.
• CaseStatus: string
  Title: Case Status

  Read Only: true

  Maximum Length: 15

  The status of the case.
• CaseSubmitDate: string (date-time)
  Title: Case Submit Date

  Read Only: true

  The submit date of the case.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 3

  The currency code for the overdue case fee record.
• DaysOverdue: integer
  Title: Number of Days Overdue

  Read Only: true

  The number of days since the case fee record has been overdue.
• DaysSinceLateFeeAssessment: integer
  Title: Number of Days Since Late Fee Assessment

  Read Only: true

  The number of days since the late fee for the overdue case fee record has been assessed.
• DepartmentId: string
  Title: Department ID

  Read Only: true

  Maximum Length: 30

  The department identifier of the overdue case fee record.
• DueDate: string (date)
  Title: Due Date

  Read Only: true

  The due date for the overdue case fee record.
• FeeCodeReferenceCount: integer (int32)
  Title: Fee Open Code Violation Count

  Read Only: true

  The number of open code references associated with the fee.
• FeeItemId: string
  Title: Fee Item

  Read Only: true

  Maximum Length: 30

  The fee item identifier of the overdue case fee record.
• FeeMemo: string
  Title: Comments

  Read Only: true

  Maximum Length: 500

  The fee comments for the overdue case fee record.
• FeeQuantity: number
  Title: Fee Quantity

  Read Only: true

  The fee quantity of the overdue case fee record.
• FeeRecordId: string
  Title: Fee Reference ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the overdue case fee record.
• FeeRecordKey: integer
  Read Only: true

  The unique identifier of the overdue case fee record.
• FeeScheduleId: string
  Title: Fee Schedule ID

  Read Only: true

  Maximum Length: 20

  The fee schedule identifier of the overdue case fee record.
• FeeSource: string
  Title: Fee Source

  Read Only: true

  Maximum Length: 15

  The fee source of the overdue case fee record.
• FeeStatus: string
  Title: Fee Status

  Read Only: true

  Maximum Length: 15

  The fee status of the overdue case fee record.
• GeneratedDate: string (date-time)
  Title: Notice Generated Date

  Read Only: true

  The generation date of the case notice associated with the overdue case fee record.
• IssueSubtypeCode: string
  Title: Issue Subtype Code

  Read Only: true

  Maximum Length: 40

  The unique identifier of the issue subtype of the case.
• IssueTypeId: string
  Title: Issue Type ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the issue type of the case.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoticeCount: integer (int32)
  Title: Fee Notice Count

  Read Only: true

  The count of the case notice associated with the overdue case fee record.
• NoticeSource: string
  Title: Notice Source

  Read Only: true

  Maximum Length: 15

  The source of the case notice associated with the overdue case fee record.
• NoticeStatus: string
  Title: Notice Status

  Read Only: true

  Maximum Length: 15

  The status of the case notice associated with the overdue case fee record.
• NoticeTypeCode: string
  Title: Notice Type Code

  Read Only: true

  Maximum Length: 100

  The notice type code of the case notice associated with the overdue case fee record.
• ReceivedDate: string (date-time)
  Title: Notice Received Date

  Read Only: true

  The received date of the case notice associated with the overdue case fee record.
• TotalFeeAmount: number
  Title: Fee Amount Due

  Read Only: true

  The total fee amount for the overdue case fee record.

{
    "type":"object",
    "properties":{
        "TotalFeeAmount":{
            "title":"Fee Amount Due",
            "type":"number",
            "description":"The total fee amount for the overdue case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeMemo":{
            "title":"Comments",
            "maxLength":500,
            "type":"string",
            "description":"The fee comments for the overdue case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the overdue case fee record.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "NoticeTypeCode":{
            "title":"Notice Type Code",
            "maxLength":100,
            "type":"string",
            "description":"The notice type code of the case notice associated with the overdue case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"The currency code for the overdue case fee record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessedDate":{
            "title":"Assessed Date",
            "type":"string",
            "description":"The assessed date for the overdue case fee record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item",
            "maxLength":30,
            "type":"string",
            "description":"The fee item identifier of the overdue case fee record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CasePriority":{
            "title":"Case Priority",
            "maxLength":30,
            "type":"string",
            "description":"The priority of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeQuantity":{
            "title":"Fee Quantity",
            "type":"number",
            "description":"The fee quantity of the overdue case fee record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeCodeReferenceCount":{
            "title":"Fee Open Code Violation Count",
            "type":"integer",
            "description":"The number of open code references associated with the fee.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "DaysOverdue":{
            "title":"Number of Days Overdue",
            "type":"integer",
            "description":"The number of days since the case fee record has been overdue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysSinceLateFeeAssessment":{
            "title":"Number of Days Since Late Fee Assessment",
            "type":"integer",
            "description":"The number of days since the late fee for the overdue case fee record has been assessed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IssueSubtypeCode":{
            "title":"Issue Subtype Code",
            "maxLength":40,
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeScheduleId":{
            "title":"Fee Schedule ID",
            "maxLength":20,
            "type":"string",
            "description":"The fee schedule identifier of the overdue case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The due date for the overdue case fee record.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoticeCount":{
            "title":"Fee Notice Count",
            "type":"integer",
            "description":"The count of the case notice associated with the overdue case fee record.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CaseOpenCodeReferenceCount":{
            "title":"Case Open Code Violation Count",
            "type":"number",
            "description":"The number of open code references associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "title":"Issue Type ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the issue type of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeRecordId":{
            "title":"Fee Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the overdue case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeStatus":{
            "title":"Fee Status",
            "maxLength":15,
            "type":"string",
            "description":"The fee status of the overdue case fee record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseSubmitDate":{
            "title":"Case Submit Date",
            "type":"string",
            "description":"The submit date of the case.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoticeSource":{
            "title":"Notice Source",
            "maxLength":15,
            "type":"string",
            "description":"The source of the case notice associated with the overdue case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedDate":{
            "title":"Notice Received Date",
            "type":"string",
            "description":"The received date of the case notice associated with the overdue case fee record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoticeStatus":{
            "title":"Notice Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the case notice associated with the overdue case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeSource":{
            "title":"Fee Source",
            "maxLength":15,
            "type":"string",
            "description":"The fee source of the overdue case fee record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseComplianceDueDate":{
            "title":"Case Compliance Date",
            "type":"string",
            "description":"The compliance due date of the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseStatus":{
            "title":"Case Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseNoticeId":{
            "title":"Notice ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case notice associated with the overdue case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the overdue case fee record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"1"
            },
            "x-queryable":true
        },
        "GeneratedDate":{
            "title":"Notice Generated Date",
            "type":"string",
            "description":"The generation date of the case notice associated with the overdue case fee record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department ID",
            "maxLength":30,
            "type":"string",
            "description":"The department identifier of the overdue case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top