Create a set of business tax classes
post
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses
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:
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
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
Description: string
Title:
Description
Maximum Length:500
The description of the tax class. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the tax class is available for use. -
TaxClassCode(required): string
Title:
ID
Maximum Length:50
The unique identifier of the business tax class. -
TaxClassColumns: 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(required): string
Title:
Name
Maximum Length:200
The name of the business tax class.
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
Nested Schema : publicSectorTaxClasses-TaxClassColumns-item-post-request
Type:
Show Source
object
-
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.
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.
Root Schema : publicSectorTaxClasses-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
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. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the tax class 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. -
TaxClassCode: string
Title:
ID
Maximum Length:50
The unique identifier of the business tax class. -
TaxClassColumns: 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: string
Title:
Name
Maximum Length:200
The name of the business tax class.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorTaxClasses-TaxClassColumns-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- TaxClassColumns
-
Parameters:
- publicSectorTaxClassesUniqID:
$request.path.publicSectorTaxClassesUniqID
The business tax class column resource is used to view, create, or modify a business tax class column. - publicSectorTaxClassesUniqID: