Jump to

• Request
• Response

Create

post

/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/TaxDetails

Request

Path Parameters

• LnpRecordKey(required): integer(int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning and is determined by the classification.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

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
• AdmissionCharge: number
  Title: Total Admission Charged
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1
• BlTaxDetailKey: integer (int64)
• BlTaxdetailPuid: string
  Maximum Length: 480
• CommercialUnitSquareFootage: number
  Title: Square Foot Area of Commercial Rental Units
• EstimatedGross: number
  Title: Estimated Gross Receipts
• FullTimeEmployeeCount: number
  Title: Number of Employees
• HotelFees: number
  Title: Total Lodging Occupancy Taxes Collected
• LnpRecordId: string
  Maximum Length: 50
• LnpRecordKey: integer (int64)
• LnpRecordPuid: string
  Maximum Length: 480

  Default Value:
• ResidentialUnitCount: number
  Title: Number of Residential Rental Units
• TaxClassCode: string
  Title: ID

  Maximum Length: 50
• VehicleCount: number
  Title: Number of Vehicles Used Monthly

{
    "type":"object",
    "properties":{
        "HotelFees":{
            "title":"Total Lodging Occupancy Taxes Collected",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "VehicleCount":{
            "title":"Number of Vehicles Used Monthly",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FullTimeEmployeeCount":{
            "title":"Number of Employees",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "BlTaxDetailKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EstimatedGross":{
            "title":"Estimated Gross Receipts",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AdmissionCharge":{
            "title":"Total Admission Charged",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "LnpRecordKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "BlTaxdetailPuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false
        },
        "TaxClassCode":{
            "title":"ID",
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "LnpRecordPuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false,
            "default":" "
        },
        "CommercialUnitSquareFootage":{
            "title":"Square Foot Area of Commercial Rental Units",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ResidentialUnitCount":{
            "title":"Number of Residential Rental Units",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ActualGross":{
            "title":"Actual Gross Receipts",
            "type":"number",
            "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 : publicSectorBlRecords-TaxDetails-item-response

Type: object

Show Source

• ActualGross: number
  Title: Actual Gross Receipts
• AdmissionCharge: number
  Title: Total Admission Charged
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1
• BlTaxDetailKey: integer (int64)
• BlTaxdetailPuid: string
  Maximum Length: 480
• CommercialUnitSquareFootage: number
  Title: Square Foot Area of Commercial Rental Units
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 3

  Default Value: USD
• EstimatedGross: number
  Title: Estimated Gross Receipts
• FullTimeEmployeeCount: number
  Title: Number of Employees
• HotelFees: number
  Title: Total Lodging Occupancy Taxes Collected
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Maximum Length: 50
• LnpRecordKey: integer (int64)
• LnpRecordPuid: string
  Maximum Length: 480

  Default Value:
• ReportingPeriod: string
  Title: Reporting Period

  Read Only: true

  Maximum Length: 100

  Default Value: 2020
• ResidentialUnitCount: number
  Title: Number of Residential Rental Units
• TaxClassCode: string
  Title: ID

  Maximum Length: 50
• VehicleCount: number
  Title: Number of Vehicles Used Monthly

{
    "type":"object",
    "properties":{
        "HotelFees":{
            "title":"Total Lodging Occupancy Taxes Collected",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "VehicleCount":{
            "title":"Number of Vehicles Used Monthly",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "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",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BlTaxDetailKey":{
            "type":"integer",
            "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",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "AdmissionCharge":{
            "title":"Total Admission Charged",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BlTaxdetailPuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "TaxClassCode":{
            "title":"ID",
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "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",
            "nullable":false,
            "readOnly":true,
            "default":"2020",
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LnpRecordPuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "CommercialUnitSquareFootage":{
            "title":"Square Foot Area of Commercial Rental Units",
            "type":"number",
            "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",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualGross":{
            "title":"Actual Gross Receipts",
            "type":"number",
            "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