Get a record fee summary
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewFees/{publicSectorRecordOverviewFeesUniqID}
Request
Path Parameters
-
publicSectorRecordOverviewFeesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LnpRecordKey and LnpRecordId ---for the Summary of Fees resource and used to uniquely identify an instance of Summary of Fees. The client should not generate the hash key value. Instead, the client should query on the Summary of Fees collection resource with a filter on the primary key values in order to navigate to a specific instance of Summary of Fees.
For example: publicSectorRecordOverviewFees?q=LnpRecordKey=<value1>;LnpRecordId=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorRecordOverviewFees-item-response
Type:
Show Source
object
-
BalanceDue: number
Title:
Fees Balance Due
Read Only:true
The balance due for the record. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:3
The default currency code for the fee schedule. -
LastPayment: number
Title:
Last Payment
Read Only:true
The total amount of the last payment. -
LastPaymentDate: string
(date-time)
Title:
Last Payment Date
Read Only:true
The date of the last payment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Read Only:true
Maximum Length:50
The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey: integer
Title:
Application
Read Only:true
The key of one record. -
Total: number
Title:
Fees Total Amount
Read Only:true
The sum of fee amounts for the record. -
TotalCanceled: number
Title:
Fees Canceled
Read Only:true
Indicates the total fees canceled for an application. -
TotalDue: number
Title:
Total Due
Read Only:true
The sum of fee amounts for the record, with the fee status as due. -
TotalHold: number
Title:
Fees on Hold
Read Only:true
Indicates the total fees on hold for an application. -
TotalOutstanding: number
Title:
Fees Outstanding Balance
Read Only:true
Indicates the total fees outstanding for an application. -
TotalPaid: number
Title:
Fees Total Paid
Read Only:true
The sum of fee amounts for the record, with the fee status as paid. -
TotalPayable: number
Title:
Fees Total Payable
Read Only:true
The sum of fee amounts for the record, with the fee status as payable. -
TotalPaymentsInProcess: number
Title:
Total Payments in Process
Read Only:true
The total fee amount that is processing through the payment service. -
TotalPending: number
Title:
Fees in Pending Status
Read Only:true
Indicates the total fees pending for an application. -
TotalWaived: number
Title:
Fees Waived
Read Only:true
Indicates the total fees waived off for an application.
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.