Get all business licenses fees dues
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLicenseFeesDues
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 fee record that matches the specified record keys.
Finder Variables:- FeeRecordKey; integer; The unique identifier for the related transaction.
- LnpRecordKey; integer; The unique identifier for the related transaction.
- PrimaryKey: Finds the fee record that matches the specified record keys.
-
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 identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
- AssessedDate; string; The date when the fee item was assessed.
- DepartmentId; string; This column is used to indicate the department ID.
- Departmentdescription; string; This column is used to indicate the department description.
- DueDate; string; Indicates the business license fee due date.
- FeeAmount; number; This column is used to indicate fee amount.
- FeeCurrencyCode; string; This column is used to indicate currency code.
- FeeDueUpdateDate; string; The date when the fee that is in due status is added or updated.
- FeeItemId; string; The unique identifier for a fee that can be assessed for one or more record types.
- FeeMemo; string; The memo content for the fee item.
- FeeRecordKey; integer; This attribute is used to indicate fee record key.
- Feedescription; string; The description of the fee item.
- Feestatus; string; Indicates the status of the fee item.
- Invoice; string; This column is used to identify the invoice.
- InvoiceLine; integer; This column is used to identify the invoice line.
- LicensePeriod; string; This attribute indicates the period that applies to the transaction.
- LnpRecordId; string; The identifier for the permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029.
- LnpRecordKey; integer; This attribute is used to indicate licensing and permitting record key.
- VersionType; string; The version of the business license application.
-
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:
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.
Root Schema : publicSectorBusinessLicenseFeesDues
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 : publicSectorBusinessLicenseFeesDues-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state. -
AssessedDate: string
(date-time)
Title:
Assessed Date
Read Only:true
The date when the fee item was assessed. -
Departmentdescription: string
Title:
Department
Read Only:true
Maximum Length:100
This column is used to indicate the department description. -
DepartmentId: string
Read Only:
true
Maximum Length:30
This column is used to indicate the department ID. -
DueDate: string
(date)
Title:
Due Date
Read Only:true
Indicates the business license fee due date. -
FeeAmount: number
Title:
Amount
Read Only:true
This column is used to indicate fee amount. -
FeeCurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:3
This column is used to indicate currency code. -
Feedescription: string
Title:
Fee Description
Read Only:true
Maximum Length:50
The description of the fee item. -
FeeDueUpdateDate: string
(date-time)
Read Only:
true
The date when the fee that is in due status is added or updated. -
FeeItemId: string
Title:
Fee Item
Read Only:true
Maximum Length:30
The unique identifier for a fee that can be assessed for one or more record types. -
FeeMemo: string
Title:
Memo
Read Only:true
Maximum Length:200
The memo content for the fee item. -
FeeRecordKey: integer
(int64)
Read Only:
true
This attribute is used to indicate fee record key. -
Feestatus: string
Title:
Status
Read Only:true
Maximum Length:80
Indicates the status of the fee item. -
Invoice: string
Title:
Invoice
Read Only:true
Maximum Length:50
This column is used to identify the invoice. -
InvoiceLine: integer
(int64)
Title:
Invoice Line
Read Only:true
This column is used to identify the invoice line. -
LicensePeriod: string
Title:
License Period
Read Only:true
Maximum Length:100
This attribute indicates the period that applies to the transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
Maximum Length:50
The identifier for the permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey: integer
(int64)
Read Only:
true
This attribute is used to indicate licensing and permitting record key. -
VersionType: string
Title:
Version Type
Read Only:true
Maximum Length:1
The version of the business license 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.