Jump to

• Request
• Response

Get all record fee summaries

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewFees

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 a record fee summary using the specified key.
    Finder Variables:
    • LnpRecordId; string; The unique identifier for the permit.
    • LnpRecordKey; integer; The unique identifier for a record.
• 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:
  

  • BalanceDue; number; The balance due for the record.
  • CurrencyCode; string; The default currency code for the fee schedule.
  • LastPayment; number; The total amount of the last payment.
  • LastPaymentDate; string; The date of the last payment.
  • LnpRecordId; string; 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; The key of one record.
  • Total; number; The sum of fee amounts for the record.
  • TotalCanceled; number; Indicates the total fees canceled for an application.
  • TotalDue; number; The sum of fee amounts for the record, with the fee status as due.
  • TotalEstimated; number; Indicates the total fees estimated for an application.
  • TotalHold; number; Indicates the total fees on hold for an application.
  • TotalInReview; number; Indicates the total fees which are in review.
  • TotalNotPayable; number; Indicates the total fees which are not payable.
  • TotalOutstanding; number; Indicates the total fees outstanding for an application.
  • TotalPaid; number; The sum of fee amounts for the record, with the fee status as paid.
  • TotalPayable; number; The sum of fee amounts for the record, with the fee status as payable.
  • TotalPaymentsInProcess; number; The total fee amount that is processing through the payment service.
  • TotalPending; number; Indicates the total fees pending for an application.
  • TotalWaived; number; Indicates the total fees waived off for an 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: string
  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: string
  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:
  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.

Body ()

Root Schema : publicSectorRecordOverviewFees

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordOverviewFees-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorRecordOverviewFees-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordOverviewFees-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 : publicSectorRecordOverviewFees-item-response

Type: object

Show Source

• 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.
• TotalEstimated: number
  Title: Total Estimated Fees

  Read Only: true

  Indicates the total fees estimated for an application.
• TotalHold: number
  Title: Fees on Hold

  Read Only: true

  Indicates the total fees on hold for an application.
• TotalInReview: number
  Title: In Review

  Read Only: true

  Indicates the total fees which are in review.
• TotalNotPayable: number
  Title: Not Payable

  Read Only: true

  Indicates the total fees which are not payable.
• 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.

{
    "type":"object",
    "properties":{
        "BalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The balance due for the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"The default currency code for the fee schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastPayment":{
            "title":"Last Payment",
            "type":"number",
            "description":"The total amount of the last payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastPaymentDate":{
            "title":"Last Payment Date",
            "type":"string",
            "description":"The date of the last payment.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "description":"The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Application",
            "type":"integer",
            "description":"The key of one record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Total":{
            "title":"Fees Total Amount",
            "type":"number",
            "description":"The sum of fee amounts for the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalCanceled":{
            "title":"Fees Canceled",
            "type":"number",
            "description":"Indicates the total fees canceled for an application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalDue":{
            "title":"Total Due",
            "type":"number",
            "description":"The sum of fee amounts for the record, with the fee status as due.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalEstimated":{
            "title":"Total Estimated Fees",
            "type":"number",
            "description":"Indicates the total fees estimated for an application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalHold":{
            "title":"Fees on Hold",
            "type":"number",
            "description":"Indicates the total fees on hold for an application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalInReview":{
            "title":"In Review",
            "type":"number",
            "description":"Indicates the total fees which are in review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalNotPayable":{
            "title":"Not Payable",
            "type":"number",
            "description":"Indicates the total fees which are not payable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalOutstanding":{
            "title":"Fees Outstanding Balance",
            "type":"number",
            "description":"Indicates the total fees outstanding for an application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Fees Total Paid",
            "type":"number",
            "description":"The sum of fee amounts for the record, with the fee status as paid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPayable":{
            "title":"Fees Total Payable",
            "type":"number",
            "description":"The sum of fee amounts for the record, with the fee status as payable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaymentsInProcess":{
            "title":"Total Payments in Process",
            "type":"number",
            "description":"The total fee amount that is processing through the payment service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPending":{
            "title":"Fees in Pending Status",
            "type":"number",
            "description":"Indicates the total fees pending for an application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalWaived":{
            "title":"Fees Waived",
            "type":"number",
            "description":"Indicates the total fees waived off for an application.",
            "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"
            }
        }
    }
}

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