Create a Check
  • 06 Jan 2025
  • 1 Minute to read
  • Dark
    Light

Create a Check

  • Dark
    Light

Article summary

Post
/hcm-rest-api/rest/1/pychecks

Create PayChecks

Security
HTTP
Type basic

Basic authentication

Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceItem+json
Body parameters
object
Example{ "PycCompCode": "001", "PycEmpNo": "3001", "PycPrnCode": "WK", "PycYear": "2022", "PycPprPeriod": "2", "PycCheckSeqNo": "6773", "PycRefSeqNo": "6773", "PycLastUpdDate": "2022-10-20", "PycUser": "UIG", "PycVUuid": "" }
PycCheckSeqNo
number Required

The system generated Sequence Number per Check

PycRefSeqNo
number Required

Set to PYC_CHECK_SEQ_NO, if there isn’t a separate Check Reference Number.

PycUser
string Required

The name of user who made the last update

Max length30
PycVUuid
string Required

Unique Identifier

Max length64
PycPprPeriod
number Required

Indentify the Pay Period

Max length2
PycCompCode
string Required

Company Code

Max length8
PycLastUpdDate
string Required

Date and Time stamp of the last update

PycEmpNo
string Required

The Employee to whom the check was paid

Max length16
PycPrnCode
string Required

Identify the Pay Run Code

Max length4
PycYear
number Required

Identify the Year related to the Pay

Max length4
PycCheckAmt
number

Amount to be paid by the check

Max length18
PycCheckNum
number

The Check Number used

Max length11
PycPrintCheckOnly
string

Set to ‘Y’.

Max length1
PycAssignedCheckNum
number
Max length8
PycPositivePayFileNo
number

Positive pay ascii file number.

PycPygCode
string

Identifies the Pay Group

Max length4
PycCklocCode
string

Check location code

Max length16
PycHomeCompCode
string

Employee Home company at the time of processing payroll

Max length8
PycCklocPygCode
string

If using check location, this is the pay group used for signatures and company logo.

Max length4
PycCheckVoidDate
string

Check Void Date

PycEmpBranchCode
string

Employee Bank Branch Code

Max length5
PycBranchCode
string

Unique Identifier of the Branch of a Bank

Max length5
PycBankAccNum
string

Employee Bank Account Number to where Salaries are paid

Max length17
PycStatementDate
string
PycRecDate
string

Reconciliation Date.

PycBankCode
string

Unique Code to identify the Bank

Max length9
PycThirdPartySickPay
string

Flag to indicate the check is related to third party sick pay i.e. the employee was being paid by insurance company or some other vendor. (Y)es OR [(N)o or NULL]

Max length1
PycRecFlag
string
Max length1
PycCheckDate
string

Check Date

PycManualChkPrint
string

Set to ‘N’.

Max length1
PycTranType
string

Transaction Type

Max length1
PycAchTranCode
string

Leave Null

Max length2
PycHomeDeptCode
string

Employee Home Dept Code from profile

Max length6
PycEmpBankAccNum
string

Employee Bank Account Number

Max length34
PycAsciiFileNo
number
PycEmpBankCode
string

Employee Bank Code

Max length9
Responses
201

Successful response