---
title: "Create a PY Union"
slug: "create-a-py-union"
updated: 2026-05-26T12:53:14Z
published: 2026-05-26T12:53:48Z
canonical: "developers.cmicglobal.com/create-a-py-union"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a PY Union

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

## Create Unions

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

### 

SecurityHTTPType basic

Basic authentication

Header parametersContent-TypestringExampleapplication/vnd.oracle.adf.resourceItem+json

Body parameters<select class='api-response-data' aria-label='Media type'><option value='937a0292-0415-4f42-991c-f8f95d8c71c5'>application/json</option>
</select>object  Example{
  "UniCode": "126",
  "UniName": "Chicago Auto Union",
  "UniShortName": "CAU",
  "UniUseCtlUnionRate": "N",
  "UniInclAsRegUniAca": "Y",
  "UniVUuid": ""
}UniInclAsRegUniAcastring    Required

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

Max length1
UniCodestring    Required

Identify the Union

💻 UI Fieldname: *Union

Max length4
UniShortNamestring    Required

💻 UI Fieldname: *Union Short Name

Max length16
UniVUuidstring    RequiredMax length64
UniNamestring    Required

Name of the Union

Max length30
UniUseCtlUnionRatestring    Required

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

Max length1
UniLicenseNostring    

License Number of the Union

💻 UI Fieldname: License No

Max length16
UniBranchCodestring    Max length5
UniUnionsUniNamestring    Max length4000
UniCollectBargainRegNamestring    Max length4000
UniCityCodestring    

Identify the City / Town

💻 UI Fieldname: City

Max length4
UniShowInclAsRegUniFlagstring    Max length4000
UniStateCodestring    

Identify the State / Province

💻 UI Fieldname: State/Province

Max length4
UniCountyCodestring    

Identify the County

💻 UI Fieldname: County

Max length4
UniCountryCodestring    

Identify the Country

💻 UI Fieldname: Country Code

Max length4
UniCountryNamestring    Max length4000
UniIuCreateUserstring    Max length30
UniLicenseDatestring    

License Date of the Union

💻 UI Fieldname: Issue Date

UniAddress1string    

Address of the Union

💻 UI Fieldname: Address1

Max length30
UniBankAccNumberstring    

Bank Account Number from where Salaries are disbursed

Max length16
UniAddress3string    

Address of the Union

💻 UI Fieldname: Address3

Max length30
UniCityNamestring    Max length4000
UniIuUpdateDatestring    
UniAddress2string    

Address of the Union

💻 UI Fieldname: Address2

Max length30
UniBankCodestring    Max length9
UniCollectBargainRegCodestring    

Collective Bargaining Region Code for Union. (Optional)

Max length16
UniUserstring    

The name of the user made the last update

Max length30
UniUnionsUniCodestring    

Identify the Union

💻 UI Fieldname: Control Union

Max length4
UniLastUpdDatestring    

Date and Time stamp of the last update

UniIuUpdateUserstring    Max length30
UniZipCodestring    

Zip or Postal Code of the Union Address

💻 UI Fieldname: Zip/Postal Code

Max length16
UniStateNamestring    Max length4000
UniCountyNamestring    Max length4000
UniTypestring    

Identify the Type of the Union like L for Local

💻 UI Fieldname: Type

Max length1
UniContactNamestring    

Contact name in the Union

💻 UI Fieldname: Contact Name

Max length30
UniIuCreateDatestring    

Responses201

Created

HeadersContent-TypestringExampleapplication/vnd.oracle.adf.resourceitem+json
<select class='api-response-data' aria-label='Media type'><option value='22d9606f-049a-48ba-90b5-027696bc0c8d'>application/json</option>
</select>

```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