Guides

Name / Description	Type / Format	Example
`payPeriod`	`string`	`"Custom"` `"Monthly"` `"FourWeekly"` `"Fortnightly"` `"Weekly"` `"Daily"`
`ordinal` Gets or sets the ordinal.	`integer` int32	`0`
`behaviour`	`string`	`"ReplaceCurrentPayments"` `"ReplaceAllLines"` `"AppendToExistingLines"` `"UpdateOrAppendToExistingLines"`
`payBasis`	`string`	`"Hourly"` `"Daily"` `"Monthly"`
`payrollCodeColumnName` Gets or sets the name of the payroll code column.	`string`	`"string"`
`csvHasHeaderRow` Gets or sets a value indicating whether the CSV has a header row.	`boolean`	`true`
`csvHasPaylineCostings` Gets or sets a value indicating whether the CSV has payline costings.	`boolean`	`true`
`columnMappingRules` Gets or sets the column mapping rules.	`Contract.MappingRule[]`	`{Contract.MappingRule}`

JSON Example

{
  "payPeriod": "Custom",
  "ordinal": 0,
  "behaviour": "ReplaceCurrentPayments",
  "payBasis": "Hourly",
  "payrollCodeColumnName": "string",
  "csvHasHeaderRow": true,
  "csvHasPaylineCostings": true,
  "columnMappingRules": [
    {
      "columnName": "string",
      "description": "string",
      "payCode": "string",
      "isNetToGross": true,
      "multiplierColumnName": "string"
    }
  ]
}

References

Contained in Models

- none -

Consumed by Operations
Import Column-Based Payments Asynchronously (Beta)

Returned by Operations

- none -