Contract.PayOptionsImportRequest

Name / Description Type / Format Example
analysisCategoriesCodes Contract.PaylineAnalysisCategoriesCodes[] {Contract.PaylineAnalysisCategoriesCodes}
autoAdjustForLeave boolean true
basis string "Hourly" "Daily" "Monthly"
contributesToBasicPay boolean true
costCentre string "string"
department string "string"
effectiveFrom string date "2024-12-14"
effectiveTo string date "2024-12-14"
employerIdentifier string "string"
ignoreInitialBackPay boolean true
isAutomaticBackPay boolean true
isNetToGross boolean true
lines Contract.PaylineRequest[] {Contract.PaylineRequest}
note string "string"
payAmount number double 0.0
payAmountMultiplier number double 0.0
payCode string "string"
payGrade string "string"
payrollCode string "string"
paySpine string "string"
roleReference string "string"
spinePoint string "string"
tags string[]
{
  "analysisCategoriesCodes": [
    {
      "analysisCategory": "string",
      "analysisCategoryCode": "string",
      "analysisCategoryId": "string",
      "analysisCategoryCodeId": "string"
    }
  ],
  "autoAdjustForLeave": true,
  "basis": "Hourly",
  "contributesToBasicPay": true,
  "costCentre": "string",
  "department": "string",
  "effectiveFrom": "2024-12-14",
  "effectiveTo": "2024-12-14",
  "employerIdentifier": "string",
  "ignoreInitialBackPay": true,
  "isAutomaticBackPay": true,
  "isNetToGross": true,
  "lines": [
    {
      "analysisCategoryCodeIds": [
        "string"
      ],
      "analysisCategoriesCodes": [
        {
          "analysisCategory": "string",
          "analysisCategoryCode": "string",
          "analysisCategoryId": "string",
          "analysisCategoryCodeId": "string"
        }
      ],
      "annualValue": 0.0,
      "autoAdjustForLeave": true,
      "calculateAsWhenPaid": true,
      "childId": "string",
      "code": "string",
      "contributesToBasicPay": true,
      "costCentre": "string",
      "costCentreId": "string",
      "department": "string",
      "departmentId": "string",
      "description": "string",
      "earnedFrom": "2024-12-14",
      "earnedTo": "2024-12-14",
      "effectiveFrom": "2024-12-14",
      "effectiveTo": "2024-12-14",
      "employeeRoleReference": "string",
      "fullTimeAnnualValue": 0.0,
      "ignoreInitialBackPay": true,
      "isAutoGeneratedBasicPayLine": true,
      "isAutomaticBackPay": true,
      "isNetToGross": true,
      "isZeroHoursTeachersBackPayLine": true,
      "londonAllowanceId": 0,
      "multiplier": 0.0,
      "netToGrossDiscrepancy": 0.0,
      "payGrade": "string",
      "paySpine": "string",
      "paySpineGradeId": "string",
      "paySpineId": "string",
      "percentageOfEffectiveDays": 0.0,
      "rate": 0.0,
      "roleId": "string",
      "spinePoint": "string",
      "spinalPointId": "string",
      "tags": [
        "string"
      ],
      "targetNetToGrossValue": 0.0,
      "totalPaidDays": 0.0,
      "totalWorkingDays": 0.0,
      "value": 0.0
    }
  ],
  "note": "string",
  "payAmount": 0.0,
  "payAmountMultiplier": 0.0,
  "payCode": "string",
  "payGrade": "string",
  "payrollCode": "string",
  "paySpine": "string",
  "roleReference": "string",
  "spinePoint": "string",
  "tags": [
    "string"
  ]
}
Contained in Models

- none -

Consumed by Operations
Import Pay (beta)
Returned by Operations

- none -