Jump to

• Request
• Response

Create a set of business tax class columns

post

/fscmRestApi/resources/11.13.18.05/publicSectorTaxClassColumns

Request

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

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

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 50

  The business tax class column name.
• Description: string
  Title: Description

  Maximum Length: 500

  The description of the tax class column.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the tax class column is available for use.
• OriginalFlag: boolean
  Title: Origination

  Maximum Length: 1

  Default Value: true

  Indicates whether the tax class column is applicable for an original application.
• RenewalFlag: boolean
  Title: Renewal

  Maximum Length: 1

  Default Value: false

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

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

  Maximum Length: 50

  The unique identifier of the business tax class.
• TimelineFlag: boolean
  Title: Include in Timeline

  Maximum Length: 1

  Default Value: false

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

{
    "type":"object",
    "properties":{
        "ColumnName":{
            "title":"Tax Attribute",
            "maxLength":50,
            "type":"string",
            "description":"The business tax class column name.",
            "nullable":false
        },
        "TimelineFlag":{
            "title":"Include in Timeline",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax class column should be displayed in the timeline view.",
            "nullable":false,
            "default":false
        },
        "Description":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The description of the tax class column.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence in which the tax class column is displayed.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "OriginalFlag":{
            "title":"Origination",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax class column is applicable for an original application.",
            "nullable":false,
            "default":true
        },
        "RenewalFlag":{
            "title":"Renewal",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax class column is applicable for a renewal application.",
            "nullable":false,
            "default":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax class column is available for use.",
            "nullable":false,
            "default":true
        },
        "TaxClassCode":{
            "title":"ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the business tax class.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 50

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

  Read Only: true

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

  Maximum Length: 500

  The description of the tax class column.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the tax class column is available for use.
• 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.
• OriginalFlag: boolean
  Title: Origination

  Maximum Length: 1

  Default Value: true

  Indicates whether the tax class column is applicable for an original application.
• RenewalFlag: boolean
  Title: Renewal

  Maximum Length: 1

  Default Value: false

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

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

  Maximum Length: 50

  The unique identifier of the business tax class.
• TimelineFlag: boolean
  Title: Include in Timeline

  Maximum Length: 1

  Default Value: false

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

{
    "type":"object",
    "properties":{
        "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
        },
        "ColumnName":{
            "title":"Tax Attribute",
            "maxLength":50,
            "type":"string",
            "description":"The business tax class column name.",
            "nullable":false,
            "x-queryable":true
        },
        "TimelineFlag":{
            "title":"Include in Timeline",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax class column should be displayed in the timeline view.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The description of the tax class column.",
            "nullable":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
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence in which the tax class column is displayed.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "OriginalFlag":{
            "title":"Origination",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax class column is applicable for an original application.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RenewalFlag":{
            "title":"Renewal",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax class column is applicable for a renewal application.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax class column is available for use.",
            "nullable":false,
            "default":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
        },
        "TaxClassCode":{
            "title":"ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the business tax class.",
            "nullable":false,
            "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