Jump to

• Request
• Response

Create a tax credit configuration for a requisition

post

/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionTaxCreditsConfigs

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountId: integer
  Tax credit user account identifier.
• PackageId: integer
  Tax credit package identifier.
• ProvisioningId: integer
  Tax credit provisioning identifier.
• RequisitionId: integer
  Tax credit requisition identifier.
• TCRequisitionConfigId: integer
  Tax credit requisition configuration identifier.
• TriggerTypeCode: string
  Maximum Length: 255

  Tax credit trigger type code.

{
    "type":"object",
    "properties":{
        "RequisitionId":{
            "type":"integer",
            "description":"Tax credit requisition identifier.",
            "nullable":true
        },
        "AccountId":{
            "type":"integer",
            "description":"Tax credit user account identifier.",
            "nullable":true
        },
        "TCRequisitionConfigId":{
            "type":"integer",
            "description":"Tax credit requisition configuration identifier.",
            "nullable":true
        },
        "PackageId":{
            "type":"integer",
            "description":"Tax credit package identifier.",
            "nullable":true
        },
        "TriggerTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Tax credit trigger type code.",
            "nullable":true
        },
        "ProvisioningId":{
            "type":"integer",
            "description":"Tax credit provisioning identifier.",
            "nullable":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:
  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 : recruitingUIRequisitionTaxCreditsConfigs-item-response

Type: object

Show Source

• AccountActiveFlag: boolean
  Read Only: true

  Indicates whether the tax credit user account is active or not.
• AccountDescription: string
  Read Only: true

  Maximum Length: 255

  Tax credit user account description.
• AccountId: integer
  Tax credit user account identifier.
• AccountUserName: string
  Read Only: true

  Maximum Length: 255

  Tax credit user account name.
• CSPActiveFlag: boolean
  Read Only: true

  Indicates whether the tax credit candidate selection process trigger is active or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PackageActiveFlag: boolean
  Read Only: true

  Indicates whether the tax credit package is active or not.
• PackageCode: string
  Read Only: true

  Maximum Length: 255

  Tax credit package code.
• PackageId: integer
  Tax credit package identifier.
• PackageName: string
  Read Only: true

  Maximum Length: 255

  Tax credit package name.
• PartnerActiveFlag: boolean
  Read Only: true

  Indicates whether the tax credit partner is active or not.
• PartnerName: string
  Read Only: true

  Maximum Length: 255

  Tax credit partner name.
• ProvisioningId: integer
  Tax credit provisioning identifier.
• RequisitionId: integer
  Tax credit requisition identifier.
• TCRequisitionConfigId: integer
  Tax credit requisition configuration identifier.
• TriggerTypeCode: string
  Maximum Length: 255

  Tax credit trigger type code.

{
    "type":"object",
    "properties":{
        "AccountDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Tax credit user account description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "type":"integer",
            "description":"Tax credit user account identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "PackageName":{
            "maxLength":"255",
            "type":"string",
            "description":"Tax credit package name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TCRequisitionConfigId":{
            "type":"integer",
            "description":"Tax credit requisition configuration identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "CSPActiveFlag":{
            "type":"boolean",
            "description":"Indicates whether the tax credit candidate selection process trigger is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerName":{
            "maxLength":"255",
            "type":"string",
            "description":"Tax credit partner name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TriggerTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Tax credit trigger type code.",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Tax credit requisition identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerActiveFlag":{
            "type":"boolean",
            "description":"Indicates whether the tax credit partner is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountActiveFlag":{
            "type":"boolean",
            "description":"Indicates whether the tax credit user account is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PackageActiveFlag":{
            "type":"boolean",
            "description":"Indicates whether the tax credit package is active or not.",
            "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"
            }
        },
        "AccountUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"Tax credit user account name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PackageId":{
            "type":"integer",
            "description":"Tax credit package identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "PackageCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Tax credit package code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProvisioningId":{
            "type":"integer",
            "description":"Tax credit provisioning identifier.",
            "nullable":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