LOloket
Payroll administration

Add a payroll administration

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

Add a payroll administration.

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

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/payrolladministrations
  • 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

Request body

administrationNumberstring nullable

The administration number is a free field commonly used to register the debtors number.

groupCodeinteger nullable

Number (integer) used for grouping administrations.

namestring

Name of the administration

shortNamestring nullable

Shortened name of the administration

descriptionstring

Description of the administration

withholdingPartystring nullable

Deviating name of the administration for the payroll tax return

payrollYearinteger

The first year the payroll administration is active.

isInternalPayrollAdministrationboolean

Indicates if the payroll administration is used for internal payroll purposes.

testYearboolean

Indicates if the firstPayrollYear for the payroll administration is a test year.

payrollTaxesNumberstring nullable

The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.

annualPayrollTaxReturnboolean

Indicates if the payroll administration uses an annual payroll tax return.

claTaxReturnCBSCodeinteger

The CBS code of the CLA (NL: CAO nummer), which is used for payroll tax return purposes. If no CLA is applicable than use the value 9999.

ibanstring nullable

IBAN

totalSepaFileboolean

Indicates if the total (a single instead of separate files) SEPA file is used. This is the file that is used for the payment of wages.

Example request

{
  "wageModel": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "value": "Foresting monthly payrolling",
    "firstPayrollYear": 2025,
    "currentPayrollYear": 2025,
    "cla": {
      "key": 184,
      "value": "Agriculture"
    },
    "payrollPeriodType": {
      "key": 2,
      "value": "month"
    }
  },
  "administrationNumber": "ABC",
  "groupCode": 40,
  "name": "ABC administration",
  "shortName": "ABC adm",
  "description": "Bakker",
  "withholdingParty": "ABC accountants",
  "groupClassification": {
    "key": 3,
    "value": "South"
  },
  "payrollYear": 2025,
  "address": {
    "street": "Voordijk",
    "city": "Leiden",
    "houseNumber": 12,
    "houseNumberAddition": "D",
    "furtherIndication": {
      "key": 1,
      "value": "WW"
    },
    "postalCode": "1234AA",
    "location": "Fourth floor or building C",
    "country": {
      "key": 1,
      "value": "Netherlands",
      "isoCode": "NL"
    },
    "province": {
      "key": 1,
      "value": "Noord-Holland"
    }
  },
  "deviatingPostalAddress": {
    "street": "Voordijk",
    "city": "Leiden",
    "houseNumber": 12,
    "houseNumberAddition": "D",
    "furtherIndication": {
      "key": 1,
      "value": "WW"
    },
    "postalCode": "1234 AA",
    "location": "Fourth floor or building C",
    "country": {
      "key": 1,
      "value": "Netherlands",
      "isoCode": "NL"
    },
    "poBox": 5000
  },
  "contact": {
    "name": "Henk de Vries",
    "phoneNumber": "013-12345678"
  },
  "payrollTaxesNumber": "111111110L46",
  "wageTaxTableColor": {
    "key": 2,
    "value": "Groene tabel"
  },
  "premiumGroup": {
    "key": 1,
    "value": "(1) Agrarisch bedrijf kort"
  },
  "premiumGroupUszo": {
    "key": 61,
    "value": "(61) Overheid, onderwijs en wetenschappen"
  },
  "methodOfCreationPayrollTaxReturn": {
    "key": 3,
    "value": "Collective"
  },
  "payrollTaxReturnProcessedBy": {
    "key": 6,
    "value": "Loket"
  },
  "aofPremiumType": {
    "key": 3,
    "value": "Kleine werkgever"
  },
  "claTaxReturnCBSCode": 1896,
  "iban": "NL91ABNA0417164300",
  "payslip": {
    "template": {
      "key": 1,
      "value": "Standaard met grijstinten"
    },
    "addressLocation": {
      "key": 1,
      "value": "Standaard"
    },
    "employeeNumberDisplayMethod": {
      "key": 1,
      "value": "Personeelsnummer"
    },
    "functionDisplayMethod": {
      "key": 1,
      "value": "Functie (Dienstverband)"
    },
    "hourlyWageDisplayMethod": {
      "key": 1,
      "value": "Uurloon en Periode uurloon"
    },
    "employmentStartDateDisplayMethod": {
      "key": 1,
      "value": "Historische datum in dienst"
    },
    "employeeNameDisplayMethod": {
      "key": 1,
      "value": "Standaard"
    }
  },
  "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"
    }
  }
}

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"
  }
}

Changes

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