Jump to

• Request
• Response

Get a tax calculation statements tax type record

get

/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/TaxCalculationStatementTaxTypes/{TaxCalculationStatementTaxTypesUniqID}

Request

Path Parameters

• ObjectActionId(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• TaxCalculationStatementTaxTypesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PayrollRelationshipActionId, GroupOneCode, GroupTwoCode, TaxTypeCode and TaxSubTypeCode ---for the Person Process Results Tax Calculation Statement Tax Types resource and used to uniquely identify an instance of Person Process Results Tax Calculation Statement Tax Types. The client should not generate the hash key value. Instead, the client should query on the Person Process Results Tax Calculation Statement Tax Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Person Process Results Tax Calculation Statement Tax Types.
  
  For example: TaxCalculationStatementTaxTypes?q=PayrollRelationshipActionId=<value1>;GroupOneCode=<value2>;GroupTwoCode=<value3>;TaxTypeCode=<value4>;TaxSubTypeCode=<value5>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : personProcessResults-TaxCalculationStatementTaxTypes-item-response

Type: object

Show Source

• CurrencyCode: string
  Read Only: true

  Maximum Length: 20

  Currency code for tax calculation statements tax type record.
• GroupOneCode: string
  Read Only: true

  Maximum Length: 50

  Group one code for tax calculation statements tax type record.
• GroupOneLabel: string
  Read Only: true

  Maximum Length: 150

  Group one label for tax calculation statements tax type record.
• GroupOneMeaning: string
  Read Only: true

  Maximum Length: 150

  Group one meaning for tax calculation statements tax type record.
• GroupTwoCode: string
  Read Only: true

  Maximum Length: 50

  Group two code for tax calculation statements tax type record.
• GroupTwoLabel: string
  Read Only: true

  Maximum Length: 150

  Group two label for tax calculation statements tax type record.
• GroupTwoMeaning: string
  Read Only: true

  Maximum Length: 150

  Group two meaning for tax calculation statements tax type record.
• LegislationCode: string
  Read Only: true

  Maximum Length: 30

  Legislation code for tax calculation statements tax type record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayrollRelationshipActionId: number
  Read Only: true

  Payroll relationship action identifier for tax calculation statements tax type record.
• SolutionType: string
  Read Only: true

  Maximum Length: 100

  Solution type for tax calculation statements tax type record.
• TaxCalculationStatementResults: array Person Process Results Tax Calculation Statement Tax Results
  Title: Person Process Results Tax Calculation Statement Tax Results

  The TaxCalculationResults resource, includes all the tax calculation statements calculation results.
• TaxCalculationStatementSteps: array Person Process Results Tax Calculation Statement Tax Steps
  Title: Person Process Results Tax Calculation Statement Tax Steps

  The TaxCalculationSteps resource, includes all the tax calculation statements calculation steps.
• TaxCalculationStatementSummary: array Person Process Results Tax Calculation Statement Calculation Summary
  Title: Person Process Results Tax Calculation Statement Calculation Summary

  The TaxCalculationSummary resource, includes all the tax calculation statements calculation summary.
• TaxSubType: string
  Read Only: true

  Maximum Length: 150

  Tax subtype for tax calculation statements tax type record.
• TaxSubTypeCode: string
  Read Only: true

  Maximum Length: 50

  Tax subtype code for tax calculation statements tax type record.
• TaxType: string
  Read Only: true

  Maximum Length: 150

  Tax type for tax calculation statements tax type record.
• TaxTypeCode: string
  Read Only: true

  Maximum Length: 50

  Tax type code for tax calculation statements tax type record.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "maxLength":20,
            "type":"string",
            "description":"Currency code for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupOneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Group one code for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupOneLabel":{
            "maxLength":150,
            "type":"string",
            "description":"Group one label for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupOneMeaning":{
            "maxLength":150,
            "type":"string",
            "description":"Group one meaning for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupTwoCode":{
            "maxLength":50,
            "type":"string",
            "description":"Group two code for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupTwoLabel":{
            "maxLength":150,
            "type":"string",
            "description":"Group two label for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupTwoMeaning":{
            "maxLength":150,
            "type":"string",
            "description":"Group two meaning for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollRelationshipActionId":{
            "type":"number",
            "description":"Payroll relationship action identifier for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SolutionType":{
            "maxLength":100,
            "type":"string",
            "description":"Solution type for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationStatementResults":{
            "title":"Person Process Results Tax Calculation Statement Tax Results",
            "type":"array",
            "description":"The TaxCalculationResults resource, includes all the tax calculation statements calculation results.",
            "items":{
                "$ref":"#/components/schemas/personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementResults-item-response"
            }
        },
        "TaxCalculationStatementSteps":{
            "title":"Person Process Results Tax Calculation Statement Tax Steps",
            "type":"array",
            "description":"The TaxCalculationSteps resource, includes all the tax calculation statements calculation steps.",
            "items":{
                "$ref":"#/components/schemas/personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementSteps-item-response"
            }
        },
        "TaxCalculationStatementSummary":{
            "title":"Person Process Results Tax Calculation Statement Calculation Summary",
            "type":"array",
            "description":"The TaxCalculationSummary resource, includes all the tax calculation statements calculation summary.",
            "items":{
                "$ref":"#/components/schemas/personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementSummary-item-response"
            }
        },
        "TaxSubType":{
            "maxLength":150,
            "type":"string",
            "description":"Tax subtype for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxSubTypeCode":{
            "maxLength":50,
            "type":"string",
            "description":"Tax subtype code for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxType":{
            "maxLength":150,
            "type":"string",
            "description":"Tax type for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxTypeCode":{
            "maxLength":50,
            "type":"string",
            "description":"Tax type code for tax calculation statements tax type record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Person Process Results Tax Calculation Statement Tax Results

Type: array

Title: Person Process Results Tax Calculation Statement Tax Results

The TaxCalculationResults resource, includes all the tax calculation statements calculation results.

Show Source

• Array of: object personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementResults-item-response

{
    "title":"Person Process Results Tax Calculation Statement Tax Results",
    "type":"array",
    "description":"The TaxCalculationResults resource, includes all the tax calculation statements calculation results.",
    "items":{
        "$ref":"#/components/schemas/personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementResults-item-response"
    }
}

Nested Schema : Person Process Results Tax Calculation Statement Tax Steps

Type: array

Title: Person Process Results Tax Calculation Statement Tax Steps

The TaxCalculationSteps resource, includes all the tax calculation statements calculation steps.

Show Source

• Array of: object personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementSteps-item-response

{
    "title":"Person Process Results Tax Calculation Statement Tax Steps",
    "type":"array",
    "description":"The TaxCalculationSteps resource, includes all the tax calculation statements calculation steps.",
    "items":{
        "$ref":"#/components/schemas/personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementSteps-item-response"
    }
}

Nested Schema : Person Process Results Tax Calculation Statement Calculation Summary

Type: array

Title: Person Process Results Tax Calculation Statement Calculation Summary

The TaxCalculationSummary resource, includes all the tax calculation statements calculation summary.

Show Source

• Array of: object personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementSummary-item-response

{
    "title":"Person Process Results Tax Calculation Statement Calculation Summary",
    "type":"array",
    "description":"The TaxCalculationSummary resource, includes all the tax calculation statements calculation summary.",
    "items":{
        "$ref":"#/components/schemas/personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementSummary-item-response"
    }
}

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."
        }
    }
}

Nested Schema : personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementResults-item-response

Type: object

Show Source

• Format: string
  Read Only: true

  Maximum Length: 150

  Format for tax calculation statements results record.
• GroupOneCode: string
  Read Only: true

  Maximum Length: 50

  Group one code for tax calculation statements results record.
• GroupTwoCode: string
  Read Only: true

  Maximum Length: 50

  Group two code for tax calculation statements results record.
• LegislationCode: string
  Read Only: true

  Maximum Length: 30

  Legislation code for tax calculation statements results record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayrollRelationshipActionId: number
  Read Only: true

  Payroll relationship action for tax calculation statements results record.
• Sequence: number
  Read Only: true

  Sequence for tax calculation statements results record.
• Step: number
  Read Only: true

  Step for tax calculation statements results record.
• TaxCalculationBaseName: string
  Read Only: true

  Maximum Length: 100

  Tax calculation base name for tax calculation statements results record.
• TaxCalculationExpression: string
  Read Only: true

  Maximum Length: 1000

  Tax calculation expression for tax calculation statements results record.
• TaxCalculationId: number
  Read Only: true

  Tax calculation for tax calculation statements results record.
• TaxCalculationLogic: string
  Read Only: true

  Maximum Length: 500

  Tax calculation logic for tax calculation statements results record.
• TaxCalculationName: string
  Read Only: true

  Maximum Length: 150

  Tax calculation name for tax calculation statements results record.
• TaxCalculationResult: string
  Read Only: true

  Maximum Length: 500

  Tax calculation result for tax calculation statements results record.
• TaxCalculationType: string
  Read Only: true

  Maximum Length: 30

  Tax calculation type for tax calculation statements results record.
• TypeOneCode: string
  Read Only: true

  Maximum Length: 50

  Type one code for tax calculation statements results record.
• TypeTwoCode: string
  Read Only: true

  Maximum Length: 50

  Type two code tax calculation statements results record.

{
    "type":"object",
    "properties":{
        "Format":{
            "maxLength":150,
            "type":"string",
            "description":"Format for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupOneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Group one code for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupTwoCode":{
            "maxLength":50,
            "type":"string",
            "description":"Group two code for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollRelationshipActionId":{
            "type":"number",
            "description":"Payroll relationship action for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Sequence":{
            "type":"number",
            "description":"Sequence for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Step":{
            "type":"number",
            "description":"Step for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationBaseName":{
            "maxLength":100,
            "type":"string",
            "description":"Tax calculation base name for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationExpression":{
            "maxLength":1000,
            "type":"string",
            "description":"Tax calculation expression for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationId":{
            "type":"number",
            "description":"Tax calculation for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationLogic":{
            "maxLength":500,
            "type":"string",
            "description":"Tax calculation logic for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationName":{
            "maxLength":150,
            "type":"string",
            "description":"Tax calculation name for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationResult":{
            "maxLength":500,
            "type":"string",
            "description":"Tax calculation result for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationType":{
            "maxLength":30,
            "type":"string",
            "description":"Tax calculation type for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeOneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Type one code for tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeTwoCode":{
            "maxLength":50,
            "type":"string",
            "description":"Type two code tax calculation statements results record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementSteps-item-response

Type: object

Show Source

• Format: string
  Read Only: true

  Maximum Length: 150

  Format for tax calculation statements steps record.
• GroupOneCode: string
  Read Only: true

  Maximum Length: 50

  Group one code for tax calculation statements steps record.
• GroupTwoCode: string
  Read Only: true

  Maximum Length: 50

  Group two code for tax calculation statements steps record.
• LegislationCode: string
  Read Only: true

  Maximum Length: 30

  Legislation code for tax calculation statements steps record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayrollRelationshipActionId: number
  Read Only: true

  Payroll relationship action for tax calculation statements steps record.
• Sequence: number
  Read Only: true

  Sequence for tax calculation statements steps record.
• Step: number
  Read Only: true

  Step for tax calculation statements steps record.
• TaxCalculationBaseName: string
  Read Only: true

  Maximum Length: 100

  Tax calculation base name for tax calculation statements steps record.
• TaxCalculationExpression: string
  Read Only: true

  Maximum Length: 1000

  Tax calculation expression for tax calculation statements steps record.
• TaxCalculationId: number
  Read Only: true

  Tax calculation for tax calculation statements steps record.
• TaxCalculationLogic: string
  Read Only: true

  Maximum Length: 500

  Tax calculation logic for tax calculation statements steps record.
• TaxCalculationName: string
  Read Only: true

  Maximum Length: 150

  Tax calculation name for the tax calculation statements steps record.
• TaxCalculationResult: string
  Read Only: true

  Maximum Length: 500

  Tax calculation result for the tax calculation statements steps record.
• TaxCalculationType: string
  Read Only: true

  Maximum Length: 30

  Tax calculation type for the tax calculation statements steps record.
• TypeOneCode: string
  Read Only: true

  Maximum Length: 50

  Type one code for the tax calculation statements steps record.
• TypeTwoCode: string
  Read Only: true

  Maximum Length: 50

  Type two code tax calculation statements steps record.

{
    "type":"object",
    "properties":{
        "Format":{
            "maxLength":150,
            "type":"string",
            "description":"Format for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupOneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Group one code for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupTwoCode":{
            "maxLength":50,
            "type":"string",
            "description":"Group two code for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollRelationshipActionId":{
            "type":"number",
            "description":"Payroll relationship action for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Sequence":{
            "type":"number",
            "description":"Sequence for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Step":{
            "type":"number",
            "description":"Step for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationBaseName":{
            "maxLength":100,
            "type":"string",
            "description":"Tax calculation base name for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationExpression":{
            "maxLength":1000,
            "type":"string",
            "description":"Tax calculation expression for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationId":{
            "type":"number",
            "description":"Tax calculation for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationLogic":{
            "maxLength":500,
            "type":"string",
            "description":"Tax calculation logic for tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationName":{
            "maxLength":150,
            "type":"string",
            "description":"Tax calculation name for the tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationResult":{
            "maxLength":500,
            "type":"string",
            "description":"Tax calculation result for the tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationType":{
            "maxLength":30,
            "type":"string",
            "description":"Tax calculation type for the tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeOneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Type one code for the tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeTwoCode":{
            "maxLength":50,
            "type":"string",
            "description":"Type two code tax calculation statements steps record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : personProcessResults-TaxCalculationStatementTaxTypes-TaxCalculationStatementSummary-item-response

Type: object

Show Source

• Format: string
  Read Only: true

  Maximum Length: 150

  Format for tax calculation statements summary record.
• GroupOneCode: string
  Read Only: true

  Maximum Length: 50

  Group one code for tax calculation statements summary record.
• GroupTwoCode: string
  Read Only: true

  Maximum Length: 50

  Group two code for tax calculation statements summary record.
• LegislationCode: string
  Read Only: true

  Maximum Length: 30

  Legislation code for tax calculation statements summary record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayrollRelationshipActionId: number
  Read Only: true

  Payroll relationship action for tax calculation statements summary record.
• Sequence: number
  Read Only: true

  Sequence for tax calculation statements summary record.
• Step: number
  Read Only: true

  Step for tax calculation statements summary record.
• TaxCalculationBaseName: string
  Read Only: true

  Maximum Length: 100

  Tax calculation base name for tax calculation statements summary record.
• TaxCalculationExpression: string
  Read Only: true

  Maximum Length: 1000

  Tax calculation expression for tax calculation statements summary record.
• TaxCalculationId: number
  Read Only: true

  Tax calculation for tax calculation statements summary record.
• TaxCalculationLogic: string
  Read Only: true

  Maximum Length: 500

  Tax calculation logic for tax calculation statements summary record.
• TaxCalculationName: string
  Read Only: true

  Maximum Length: 150

  Tax calculation name for tax calculation statements summary record.
• TaxCalculationResult: string
  Read Only: true

  Maximum Length: 500

  Tax calculation result for tax calculation statements summary record.
• TaxCalculationType: string
  Read Only: true

  Maximum Length: 30

  Tax calculation type for tax calculation statements summary record.
• TypeOneCode: string
  Read Only: true

  Maximum Length: 50

  Type one code for tax calculation statements summary record.
• TypeTwoCode: string
  Read Only: true

  Maximum Length: 50

  Type two code tax calculation statements summary record.

{
    "type":"object",
    "properties":{
        "Format":{
            "maxLength":150,
            "type":"string",
            "description":"Format for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupOneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Group one code for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupTwoCode":{
            "maxLength":50,
            "type":"string",
            "description":"Group two code for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollRelationshipActionId":{
            "type":"number",
            "description":"Payroll relationship action for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Sequence":{
            "type":"number",
            "description":"Sequence for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Step":{
            "type":"number",
            "description":"Step for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationBaseName":{
            "maxLength":100,
            "type":"string",
            "description":"Tax calculation base name for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationExpression":{
            "maxLength":1000,
            "type":"string",
            "description":"Tax calculation expression for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationId":{
            "type":"number",
            "description":"Tax calculation for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationLogic":{
            "maxLength":500,
            "type":"string",
            "description":"Tax calculation logic for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationName":{
            "maxLength":150,
            "type":"string",
            "description":"Tax calculation name for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationResult":{
            "maxLength":500,
            "type":"string",
            "description":"Tax calculation result for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxCalculationType":{
            "maxLength":30,
            "type":"string",
            "description":"Tax calculation type for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeOneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Type one code for tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeTwoCode":{
            "maxLength":50,
            "type":"string",
            "description":"Type two code tax calculation statements summary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

TaxCalculationStatementResults

Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/TaxCalculationStatementTaxTypes/{TaxCalculationStatementTaxTypesUniqID}/child/TaxCalculationStatementResults

Parameters:

• ObjectActionId: $request.path.ObjectActionId
• TaxCalculationStatementTaxTypesUniqID: $request.path.TaxCalculationStatementTaxTypesUniqID

The TaxCalculationResults resource, includes all the tax calculation statements calculation results.

TaxCalculationStatementSteps

Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/TaxCalculationStatementTaxTypes/{TaxCalculationStatementTaxTypesUniqID}/child/TaxCalculationStatementSteps

Parameters:

• ObjectActionId: $request.path.ObjectActionId
• TaxCalculationStatementTaxTypesUniqID: $request.path.TaxCalculationStatementTaxTypesUniqID

The TaxCalculationSteps resource, includes all the tax calculation statements calculation steps.

TaxCalculationStatementSummary

Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/TaxCalculationStatementTaxTypes/{TaxCalculationStatementTaxTypesUniqID}/child/TaxCalculationStatementSummary

Parameters:

• ObjectActionId: $request.path.ObjectActionId
• TaxCalculationStatementTaxTypesUniqID: $request.path.TaxCalculationStatementTaxTypesUniqID

The TaxCalculationSummary resource, includes all the tax calculation statements calculation summary.

Back to Top