Jump to

• Request
• Response

Update a business tax detail

patch

/fscmRestApi/resources/11.13.18.05/publicSectorTaxDetails/{BlTaxDetailKey}

Request

Path Parameters

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

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 ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• ActualGross: number
  Title: Actual Gross Receipts

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

  The admission charge reported in the business tax detail.
• CommercialUnitSquareFootage: number
  Title: Square Foot Area of Commercial Rental Units

  The commercial area in square feet reported in the business tax detail.
• EstimatedGross: number
  Title: Estimated Gross Receipts

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

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

  The hotel fees reported in the business tax detail.
• ResidentialUnitCount: number
  Title: Number of Residential Rental Units

  The number of residential units reported in the business tax detail.
• VehicleCount: number
  Title: Number of Vehicles Used Monthly

  The number of vehicles reported in the business tax detail.

{
    "type":"object",
    "properties":{
        "HotelFees":{
            "title":"Total Lodging Occupancy Taxes Collected",
            "type":"number",
            "description":"The hotel fees reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "VehicleCount":{
            "title":"Number of Vehicles Used Monthly",
            "type":"number",
            "description":"The number of vehicles reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FullTimeEmployeeCount":{
            "title":"Number of Employees",
            "type":"number",
            "description":"The full time employee count reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "EstimatedGross":{
            "title":"Estimated Gross Receipts",
            "type":"number",
            "description":"The estimated gross amount reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AdmissionCharge":{
            "title":"Total Admission Charged",
            "type":"number",
            "description":"The admission charge reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ResidentialUnitCount":{
            "title":"Number of Residential Rental Units",
            "type":"number",
            "description":"The number of residential units reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ActualGross":{
            "title":"Actual Gross Receipts",
            "type":"number",
            "description":"The actual reported amount in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

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

Type: object

Show Source

• ActualGross: number
  Title: Actual Gross Receipts

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

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

  Default Value: 1

  The unique identifier of the agency.
• BlTaxDetailKey: integer (int64)
  The unique identifier of the business tax detail.
• BlTaxdetailPuid: string
  Maximum Length: 480

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

  The commercial area in square feet reported in the business tax detail.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 3

  Default Value: USD

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

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

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

  The hotel fees reported in the business tax detail.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Maximum Length: 50

  The unique identifier of the business license application.
• LnpRecordKey: integer (int64)
  The unique identifier of the business license application.
• LnpRecordPuid: string
  Maximum Length: 480

  Default Value:

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

  Read Only: true

  Maximum Length: 100

  Default Value: 2020

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

  The number of residential units reported in the business tax detail.
• TaxClassCode: string
  Title: ID

  Maximum Length: 50

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

  The number of vehicles reported in the business tax detail.

{
    "type":"object",
    "properties":{
        "HotelFees":{
            "title":"Total Lodging Occupancy Taxes Collected",
            "type":"number",
            "description":"The hotel fees reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the business license application.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "VehicleCount":{
            "title":"Number of Vehicles Used Monthly",
            "type":"number",
            "description":"The number of vehicles reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FullTimeEmployeeCount":{
            "title":"Number of Employees",
            "type":"number",
            "description":"The full time employee count reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BlTaxDetailKey":{
            "type":"integer",
            "description":"The unique identifier of the business tax detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EstimatedGross":{
            "title":"Estimated Gross Receipts",
            "type":"number",
            "description":"The estimated gross amount reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "AdmissionCharge":{
            "title":"Total Admission Charged",
            "type":"number",
            "description":"The admission charge reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the business license application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BlTaxdetailPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique identifier of the migrated business tax detail.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxClassCode":{
            "title":"ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the tax class.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier of the currency.",
            "nullable":false,
            "readOnly":true,
            "default":"USD",
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ReportingPeriod":{
            "title":"Reporting Period",
            "maxLength":100,
            "type":"string",
            "description":"The reporting period of the business tax detail.",
            "nullable":false,
            "readOnly":true,
            "default":"2020",
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LnpRecordPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique identifier of the migrated business license application.",
            "nullable":false,
            "default":" ",
            "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,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResidentialUnitCount":{
            "title":"Number of Residential Rental Units",
            "type":"number",
            "description":"The number of residential units reported in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualGross":{
            "title":"Actual Gross Receipts",
            "type":"number",
            "description":"The actual reported amount in the business tax detail.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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