Payroll administration

Edit a payroll administration configuration

Activity name : <a href="https://developer.loket.nl/Activities/PutPayrollAdministrationConfigurationByPayrollAdministrationId" target="_blank">PutPayrollAdministrationConfigurationByPayrollAdministrationId</a>

Edit a non payroll administration.

put/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/configurations

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/configurations
  • Auth
    none required

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

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

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

descriptionstring

Description of the administration

clientNumberinteger

The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling.

startDatestring date

The first day the administration is active.

endDatestring date nullable

The last day the administration is active.

holidayAllowancePercentagenumber double

The percentage of the holidayAllowance.

yearEndPercentagenumber double

The percentage of the year end bonus.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "description": "Bakker",
  "clientNumber": 1234,
  "startDate": "2023-01-01",
  "endDate": "2025-12-31",
  "payrollPeriodType": {
    "key": 2,
    "value": "month"
  },
  "holidayAllowanceBaseForCalculation": {
    "key": 1,
    "value": "Basisloon"
  },
  "yearEndBaseForCalculation": {
    "key": 1,
    "value": "Basisloon"
  },
  "holidayAllowancePercentage": 40,
  "yearEndPercentage": 40,
  "defaults": {
    "employmentDurationType": {
      "key": 1,
      "value": "Contract of indefinite duration"
    },
    "typeOfEmployee": {
      "key": 1,
      "value": "Werknemer"
    },
    "employmentContractType": {
      "key": 1,
      "value": "Labor agreement"
    },
    "grossWageType": {
      "key": 2,
      "value": "hourly"
    },
    "netWageType": {
      "key": 1,
      "value": "hourly"
    },
    "payslipAvailableForEmployeeDay": 20,
    "componentSet": {
      "payrollPeriodDataCollectiveCategory": {
        "value": "Uren"
      },
      "payrollPeriodDataCollectiveComponentSet": {
        "description": "Standaard exportset"
      },
      "payrollPeriodDataIndividual": {
        "description": "Standaard exportset"
      },
      "payrollPeriodDataLeave": {
        "description": "Standaard exportset"
      },
      "payrollPeriodDataWerkkosten": {
        "description": "Standaard exportset"
      },
      "payrollPeriodDataEmployeeSelfService": {
        "description": "Standaard exportset"
      }
    }
  }
}

Response

OK

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",
    "description": "Bakker",
    "clientNumber": 1234,
    "startDate": "2023-01-01",
    "endDate": "2025-12-31",
    "payrollPeriodType": {
      "key": 2,
      "value": "month"
    },
    "holidayAllowanceBaseForCalculation": {
      "key": 1,
      "value": "Basisloon"
    },
    "yearEndBaseForCalculation": {
      "key": 1,
      "value": "Basisloon"
    },
    "holidayAllowancePercentage": 40,
    "yearEndPercentage": 40,
    "defaults": {
      "employmentDurationType": {
        "key": 1,
        "value": "Contract of indefinite duration"
      },
      "typeOfEmployee": {
        "key": 1,
        "value": "Werknemer"
      },
      "employmentContractType": {
        "key": 1,
        "value": "Labor agreement"
      },
      "grossWageType": {
        "key": 2,
        "value": "hourly"
      },
      "netWageType": {
        "key": 1,
        "value": "hourly"
      },
      "payslipAvailableForEmployeeDay": 20,
      "componentSet": {
        "payrollPeriodDataCollectiveCategory": {
          "value": "Uren"
        },
        "payrollPeriodDataCollectiveComponentSet": {
          "description": "Standaard exportset"
        },
        "payrollPeriodDataIndividual": {
          "description": "Standaard exportset"
        },
        "payrollPeriodDataLeave": {
          "description": "Standaard exportset"
        },
        "payrollPeriodDataWerkkosten": {
          "description": "Standaard exportset"
        },
        "payrollPeriodDataEmployeeSelfService": {
          "description": "Standaard exportset"
        }
      }
    }
  }
}

Changes

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