action payrun_get_holiday_scheme_by_effective_date { label: "Get holiday scheme by effective date." description: "Returns the holiday scheme's state at the specified effective date." provider: payrun method: GET path: "/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/{EffectiveDate}" encoding: json input: { type: "object" properties: { "Api-Version": { type: "string" format: "string" } Authorization: { type: "string" format: "string" } EffectiveDate: { type: "string" format: "date" } EmployerId: { type: "string" } HolidaySchemeId: { type: "string" } } required: ["Api-Version", "Authorization", "EffectiveDate", "EmployerId", "HolidaySchemeId"] additionalProperties: false } output: { type: "object" properties: { HolidayScheme: { type: "object" properties: { AccrualPayCodes: { type: "object" description: "The holiday schemes' accrual pay codes" properties: { PayCode: { type: "array" items: { type: "string" } } } } AllowExceedAnnualEntitlement: { type: "boolean" description: "The holiday schemes' allow exceed annual entitlement" } AllowNegativeBalance: { type: "boolean" description: "The holiday schemes' allow negative balance" } AnnualEntitlementWeeks: { type: "number" format: "double" description: "The holiday schemes' annual entitlement weeks" } BankHolidayInclusive: { type: "boolean" description: "The holiday schemes' bank holiday inclusive" } Code: { type: "string" description: "The holiday schemes' code" } EffectiveDate: { type: "string" format: "date" description: "The holiday schemes' effective date" } MaxCarryOverDays: { type: "number" format: "double" description: "The holiday schemes' max carry over days" } NextRevisionDate: { type: "string" format: "date" description: "The holiday schemes' next revision date" } OffsetPayment: { type: "boolean" description: "The holiday schemes' offset payment" } Revision: { type: "integer" format: "int32" description: "The holiday schemes' revision" } SchemeCeasedDate: { type: "string" format: "date" description: "The holiday schemes' scheme ceased date" } SchemeKey: { type: "string" description: "The holiday schemes' scheme key" } SchemeName: { type: "string" description: "The holiday schemes' scheme name" } YearStartDay: { type: "integer" format: "int32" description: "The holiday schemes' year start day" } YearStartMonth: { type: "integer" format: "int32" description: "The holiday schemes' year start month" } } } } } }