Contract.PaymentsImportResponse

Schema

Name / Description Type / Format Example
id string uuid "string"
payPeriod string "Custom" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
ordinal integer int32 0
behaviour string "ReplaceCurrentPayments" "ReplaceAllLines" "AppendToExistingLines" "UpdateOrAppendToExistingLines"
payBasis string "Hourly" "Daily" "Monthly"
payrollCodeColumnName string "string"
csvHasHeaderRow boolean true
csvHasPaylineCostings boolean true
writeOnceAccessToken string "string"
columnMappings Contract.ColumnMapping[] {Contract.ColumnMapping}

JSON Example 

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

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Get Column-Based Payments Import (Beta)