Employment template

Create an Employment template for an employer

Activity name : <a href="https://developer.loket.nl/Activities/PostEmploymentTemplateByByEmployerId" target="_blank">PostEmploymentTemplateByByEmployerId</a><br><br>Create a employment template for an employer<br><br>* Possible options (metadata) for generic fields of the type \metadata" can be acquired (GET) by adding /metadata to the URL.<br>* Possible options dependent on a specific payrollAdministration can be acquired via ../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}.<br>* Possible options for payGrade can be acquired via ../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}.<br>A payGrade has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request to GET ../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}. This endpoint has the optional parameter "date" that may be used to specifying a measure date.<br><br>Defaults : Default values for a new object can be acquired by adding /defaults to the POST URL. <br><br> <br>Default values that are dependent on the selected payroll administration can be acquired by adding /v2/providers/employers/employmenttemplates/defaults/payrolladministration/{payrollAdministrationId} to the POST URL.<br><br>NonPayrollAdministrations For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. Default values that are dependent on the selected non-payroll administration can be acquired via /v2/providers/employers/employmenttemplates/defaults/nonpayrolladministration/{nonPayrollAdministrationId}.<br>"

post/v2/providers/employers/{employerId}/employmenttemplates

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/employmenttemplates
  • Auth
    none required

Path parameters

employerIdstring uuid required

The unique identifier of the employer

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

X-ValidateOnlyboolean

If set to true only the validations will be performed no changes will be committed.

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

templateNamestring

