Jump to

• Request
• Response

Get a business tax detail

get

/fscmRestApi/resources/11.13.18.05/publicSectorCalculateBusinessTaxFees/{BlTaxDetailKey}

Request

Path Parameters

• BlTaxDetailKey(required): integer
  The unique identifier of the business tax detail.

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

Type: object

Show Source

• ActualGross: number
  Title: Actual Gross Receipts

  Read Only: true

  The actual reported amount in the business tax detail.
• AdmissionCharge: number
  Title: Total Admission Charged

  Read Only: true

  The admission charge reported in the business tax detail.
• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  The unique identifier of the agency.
• BlTaxDetailKey: integer
  Read Only: true

  The unique identifier of the business tax detail.
• CommercialUnitSquareFootage: number
  Title: Square Foot Area of Commercial Rental Units

  Read Only: true

  The commercial area in square feet reported in the business tax detail.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 3

  The unique identifier of the currency.
• EstimatedGross: number
  Title: Estimated Gross Receipts

  Read Only: true

  The estimated gross amount reported in the business tax detail.
• FullTimeEmployeeCount: number
  Title: Number of Employees

  Read Only: true

  The full time employee count reported in the business tax detail.
• HotelFees: number
  Title: Total Lodging Occupancy Taxes Collected

  Read Only: true

  The hotel fees reported in the business tax detail.
• 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 unique identifier of the business license application.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier of the business license application.
• ReportingPeriod: string
  Title: Reporting Period

  Read Only: true

  Maximum Length: 30

  The reporting period of the business tax detail.
• ResidentialUnitNumber: number
  Title: Number of Residential Rental Units

  Read Only: true

  The number of residential units reported in the business tax detail.
• TaxClassCode: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the tax class.
• VehicleNumber: number
  Title: Number of Vehicles Used Monthly

  Read Only: true

  The number of vehicles reported in the business tax detail.
• VersionType: string
  Title: Version Type

  Read Only: true

  Maximum Length: 1

  The version type of the business license application.

{
    "type":"object",
    "properties":{
        "HotelFees":{
            "title":"Total Lodging Occupancy Taxes Collected",
            "type":"number",
            "description":"The hotel fees reported in the business tax detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the business license application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "FullTimeEmployeeCount":{
            "title":"Number of Employees",
            "type":"number",
            "description":"The full time employee count reported in the business tax detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BlTaxDetailKey":{
            "type":"integer",
            "description":"The unique identifier of the business tax detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedGross":{
            "title":"Estimated Gross Receipts",
            "type":"number",
            "description":"The estimated gross amount reported in the business tax detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmissionCharge":{
            "title":"Total Admission Charged",
            "type":"number",
            "description":"The admission charge reported in the business tax detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the business license application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VersionType":{
            "title":"Version Type",
            "maxLength":1,
            "type":"string",
            "description":"The version type of the business license application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxClassCode":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the tax class.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier of the currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriod":{
            "title":"Reporting Period",
            "maxLength":30,
            "type":"string",
            "description":"The reporting period of the business tax detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResidentialUnitNumber":{
            "title":"Number of Residential Rental Units",
            "type":"number",
            "description":"The number of residential units reported in the business tax detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommercialUnitSquareFootage":{
            "title":"Square Foot Area of Commercial Rental Units",
            "type":"number",
            "description":"The commercial area in square feet reported in the business tax detail.",
            "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"
            }
        },
        "VehicleNumber":{
            "title":"Number of Vehicles Used Monthly",
            "type":"number",
            "description":"The number of vehicles reported in the business tax detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualGross":{
            "title":"Actual Gross Receipts",
            "type":"number",
            "description":"The actual reported amount in the business tax detail.",
            "nullable":true,
            "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