Jump to

• Request
• Response

Update a business tax class

patch

/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses/{publicSectorTaxClassesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorTaxClassesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and TaxClassCode ---for the Business Tax Classes resource and used to uniquely identify an instance of Business Tax Classes. The client should not generate the hash key value. Instead, the client should query on the Business Tax Classes collection resource with a filter on the primary key values in order to navigate to a specific instance of Business Tax Classes.
  
  For example: publicSectorTaxClasses?q=AgencyId=<value1>;TaxClassCode=<value2>

Body ()

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

Root Schema : publicSectorTaxClasses-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The description of the tax class.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the tax class is available for use.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• TaxClassCode(optional): string
  Title: ID

  Maximum Length: 50

  The unique identifier of the business tax class.
• TaxClassColumns(optional): array Business Tax Class Columns
  Title: Business Tax Class Columns

  The business tax class column resource is used to view, create, or modify a business tax class column.
• TaxClassName(optional): string
  Title: Name

  Maximum Length: 200

  The name of the business tax class.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The description of the tax class.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "TaxClassCode":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the business tax class.",
            "title":"ID"
        },
        "TaxClassColumns":{
            "items":{
                "$ref":"#/definitions/publicSectorTaxClasses-TaxClassColumns-item"
            },
            "type":"array",
            "description":"The business tax class column resource is used to view, create, or modify a business tax class column.",
            "title":"Business Tax Class Columns"
        },
        "TaxClassName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the business tax class.",
            "title":"Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Business Tax Class Columns

Type: array

Title: Business Tax Class Columns

The business tax class column resource is used to view, create, or modify a business tax class column.

Show Source

• Array of: object publicSectorTaxClasses-TaxClassColumns-item

{
    "items":{
        "$ref":"#/definitions/publicSectorTaxClasses-TaxClassColumns-item"
    },
    "type":"array",
    "description":"The business tax class column resource is used to view, create, or modify a business tax class column.",
    "title":"Business Tax Class Columns"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorTaxClasses-TaxClassColumns-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• ColumnName(optional): string
  Title: Tax Attribute

  Maximum Length: 50

  The business tax class column name.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The description of the tax class column.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the tax class column is available for use.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• OriginalFlag(optional): string
  Title: Origination

  Maximum Length: 1

  Indicates whether the tax class column is applicable for an original application.
• RenewalFlag(optional): string
  Title: Renewal

  Maximum Length: 1

  Indicates whether the tax class column is applicable for a renewal application.
• SequenceNumber(optional): integer(int32)
  Title: Sequence Number

  The sequence in which the tax class column is displayed.
• TaxClassCode(optional): string
  Title: ID

  Maximum Length: 50

  The unique identifier of the business tax class.
• TimelineFlag(optional): string
  Title: Include in Timeline

  Maximum Length: 1

  Indicates whether the tax class column should be displayed in the timeline view.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "ColumnName":{
            "maxLength":50,
            "type":"string",
            "description":"The business tax class column name.",
            "title":"Tax Attribute"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The description of the tax class column.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class column is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "OriginalFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class column is applicable for an original application.",
            "title":"Origination"
        },
        "RenewalFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class column is applicable for a renewal application.",
            "title":"Renewal"
        },
        "SequenceNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence in which the tax class column is displayed.",
            "title":"Sequence Number"
        },
        "TaxClassCode":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the business tax class.",
            "title":"ID"
        },
        "TimelineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class column should be displayed in the timeline view.",
            "title":"Include in Timeline"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorTaxClasses-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The description of the tax class.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the tax class is available for use.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• TaxClassCode(optional): string
  Title: ID

  Maximum Length: 50

  The unique identifier of the business tax class.
• TaxClassColumns(optional): array Business Tax Class Columns
  Title: Business Tax Class Columns

  The business tax class column resource is used to view, create, or modify a business tax class column.
• TaxClassName(optional): string
  Title: Name

  Maximum Length: 200

  The name of the business tax class.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The description of the tax class.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "TaxClassCode":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the business tax class.",
            "title":"ID"
        },
        "TaxClassColumns":{
            "items":{
                "$ref":"#/definitions/publicSectorTaxClasses-TaxClassColumns-item"
            },
            "type":"array",
            "description":"The business tax class column resource is used to view, create, or modify a business tax class column.",
            "title":"Business Tax Class Columns"
        },
        "TaxClassName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the business tax class.",
            "title":"Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Business Tax Class Columns

Type: array

Title: Business Tax Class Columns

The business tax class column resource is used to view, create, or modify a business tax class column.

Show Source

• Array of: object publicSectorTaxClasses-TaxClassColumns-item

{
    "items":{
        "$ref":"#/definitions/publicSectorTaxClasses-TaxClassColumns-item"
    },
    "type":"array",
    "description":"The business tax class column resource is used to view, create, or modify a business tax class column.",
    "title":"Business Tax Class Columns"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorTaxClasses-TaxClassColumns-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• ColumnName(optional): string
  Title: Tax Attribute

  Maximum Length: 50

  The business tax class column name.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The description of the tax class column.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the tax class column is available for use.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• OriginalFlag(optional): string
  Title: Origination

  Maximum Length: 1

  Indicates whether the tax class column is applicable for an original application.
• RenewalFlag(optional): string
  Title: Renewal

  Maximum Length: 1

  Indicates whether the tax class column is applicable for a renewal application.
• SequenceNumber(optional): integer(int32)
  Title: Sequence Number

  The sequence in which the tax class column is displayed.
• TaxClassCode(optional): string
  Title: ID

  Maximum Length: 50

  The unique identifier of the business tax class.
• TimelineFlag(optional): string
  Title: Include in Timeline

  Maximum Length: 1

  Indicates whether the tax class column should be displayed in the timeline view.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "ColumnName":{
            "maxLength":50,
            "type":"string",
            "description":"The business tax class column name.",
            "title":"Tax Attribute"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The description of the tax class column.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class column is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "OriginalFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class column is applicable for an original application.",
            "title":"Origination"
        },
        "RenewalFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class column is applicable for a renewal application.",
            "title":"Renewal"
        },
        "SequenceNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence in which the tax class column is displayed.",
            "title":"Sequence Number"
        },
        "TaxClassCode":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the business tax class.",
            "title":"ID"
        },
        "TimelineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the tax class column should be displayed in the timeline view.",
            "title":"Include in Timeline"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top