Name of the template

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "templateName": "Sjabloon voor Oproepkracht",
  "employmentData": {
    "startDate": "2019-01-01",
    "historicalStartDate": "2012-05-01",
    "payrollAdministration": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "name": "ABC accountants",
      "clientNumber": 1234,
      "description": "Bakker"
    },
    "nonPayrollAdministration": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "name": "ABC accountants",
      "description": "Bakker"
    },
    "commissionUntilDate": "2019-01-01",
    "incomeRelationshipNumber": 12,
    "employeeProfileId": {
      "key": 1,
      "value": "Profiel full-timers"
    },
    "employmentDurationType": {
      "key": 1,
      "value": "Contract of indefinite duration"
    },
    "startDateContractOfIndefiniteDuration": "2018-05-08",
    "employmentContractType": {
      "key": 1,
      "value": "Labor agreement"
    },
    "typeOfEmployee": {
      "key": 1,
      "value": "Werknemer"
    },
    "cancellationPeriodEmployee": 1,
    "cancellationPeriodEmployer": 1,
    "cancellationPeriodTimeUnit": {
      "key": 4,
      "value": "Maand(en)"
    },
    "cancellationNoticeDate": "2019-05-31",
    "startCancellationNoticePeriod": "2019-06-01",
    "isOnCallEmployment": true,
    "hasOnCallAppearanceObligation": true,
    "vacationCoupons": {
      "key": 1,
      "value": "n.v.t."
    },
    "specialIncomeRatio": {
      "value": "n.v.t."
    },
    "isAnonymousEmployee": true,
    "isGemoedsbezwaardNationalInsurance": true,
    "isGemoedsbezwaardEmployeeInsurance": true,
    "namePayslip": "Steve Jobs",
    "calculateWorkingHours": true,
    "essMutationSet": {
      "key": 1,
      "value": "Standaard"
    },
    "exemptionInsuranceObligation": {
      "value": "Geen uitzondering."
    },
    "sendMdvNotification": true,
    "periodPayGradeAdjustment": 2,
    "typeOfParticipation": {
      "value": "n.v.t."
    },
    "valueOfParticipation": {
      "value": "n.v.t."
    },
    "professionCode": 4,
    "deviatingCLATaxReturn": 2,
    "emailLeaveRequest": "api@loket.nl",
    "writtenEmploymentContract": true
  },
  "workingHoursData": {
    "shift": {
      "shiftNumber": 1,
      "fullTimeHoursPerWeek": 40,
      "bonusPercentage": 12
    },
    "deviatingHoursPerWeek": 32,
    "deviatingSvDaysPerPeriod": 32,
    "averageParttimeFactor": 37.5,
    "regularWorkPattern": true,
    "flexibleHoursContract": {
      "value": "n.v.t."
    },
    "contractCode": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "code": 1022,
      "description": "SLA-PT-met toeslagen ATW (88)"
    },
    "calculateUsingWorkPattern": {
      "leaveHours": true
    },
    "workPattern": {
      "oddWeeks": {
        "monday": 8,
        "tuesday": 8,
        "wednesday": 4,
        "thursday": 7.5,
        "friday": 4
      },
      "evenWeeks": {
        "tuesday": 8,
        "wednesday": 8,
        "thursday": 8,
        "friday": 2
      }
    }
  },
  "wageData": {
    "grossWage": 23,
    "grossWageType": {
      "key": 2,
      "value": "hourly"
    },
    "netWageType": {
      "key": 1,
      "value": "hourly"
    },
    "payScale": {
      "key": 1,
      "value": "Glastuinbouw maand, Loongebouw A"
    },
    "payGrade": {
      "key": 1,
      "value": "Schaal B1, 15 jaar"
    },
    "applyPayGrade": true
  },
  "organizationalEntityData": {
    "function": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "description": "Directeur",
      "group": "internal"
    },
    "deviatingFunctionGroup": "9A",
    "deviatingFunctionDescription": "Directeur",
    "standardFunction": {
      "key": 1,
      "value": "Administrateur",
      "code": "A21",
      "category": 1
    },
    "department": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "code": 2,
      "description": "Verkoop"
    },
    "distributionUnit": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "code": 2,
      "description": "Sales"
    },
    "placeOfEmployment": "Amsterdam office",
    "internalTelephoneExtensionNumber": "0133031600"
  },
  "socialSecurityData": {
    "healthCareInsuranceActType": {
      "key": 2,
      "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
    }
  },
  "fiscalData": {
    "annualSalary": 60000,
    "deviatingPayrollTaxTableColour": {
      "key": 2,
      "value": "Werknemer belastingpl. en niet premiepl. WLZ"
    },
    "deviatingPayrollTaxPercentage": 27.45,
    "applyDeviatingPayrollTaxPercentageOn": {
      "key": 2,
      "value": "Afwijkend voor tabel- en tariefloon"
    },
    "deviatingCalculationRulePayrollTax": {
      "key": 2,
      "value": "Werknemer belastingpl. en niet premiepl. WLZ"
    },
    "residentOf": {
      "key": 2,
      "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
    }
  },
  "otherPayrollVariablesData": {
    "deviatingPremiumGroup": {
      "key": 2,
      "value": "(12) Metaal- en technische bedrijfstakken"
    }
  }
}

Response

