Create offer by PageUp Application ID (lApplicationID / Application - PUReferenceID)
POST {{baseUrl}}/recruitment/hire/applications/{{applicationId}}/offer?parentOfferID=0
Ensure every reference data (e.g. PayscaleID, CostCentreID, etc.) exists in PageUp's instance.
Required OAuth scopes for authentication: Public.Offer.Write
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
parentOfferID | number | PageUp parent offer Id (lOfferID) |
Request Body
{"OfferMadeDate"=>"<dateTime>", "StartDate"=>"<dateTime>", "EndDate"=>"<dateTime>", "ProbationEndDate"=>"<dateTime>", "OfferEventID"=>"<string>", "PayScaleID"=>"<string>", "PayScaleTypeID"=>"<string>", "PayScaleAreaID"=>"<string>", "Comments"=>"<string>", "HoursPerWeek"=>"<double>", "HoursPerMonth"=>"<double>", "OfferSupplementary_Boolean1"=>"<boolean>", "OfferSupplementary_Boolean2"=>"<boolean>", "OfferSupplementary_Boolean3"=>"<boolean>", "OfferSupplementary_Boolean4"=>"<boolean>", "OfferSupplementary_Boolean5"=>"<boolean>", "OfferSupplementary_Boolean6"=>"<boolean>", "OfferSupplementary_Boolean7"=>"<boolean>", "OfferSupplementary_Boolean8"=>"<boolean>", "OfferSupplementary_Boolean9"=>"<boolean>", "OfferSupplementary_Boolean10"=>"<boolean>", "OfferSupplementary_Text1"=>"<string>", "OfferSupplementary_Text2"=>"<string>", "OfferSupplementary_Text3"=>"<string>", "OfferSupplementary_Text4"=>"<string>", "OfferSupplementary_Text5"=>"<string>", "OfferSupplementary_Text6"=>"<string>", "OfferSupplementary_Text7"=>"<string>", "OfferSupplementary_Text8"=>"<string>", "OfferSupplementary_Text9"=>"<string>", "OfferSupplementary_Text10"=>"<string>", "OfferSupplementary_TextArea1"=>"<string>", "OfferSupplementary_TextArea2"=>"<string>", "OfferSupplementary_TextArea3"=>"<string>", "OfferSupplementary_TextArea4"=>"<string>", "OfferSupplementary_TextArea5"=>"<string>", "OfferSupplementary_TextArea6"=>"<string>", "OfferSupplementary_TextArea7"=>"<string>", "OfferSupplementary_TextArea8"=>"<string>", "OfferSupplementary_TextArea9"=>"<string>", "OfferSupplementary_TextArea10"=>"<string>", "OfferSupplementary_Date1"=>"<dateTime>", "OfferSupplementary_Date2"=>"<dateTime>", "OfferSupplementary_Date3"=>"<dateTime>", "OfferSupplementary_Date4"=>"<dateTime>", "OfferSupplementary_Date5"=>"<dateTime>", "OfferSupplementary_Date6"=>"<dateTime>", "OfferSupplementary_Date7"=>"<dateTime>", "OfferSupplementary_Date8"=>"<dateTime>", "OfferSupplementary_Date9"=>"<dateTime>", "OfferSupplementary_Date10"=>"<dateTime>", "PositionID"=>"<string>", "BaseRate"=>"<double>", "Super"=>"<double>", "Rate"=>"<string>", "OfferEventReasonID"=>"<string>", "Relocation"=>"<boolean>", "RatePeriod"=>"<string>", "RosterPattern"=>"<string>", "TotalRemuneration"=>"<double>", "NoticePeriod"=>"<string>", "RosterDetails"=>"<string>", "ContractReceivedDate"=>"<dateTime>", "EmploymentDuration"=>"<string>", "EmploymentProbationaryPeriod"=>"<string>", "VisaRequired"=>"<boolean>", "OriginalHireDate"=>"<dateTime>", "VisaDetails"=>"<string>", "VisaExpiryDate"=>"<dateTime>", "AnnualLeavePeriod"=>"<string>", "LongServiceLeavePeriod"=>"<string>", "ReviewDetails"=>"<string>", "FixedTermReason"=>"<string>", "AdditionalOfferConditions"=>"<string>", "StartNoLaterThan"=>"<string>", "UniLeaveLoading"=>"<double>", "UniMarketLoading"=>"<double>", "UniMeritLoading"=>"<double>", "RelocationAllowance"=>"<double>", "Classification"=>"<string>", "Award"=>"<string>", "ProRataPercent"=>"<double>", "RemunerationPercent"=>"<double>", "OvertimeRate"=>"<double>", "LocationAllowance"=>"<double>", "AdditionalHoursAllowance"=>"<double>", "PublicHolidayAllowance"=>"<double>", "FieldServiceAllowance"=>"<double>", "LeadingHandAllowance"=>"<double>", "CommutingAllowance"=>"<double>", "CarAllowance"=>"<double>", "CarAllowanceDetail"=>"<string>", "CarParkingBenefit"=>"<double>", "TargetIncentiveAmountSuper"=>"<double>", "CompanyBonus"=>"<double>", "MonthlyCommission"=>"<double>", "CompanyBonusMax"=>"<double>", "LivingAwayAllowance"=>"<double>", "JobTypeID"=>"<string>", "RosterAllowance"=>"<double>", "AllowOvertime"=>"<boolean>", "Contractor"=>"<boolean>", "AgreementTypeID"=>"<string>", "AgreementID"=>"<string>", "AgreementClassificationID"=>"<string>", "OfferSignedByUserID"=>"<string>", "ReportsToUserID"=>"<string>", "EmployeeGroupID"=>"<string>", "EmployeeSubGroupID"=>"<string>", "PersonnelAreaID"=>"<string>", "PersonnelSubAreaID"=>"<string>", "OfferTypeID"=>"<string>", "GenericListValues"=>[{"ListTypeCode"=>"<string>", "ValueCode"=>"<string>"}, {"ListTypeCode"=>"<string>", "ValueCode"=>"<string>"}], "AdditionalAllowance"=>"<double>", "AdditionalAllowance2"=>"<double>", "ShiftAllowance"=>"<double>", "RelocationComments"=>"<string>", "SiteID"=>"<string>", "CostCentreID"=>"<string>", "AssetID"=>"<string>", "OnboardingTaskUserID"=>"<string>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
"\u003cstring\u003e"