Create a PY Union
    • 12 Feb 2025
    • 2 Minutes to read
    • Dark
      Light

    Create a PY Union

    • Dark
      Light

    Article summary

    Post
    /hcm-rest-api/rest/1/pyunions

    Create Unions

    US / International Payroll - Setup - Local Tables - Payroll Unions - Unions

    Security
    HTTP
    Type basic

    Basic authentication

    Header parameters
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceItem+json
    Body parameters
    object
    Example{ "UniCode": "126", "UniName": "Chicago Auto Union", "UniShortName": "CAU", "UniUseCtlUnionRate": "N", "UniInclAsRegUniAca": "Y", "UniVUuid": "" }
    UniInclAsRegUniAca
    string Required

    Y/N to consider/include union as Regular Union in the ACA Reporting (1095)

    Max length1
    UniCode
    string Required

    Identify the Union

    💻 UI Fieldname: *Union

    Max length4
    UniShortName
    string Required

    💻 UI Fieldname: *Union Short Name

    Max length16
    UniVUuid
    string Required
    Max length64
    UniName
    string Required

    Name of the Union

    Max length30
    UniUseCtlUnionRate
    string Required

    Y/N to use union rates set up under the controlling union.

    Max length1
    UniLicenseNo
    string

    License Number of the Union

    💻 UI Fieldname: License No

    Max length16
    UniBranchCode
    string
    Max length5
    UniUnionsUniName
    string
    Max length4000
    UniCollectBargainRegName
    string
    Max length4000
    UniCityCode
    string

    Identify the City / Town

    💻 UI Fieldname: City

    Max length4
    UniShowInclAsRegUniFlag
    string
    Max length4000
    UniStateCode
    string

    Identify the State / Province

    💻 UI Fieldname: State/Province

    Max length4
    UniCountyCode
    string

    Identify the County

    💻 UI Fieldname: County

    Max length4
    UniCountryCode
    string

    Identify the Country

    💻 UI Fieldname: Country Code

    Max length4
    UniCountryName
    string
    Max length4000
    UniIuCreateUser
    string
    Max length30
    UniLicenseDate
    string

    License Date of the Union

    💻 UI Fieldname: Issue Date

    UniAddress1
    string

    Address of the Union

    💻 UI Fieldname: Address1

    Max length30
    UniBankAccNumber
    string

    Bank Account Number from where Salaries are disbursed

    Max length16
    UniAddress3
    string

    Address of the Union

    💻 UI Fieldname: Address3

    Max length30
    UniCityName
    string
    Max length4000
    UniIuUpdateDate
    string
    UniAddress2
    string

    Address of the Union

    💻 UI Fieldname: Address2

    Max length30
    UniBankCode
    string
    Max length9
    UniCollectBargainRegCode
    string

    Collective Bargaining Region Code for Union. (Optional)

    Max length16
    UniUser
    string

    The name of the user made the last update

    Max length30
    UniUnionsUniCode
    string

    Identify the Union

    💻 UI Fieldname: Control Union

    Max length4
    UniLastUpdDate
    string

    Date and Time stamp of the last update

    UniIuUpdateUser
    string
    Max length30
    UniZipCode
    string

    Zip or Postal Code of the Union Address

    💻 UI Fieldname: Zip/Postal Code

    Max length16
    UniStateName
    string
    Max length4000
    UniCountyName
    string
    Max length4000
    UniType
    string

    Identify the Type of the Union like L for Local

    💻 UI Fieldname: Type

    Max length1
    UniContactName
    string

    Contact name in the Union

    💻 UI Fieldname: Contact Name

    Max length30
    UniIuCreateDate
    string
    Responses
    201

    Created

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+json
    {
      "UniCode": "126",
      "UniName": "Chicago Auto Union",
      "UniShortName": "CAU",
      "UniType": null,
      "UniUnionsUniCode": null,
      "UniUnionsUniName": null,
      "UniUseCtlUnionRate": "N",
      "UniCollectBargainRegCode": null,
      "UniCollectBargainRegName": null,
      "UniContactName": null,
      "UniLicenseNo": null,
      "UniLicenseDate": null,
      "UniAddress1": null,
      "UniAddress2": null,
      "UniAddress3": null,
      "UniZipCode": null,
      "UniBankCode": null,
      "UniBranchCode": null,
      "UniBankAccNumber": null,
      "UniCountryCode": null,
      "UniCountryName": null,
      "UniStateCode": null,
      "UniStateName": null,
      "UniCountyCode": null,
      "UniCountyName": null,
      "UniCityCode": null,
      "UniCityName": null,
      "UniInclAsRegUniAca": "Y",
      "UniShowInclAsRegUniFlag": null,
      "UniUser": null,
      "UniLastUpdDate": null,
      "UniIuCreateDate": null,
      "UniIuCreateUser": null,
      "UniIuUpdateDate": null,
      "UniIuUpdateUser": null,
      "UniVUuid": "F2A8505592542DDBE05316821FAC9500",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyunions/F2A8505592542DDBE05316821FAC9500",
          "name": "pyunions",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyunions/F2A8505592542DDBE05316821FAC9500",
          "name": "pyunions",
          "kind": "item"
        }
      ]
    }
    object