Created

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "templateName": "Sjabloon voor Oproepkracht",
    "employmentData": {
      "startDate": "2019-01-01",
      "historicalStartDate": "2012-05-01",
      "payrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "ABC accountants",
        "clientNumber": 1234,
        "description": "Bakker"
      },
      "nonPayrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "ABC accountants",
        "description": "Bakker"
      },
      "commissionUntilDate": "2019-01-01",
      "incomeRelationshipNumber": 12,
      "employeeProfileId": {
        "key": 1,
        "value": "Profiel full-timers"
      },
      "employmentDurationType": {
        "key": 1,
        "value": "Contract of indefinite duration"
      },
      "startDateContractOfIndefiniteDuration": "2018-05-08",
      "employmentContractType": {
        "key": 1,
        "value": "Labor agreement"
      },
      "typeOfEmployee": {
        "key": 1,
        "value": "Werknemer"
      },
      "cancellationPeriodEmployee": 1,
      "cancellationPeriodEmployer": 1,
      "cancellationPeriodTimeUnit": {
        "key": 4,
        "value": "Maand(en)"
      },
      "cancellationNoticeDate": "2019-05-31",
      "startCancellationNoticePeriod": "2019-06-01",
      "isOnCallEmployment": true,
      "hasOnCallAppearanceObligation": true,
      "vacationCoupons": {
        "key": 1,
        "value": "n.v.t."
      },
      "specialIncomeRatio": {
        "value": "n.v.t."
      },
      "isAnonymousEmployee": true,
      "isGemoedsbezwaardNationalInsurance": true,
      "isGemoedsbezwaardEmployeeInsurance": true,
      "namePayslip": "Steve Jobs",
      "calculateWorkingHours": true,
      "essMutationSet": {
        "key": 1,
        "value": "Standaard"
      },
      "exemptionInsuranceObligation": {
        "value": "Geen uitzondering."
      },
      "sendMdvNotification": true,
      "periodPayGradeAdjustment": 2,
      "typeOfParticipation": {
        "value": "n.v.t."
      },
      "valueOfParticipation": {
        "value": "n.v.t."
      },
      "professionCode": 4,
      "deviatingCLATaxReturn": 2,
      "emailLeaveRequest": "api@loket.nl",
      "writtenEmploymentContract": true
    },
    "workingHoursData": {
      "shift": {
        "shiftNumber": 1,
        "fullTimeHoursPerWeek": 40,
        "bonusPercentage": 12
      },
      "deviatingHoursPerWeek": 32,
      "deviatingSvDaysPerPeriod": 32,
      "averageParttimeFactor": 37.5,
      "regularWorkPattern": true,
      "flexibleHoursContract": {
        "value": "n.v.t."
      },
      "contractCode": {
        "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "code": 1022,
        "description": "SLA-PT-met toeslagen ATW (88)"
      },
      "calculateUsingWorkPattern": {
        "leaveHours": true
      },
      "workPattern": {
        "oddWeeks": {
          "monday": 8,
          "tuesday": 8,
          "wednesday": 4,
          "thursday": 7.5,
          "friday": 4
        },
        "evenWeeks": {
          "tuesday": 8,
          "wednesday": 8,
          "thursday": 8,
          "friday": 2
        }
      }
    },
    "wageData": {
      "grossWage": 23,
      "grossWageType": {
        "key": 2,
        "value": "hourly"
      },
      "netWageType": {
        "key": 1,
        "value": "hourly"
      },
      "payScale": {
        "key": 1,
        "value": "Glastuinbouw maand, Loongebouw A"
      },
      "payGrade": {
        "key": 1,
        "value": "Schaal B1, 15 jaar"
      },
      "applyPayGrade": true
    },
    "organizationalEntityData": {
      "function": {
        "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "description": "Directeur",
        "group": "internal"
      },
      "deviatingFunctionGroup": "9A",
      "deviatingFunctionDescription": "Directeur",
      "standardFunction": {
        "key": 1,
        "value": "Administrateur",
        "code": "A21",
        "category": 1
      },
      "department": {
        "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "code": 2,
        "description": "Verkoop"
      },
      "distributionUnit": {
        "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "code": 2,
        "description": "Sales"
      },
      "placeOfEmployment": "Amsterdam office",
      "internalTelephoneExtensionNumber": "0133031600"
    },
    "socialSecurityData": {
      "healthCareInsuranceActType": {
        "key": 2,
        "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
      }
    },
    "fiscalData": {
      "annualSalary": 60000,
      "deviatingPayrollTaxTableColour": {
        "key": 2,
        "value": "Werknemer belastingpl. en niet premiepl. WLZ"
      },
      "deviatingPayrollTaxPercentage": 27.45,
      "applyDeviatingPayrollTaxPercentageOn": {
        "key": 2,
        "value": "Afwijkend voor tabel- en tariefloon"
      },
      "deviatingCalculationRulePayrollTax": {
        "key": 2,
        "value": "Werknemer belastingpl. en niet premiepl. WLZ"
      },
      "residentOf": {
        "key": 2,
        "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
      }
    },
    "otherPayrollVariablesData": {
      "deviatingPremiumGroup": {
        "key": 2,
        "value": "(12) Metaal- en technische bedrijfstakken"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.