Jump to

• Request
• Response

Update a fee record summary by activity

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRecordFeeSummaryByActivities/{LnpRecordKey}

Request

Path Parameters

• LnpRecordKey(required): integer
  The unique identifier for the record.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : publicSectorRecordFeeSummaryByActivities-item-response

Type: object

Show Source

• Activity: string
  Title: Activity

  Read Only: true

  Maximum Length: 80

  The activity state of an application. For example, activity can be Origination, Renewal or Amendment.
• ActivityStatus: string
  Title: Activity Status

  Read Only: true

  Maximum Length: 80

  The status of activity of an application.
• AttributeCategory: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the record type.
• CreationDate: string (date-time)
  Read Only: true

  The date when the fee record was created.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 3

  The default currency code for the fee schedule.
• LicensePeriod: string
  Title: License Period

  Read Only: true

  Maximum Length: 100

  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 building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for the record.
• Total: number
  Title: Total Fees

  Read Only: true

  The sum of fee amounts for the record.
• TotalDue: number
  Title: Balance Due

  Read Only: true

  The sum of fee amounts for the record, with the fee status as due.
• TotalEstimated: number
  Read Only: true

  Indicated the total fees estimated for the application.
• TotalInReview: number
  Title: In Review

  Read Only: true

  The sum of fee amounts for a record that are in Pending or Hold statuses.
• TotalNotPayable: number
  Title: Not Payable

  Read Only: true

  The sum of fee amounts for a record that are in Waived or Cancelled statuses.
• TotalPaid: number
  Title: Fees Paid

  Read Only: true

  The sum of fee amounts for the record, with the fee status as paid.
• TotalPayable: number
  Read Only: true

  The sum of fee amounts for the record, with the fee status as payable.
• TotalPaymentsInProcess: number
  Read Only: true

  The total fee amount that is processing through the payment service.

{
    "type":"object",
    "properties":{
        "LnpRecordId":{
            "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
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the fee record was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityStatus":{
            "title":"Activity Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of activity of an application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalDue":{
            "title":"Balance 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
        },
        "TotalNotPayable":{
            "title":"Not Payable",
            "type":"number",
            "description":"The sum of fee amounts for a record that are in Waived or Cancelled statuses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalEstimated":{
            "type":"number",
            "description":"Indicated the total fees estimated for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaymentsInProcess":{
            "type":"number",
            "description":"The total fee amount that is processing through the payment service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Activity":{
            "title":"Activity",
            "maxLength":80,
            "type":"string",
            "description":"The activity state of an application. For example, activity can be Origination, Renewal or Amendment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPayable":{
            "type":"number",
            "description":"The sum of fee amounts for the record, with the fee status as payable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalInReview":{
            "title":"In Review",
            "type":"number",
            "description":"The sum of fee amounts for a record that are in Pending or Hold statuses.",
            "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
        },
        "Total":{
            "title":"Total Fees",
            "type":"number",
            "description":"The sum of fee amounts for the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Fees 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
        },
        "LicensePeriod":{
            "title":"License Period",
            "maxLength":100,
            "type":"string",
            "description":"The period that applies to the transaction.",
            "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