Mijn Communities
Help

HR Core and Payroll API - Endpoints

10-10-2023 12:17 (Bijgewerkt op 10-10-2023)
  • 0 Antwoorden
  • 0 kudos
  • 478 Weergaven

 

Swagger documentation

The following swagger page gives an overview of the endpoints:

 

Endpoints

Addresses

These endpoints return the address data of the employee that consists of the home and postal address. Each field has its own timeline.

 

Get the addresses of all employees of a customer:

- Get: https://api.youserve.nl/hrp/v1.0/addresses

 

Get the addresses of all employees of a company:

-  Get: https://api.youserve.nl/hrp/v1.0/addresses?companyId=10028636

 

Get the addresses of an employee:

-  Get: https://api.youserve.nl/hrp/v1.0/employees/10030024/addresses

 

Response example:

{
    "employeeId": 10030024,
    "companyId": 10028636,
    "personCode": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "NU1926"
        }
    ],
    "employeeCode": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "120"
        }
    ],
    "initials": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "2022-01-31T00:00:00Z",
            "value": "A.H."
        },
        {
            "startDate": "2022-02-01T00:00:00Z",
            "endDate": "2023-03-05T00:00:00Z",
            "value": "A.H.T."
        },
        {
            "startDate": "2023-03-06T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "AB"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "AFR"
        }
    ],
    "lastName": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "Huffman"
        }
    ],
    "addresses": [
        {
            "type": "Home",
            "country": [
                {
                    "startDate": "2006-01-01T00:00:00+00:00",
                    "endDate": "2006-10-31T00:00:00Z",
                    "value": "NL"
                },
                {
                    "startDate": "2006-11-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "NL"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "NL"
                }
            ],
            "street": [
                {
                    "startDate": "2006-11-01T00:00:00Z",
                    "endDate": "2019-04-07T00:00:00Z",
                    "value": "Dobberhof"
                },
                {
                    "startDate": "2019-04-08T00:00:00Z",
                    "endDate": "2019-04-19T00:00:00Z",
                    "value": "zevenhuizen"
                },
                {
                    "startDate": "2019-04-20T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "biltstraat"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-03-22T00:00:00Z",
                    "value": "wigsfrfvpb"
                },
                {
                    "startDate": "2023-03-23T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "Vitoria"
                }
            ],
            "houseNumber": [
                {
                    "startDate": "2006-11-01T00:00:00Z",
                    "endDate": "2021-07-31T00:00:00Z",
                    "value": "5"
                },
                {
                    "startDate": "2021-08-01T00:00:00Z",
                    "endDate": "2022-02-28T00:00:00Z",
                    "value": "5"
                },
                {
                    "startDate": "2022-03-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "5"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-03-22T00:00:00Z",
                    "value": "17"
                },
                {
                    "startDate": "2023-03-23T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "2"
                }
            ],
            "houseNumberAddition": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "25"
                }
            ],
            "postalCode": [
                {
                    "startDate": "2006-11-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "1121 PB"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "1234 AB"
                }
            ],
            "municipality": [
                {
                    "startDate": "2006-11-01T00:00:00Z",
                    "endDate": "2014-07-31T00:00:00Z",
                    "value": "Deventer"
                },
                {
                    "startDate": "2014-08-01T00:00:00Z",
                    "endDate": "2022-01-31T00:00:00Z",
                    "value": "Deventer"
                },
                {
                    "startDate": "2022-02-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "Deventer"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-03-22T00:00:00Z",
                    "value": "kkvviybree"
                },
                {
                    "startDate": "2023-03-23T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "Madrid"
                }
            ],
            "location": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "guufgvstcy"
                }
            ],
            "region": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-03-22T00:00:00Z",
                    "value": "xhcvjoprbh"
                },
                {
                    "startDate": "2023-03-23T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "Sanfer"
                }
            ]
        },
        {
            "type": "Postal",
            "country": [
                {
                    "startDate": "2017-07-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "NL"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "NL"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "NL"
                }
            ],
            "street": [
                {
                    "startDate": "2017-07-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "Plotterweg"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-03-22T00:00:00Z",
                    "value": "golurxcftu"
                },
                {
                    "startDate": "2023-03-23T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "Vitoria2"
                }
            ],
            "houseNumber": [
                {
                    "startDate": "2017-07-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "A"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "06"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "03"
                }
            ],
            "houseNumberAddition": [],
            "postalCode": [
                {
                    "startDate": "2017-07-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "3821 BB"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "1234 AB"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "4567 CD"
                }
            ],
            "municipality": [
                {
                    "startDate": "2017-07-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "Amerfoort"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "ponccrykpq"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "arturo2"
                }
            ],
            "location": [
                {
                    "startDate": "2017-07-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "hier"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "xhfjpfbkmu"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "arturo3"
                }
            ],
            "region": [
                {
                    "startDate": "2017-07-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "werk"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "cndsqcxmkt"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "arturo4"
                }
            ]
        }
    ]
}

 

This endpoint allows to update an employee's addresses. The request body is fixed and the missing fields are ignored. The start date is mandatory.

- Patch: https://api.youserve.nl/hrp/v1.0/addresses/10030024

Request body example:

{
	"StartDate": "2023-04-03",
	"Addresses": [
		{
			"Type": "Home",
			"Street": "Straat",
			"HouseNumber": "1",
			"Municipality": "Municipality",
			"Region": "Amsterdam"
		},
        {
			"Type": "Postal",
			"Street": "Tejas",
			"HouseNumber": "1",
			"Municipality": "San Fernando",
			"Region": "Madrid"
		}
    ]
}

As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "4385028f-e8b2-4503-9b94-4b0ae6aaa653"
}

 

Bank Accounts

These endpoints return the bank account data of the employees that consists of 10 bank accounts. Each field has its own timeline.

 

Get the bank accounts of all employees of a customer:

- Get: https://api.youserve.nl/hrp/v1.0/bankAccounts

 

Get the bank accounts of all employees of a company:

-  Get: https://api.youserve.nl/hrp/v1.0/bankAccounts?companyId=10028636

 

Get the bank accounts of an employee:

-  Get: https://api.youserve.nl/hrp/v1.0/employees/10030024/bankAccounts

 

Response example:

{
    "employeeId": 10030024,
    "companyId": 10028636,
    "personCode": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "NU1926"
        }
    ],
    "employeeCode": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "120"
        }
    ],
    "initials": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "2022-01-31T00:00:00Z",
            "value": "A.H."
        },
        {
            "startDate": "2022-02-01T00:00:00Z",
            "endDate": "2023-03-05T00:00:00Z",
            "value": "A.H.T."
        },
        {
            "startDate": "2023-03-06T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "AB"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "AFR"
        }
    ],
    "lastName": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "Huffman"
        }
    ],
    "bankAccounts": [
        {
            "id": 1,
            "iban": [
                {
                    "startDate": "2012-10-01T00:00:00Z",
                    "endDate": "2013-01-31T00:00:00Z",
                    "value": "NL50INGB0000009887"
                },
                {
                    "startDate": "2013-02-01T00:00:00Z",
                    "endDate": "2013-08-31T00:00:00Z",
                    "value": "NL50INGB0000009887"
                },
                {
                    "startDate": "2013-09-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "NL50INGB0000009887"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                }
            ],
            "bic": [
                {
                    "startDate": "2012-10-01T00:00:00Z",
                    "endDate": "2013-01-31T00:00:00Z",
                    "value": "INGBNL2A"
                },
                {
                    "startDate": "2013-02-01T00:00:00Z",
                    "endDate": "2013-08-31T00:00:00Z",
                    "value": "INGBNL2A"
                },
                {
                    "startDate": "2013-09-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "INGBNL2A"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "MOLUNL22"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "MOLUNL22"
                }
            ],
            "description": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-03-22T00:00:00Z",
                    "value": "tksapvnxfq"
                },
                {
                    "startDate": "2023-03-23T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "NewDescription"
                }
            ],
            "accountType": [
                {
                    "startDate": "2006-11-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "01"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "01"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "01"
                }
            ],
            "accountHolder": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "stppb"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "arthur"
                }
            ],
            "amount": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-03-22T00:00:00Z",
                    "value": "100,5"
                },
                {
                    "startDate": "2023-03-23T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "100"
                }
            ]
        },
        {
            "id": 2,
            "iban": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                }
            ],
            "bic": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "MOLUNL22"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "MOLUNL22"
                }
            ],
            "description": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-03-22T00:00:00Z",
                    "value": "wxrhuivevj"
                },
                {
                    "startDate": "2023-03-23T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "NewDescription2"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "test5"
                }
            ],
            "accountType": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "01"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "01"
                }
            ],
            "accountHolder": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "nqvmq"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "arthur"
                }
            ],
            "amount": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "100,5"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "4"
                }
            ]
        },
        {
            "id": 3,
            "iban": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                }
            ],
            "bic": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "MOLUNL22"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "MOLUNL22"
                }
            ],
            "description": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "jipeavrepm"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "test5"
                }
            ],
            "accountType": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "01"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "01"
                }
            ],
            "accountHolder": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "nnfkk"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "arthur"
                }
            ],
            "amount": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "100,5"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "3"
                }
            ]
        },
        {
            "id": 4,
            "iban": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                }
            ],
            "bic": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "MOLUNL22"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "MOLUNL22"
                }
            ],
            "description": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "wnwifysqin"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "test5"
                }
            ],
            "accountType": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "01"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "01"
                }
            ],
            "accountHolder": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "gcimf"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "arthur"
                }
            ],
            "amount": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "100,5"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "2"
                }
            ]
        },
        {
            "id": 5,
            "iban": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "GB33BUKB20201555555555"
                }
            ],
            "bic": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "MOLUNL22"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "MOLUNL22"
                }
            ],
            "description": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "rkqdbeusep"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "test5"
                }
            ],
            "accountType": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "01"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "01"
                }
            ],
            "accountHolder": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "ckocx"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "arthur"
                }
            ],
            "amount": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "2023-04-02T00:00:00Z",
                    "value": "100,5"
                },
                {
                    "startDate": "2023-04-03T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "1"
                }
            ]
        }
    ]
}

This endpoint allows to update an employee's bank accounts. The request body is fixed and the missing fields are ignored. The start date is mandatory.

- Patch: https://api.youserve.nl/hrp/v1.0/bankAccounts/10030024

Request body example:

 

{
	"StartDate": "2023-04-03",
	"BankAccounts": [
		{
			"Id": 1,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "tksapvnxfq",
			"AccountType": "01",
			"AccountHolder": "stppb",
			"Amount": "100,5"
		},
		{
			"Id": 2,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "wxrhuivevj",
			"AccountType": "01",
			"AccountHolder": "nqvmq",
			"Amount": "100,5"
		},
		{
			"Id": 3,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "jipeavrepm",
			"AccountType": "01",
			"AccountHolder": "nnfkk",
			"Amount": "100,5"
		},
		{
			"Id": 4,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "wnwifysqin",
			"AccountType": "01",
			"AccountHolder": "gcimf",
			"Amount": "100,5"
		},
		{
			"Id": 5,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "rkqdbeusep",
			"AccountType": "01",
			"AccountHolder": "ckocx",
			"Amount": "100,5"
		}
	]
}

 

As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "72d2bd02-517e-425e-9593-cc2f631b09aa"
}

 

Personal Details

These endpoints return the personal details of the employee. Each field has its own timeline.

 

Get the personal details of all employees of a customer:

- Get: https://api.youserve.nl/hrp/v1.0/personalDetails

 

Get the personal details of all employees of a company:

-  Get: https://api.youserve.nl/hrp/v1.0/personalDetails?companyId=10028636

 

Get the personal details of an employee:

-  Get: https://api.youserve.nl/hrp/v1.0/employees/10030024/personalDetails

 

Response example:

{
    "employeeId": 10030024,
    "companyId": 10028636,
    "personCode": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "NU1926"
        }
    ],
    "employeeCode": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "120"
        }
    ],
    "initials": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "2022-01-31T00:00:00Z",
            "value": "A.H."
        },
        {
            "startDate": "2022-02-01T00:00:00Z",
            "endDate": "2023-03-05T00:00:00Z",
            "value": "A.H.T."
        },
        {
            "startDate": "2023-03-06T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "AB"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "AFR"
        }
    ],
    "firstNames": [
        {
            "startDate": "2006-11-01T00:00:00Z",
            "endDate": "2023-01-31T00:00:00Z",
            "value": "Arno Hendrik"
        },
        {
            "startDate": "2023-02-01T00:00:00Z",
            "endDate": "2023-03-05T00:00:00Z",
            "value": "Joshua Megan"
        },
        {
            "startDate": "2023-03-06T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "Juan_1"
        }
    ],
    "knownAs": [
        {
            "startDate": "2006-11-01T00:00:00Z",
            "endDate": "2023-03-04T00:00:00Z",
            "value": "Arno"
        },
        {
            "startDate": "2023-03-05T00:00:00Z",
            "endDate": "2023-03-05T00:00:00Z",
            "value": "1"
        },
        {
            "startDate": "2023-03-06T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "Juan_1"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "Peter"
        }
    ],
    "lastName": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "Huffman"
        }
    ],
    "lastNamePrefix": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "de"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "ak"
        }
    ],
    "maritalStatus": [
        {
            "startDate": "2006-11-01T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "1"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "1"
        }
    ],
    "partnerName": [
        {
            "startDate": "2017-07-01T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "Heek"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "hlplocatnw"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "Lola"
        }
    ],
    "partnerNamePrefix": [
        {
            "startDate": "2017-07-01T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "van"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "nf"
        }
    ],
    "titlePrefix": [
        {
            "startDate": "2023-03-05T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "1"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "rm"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "Mr"
        }
    ],
    "titleSuffix": [
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "k"
        }
    ],
    "gender": [
        {
            "startDate": "2006-11-01T00:00:00Z",
            "endDate": "2013-05-31T00:00:00Z",
            "value": "1"
        },
        {
            "startDate": "2013-06-01T00:00:00Z",
            "endDate": "2014-07-31T00:00:00Z",
            "value": "1"
        },
        {
            "startDate": "2014-08-01T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "1"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "1"
        }
    ],
    "birthDate": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "1962-11-08"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "2010-03-05"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "1979-03-23"
        }
    ],
    "birthplace": [],
    "nationality": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "2006-10-31T00:00:00Z",
            "value": "0001"
        },
        {
            "startDate": "2006-11-01T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "0001"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "0001"
        }
    ],
    "dateOfDeath": [
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "2023-03-08"
        }
    ],
    "userUID": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "FakePingId"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "046588"
        }
    ],
    "communicationLanguage": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "2006-10-31T00:00:00Z",
            "value": "NL"
        },
        {
            "startDate": "2006-11-01T00:00:00Z",
            "endDate": "2013-08-31T00:00:00Z",
            "value": "NL"
        },
        {
            "startDate": "2013-09-01T00:00:00Z",
            "endDate": "2023-03-08T00:00:00Z",
            "value": "NL"
        },
        {
            "startDate": "2023-03-09T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "NL"
        }
    ],
    "bsnSocSecNumber": [
        {
            "startDate": "2006-11-01T00:00:00Z",
            "endDate": "2023-03-26T00:00:00Z",
            "value": "111222333"
        },
        {
            "startDate": "2023-03-27T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "283232237"
        }
    ],
    "phoneNumbers": [
        {
            "type": "Mobile",
            "number": [
                {
                    "startDate": "2006-11-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "06-11987622"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "085282265"
                }
            ]
        },
        {
            "type": "Mobile",
            "number": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "532186503"
                }
            ]
        }
    ],
    "emailAddresses": [
        {
            "type": "Work",
            "email": [
                {
                    "startDate": "2006-11-01T00:00:00Z",
                    "endDate": "2022-02-28T00:00:00Z",
                    "value": "ah.devoogd@raet.com"
                },
                {
                    "startDate": "2022-03-01T00:00:00Z",
                    "endDate": "2023-03-08T00:00:00Z",
                    "value": "demo@raet.com"
                },
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "test2@visma.com"
                }
            ]
        },
        {
            "type": "Private",
            "email": [
                {
                    "startDate": "2023-03-09T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "test@visma.com"
                }
            ]
        }
    ]
}

This endpoint allows to update an employee's personal details. The request body is fixed and the missing fields are ignored. The start date is mandatory.

- Patch: https://api.youserve.nl/hrp/v1.0/personalDetails/10030024

Request body example:

{
	"StartDate": "2023-03-09",
	"PersonalDetails": {
		"EmployeeCode": "AFR26",
		"Initials": "AFR",
		"FirstNames": "Arturo",
		"KnownAs": "Arthur",
		"LastName": "Conan",
		"LastNamePrefix": "mr",
		"MaritalStatus": "1",
		"PartnerName": "Alexandra",
		"PartnerNamePrefix": "ms",
		"TitlePrefix": "Dr",
		"TitleSuffix": "jr",
		"Gender": "1",
		"BirthDate": "1978-03-12",
		"Birthplace": "The Netherlands",
		"Nationality": "0001",
		"DateOfDeath": "",
		"UserUID": "046588",
		"CommunicationLanguage": "NL",
		"PhoneNumbers": [
			{
				"Type": "Mobile",
				"Number": "639424977"
			},
			{
				"Type": "Private",
				"Number": "912801078"
			}
		],
		"EmailAddresses": [
			{
				"Type": "Private",
				"Email": "arthur@gmail.com"
			},
			{
				"Type": "Work",
				"Email": "arturo.conan@visma.com"
			}
		]
	}
}

As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "50b00afd-e9f2-44b1-bc10-c2a3132641a7"
}

 

Employees

These endpoints return the data of the employees: personal details, bank accounts, addresses. Each field has its own timeline.

 

Get all employees of a customer:

- Get: https://api.youserve.nl/hrp/v1.0/employees

 

Get all employees of a company:

-  Get: https://api.youserve.nl/hrp/v1.0/employees?companyId=10028636

 

Get the data of an employee:

-  Get: https://api.youserve.nl/hrp/v1.0/employees/10030024

 

Response example:

{
    "employeeId": 10030307,
    "companyId": 10028637,
    "personalDetails": {
        "personCode": [
            {
                "startDate": "2006-01-01T00:00:00+00:00",
                "endDate": "9999-12-31T00:00:00+00:00",
                "value": "NU1545"
            }
        ],
        "employeeCode": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "10090"
            }
        ],
        "initials": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "IH"
            }
        ],
        "firstNames": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "Inge"
            }
        ],
        "knownAs": [],
        "lastName": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "Rooibos"
            }
        ],
        "lastNamePrefix": [],
        "maritalStatus": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "1"
            }
        ],
        "partnerName": [],
        "partnerNamePrefix": [],
        "titlePrefix": [],
        "titleSuffix": [],
        "gender": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "2"
            }
        ],
        "birthDate": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "1974-08-09"
            }
        ],
        "birthplace": [],
        "nationality": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "0001"
            }
        ],
        "dateOfDeath": [],
        "userUID": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "FakePingId"
            }
        ],
        "communicationLanguage": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "NL"
            }
        ],
        "bsnSocSecNumber": [
            {
                "startDate": "2006-01-01T00:00:00Z",
                "endDate": "9999-12-31T00:00:00Z",
                "value": "080141729"
            }
        ],
        "phoneNumbers": [],
        "emailAddresses": []
    },
    "addresses": [
        {
            "type": "Home",
            "country": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "NL"
                }
            ],
            "street": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "Dorpstraat"
                }
            ],
            "houseNumber": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "12"
                }
            ],
            "houseNumberAddition": [],
            "postalCode": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "6745 re"
                }
            ],
            "municipality": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "2016-06-30T00:00:00Z",
                    "value": "Oegstgeest"
                },
                {
                    "startDate": "2016-07-01T00:00:00Z",
                    "endDate": "2017-05-31T00:00:00Z",
                    "value": "Oegstgeest"
                },
                {
                    "startDate": "2017-06-01T00:00:00Z",
                    "endDate": "2023-01-31T00:00:00Z",
                    "value": "Oegstgeest"
                },
                {
                    "startDate": "2023-02-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "Oegstgeest"
                }
            ],
            "location": [],
            "region": []
        },
        {
            "type": "Postal",
            "country": [],
            "street": [],
            "houseNumber": [],
            "houseNumberAddition": [],
            "postalCode": [],
            "municipality": [],
            "location": [],
            "region": []
        }
    ],
    "bankAccounts": [
        {
            "id": 1,
            "iban": [
                {
                    "startDate": "2013-09-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "NL55INGB0000005432"
                }
            ],
            "bic": [
                {
                    "startDate": "2013-09-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "INGBNL2A"
                }
            ],
            "description": [],
            "accountType": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "01"
                }
            ],
            "accountHolder": [],
            "amount": []
        },
        {
            "id": 2,
            "iban": [
                {
                    "startDate": "2013-09-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "NL76INGB0000000689"
                }
            ],
            "bic": [
                {
                    "startDate": "2013-09-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "INGBNL2A"
                }
            ],
            "description": [],
            "accountType": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "06"
                }
            ],
            "accountHolder": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "Wehkamp"
                }
            ],
            "amount": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "200"
                }
            ]
        },
        {
            "id": 4,
            "iban": [
                {
                    "startDate": "2013-09-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "NL81INGB0000002345"
                }
            ],
            "bic": [
                {
                    "startDate": "2013-09-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "INGBNL2A"
                }
            ],
            "description": [],
            "accountType": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "03"
                }
            ],
            "accountHolder": [],
            "amount": []
        }
    ]
}

 

This endpoint allows to create an employee (Hire). No contract data is needed except for the Collective Labour Agreement that is mandatory. Also it is allowed to send the field "templateGroup" in the contract data and the data of the employee in HR Core will be filled in according with the definition.

- Post: https://api.youserve.nl/hrp/v1.0/employees

Request body example:

{
  "companyId": 10028637,
  "startDate": "2023-03-29",
	"PersonalDetails": {
		"EmployeeCode": "YSDU001",
		"Initials": "A.",
		"FirstNames": "Arthur Ignatius",
		"KnownAs": "A2D2",
		"LastName": "Conan Doyle",
		"LastNamePrefix": " van",
		"MaritalStatus": "1",
		"PartnerName": "Jean Leckie",
		"PartnerNamePrefix": "van",
		"TitlePrefix": "Mr.",
		"TitleSuffix": "ex",
		"Gender": "1",
		"BirthDate": "1978/05/22",
		"Birthplace": "Spain",
		"Nationality": "0001",
		"UserUID": "1234567",
		"CommunicationLanguage": "NL",
		"BsnSocSecNumber": "292985782",
		"PhoneNumbers": [
			{
				"Type": "Mobile",
				"Number": "085282265"
			},
			{
				"Type": "Private",
				"Number": "532186503"
			}
		],
		"EmailAddresses": [
			{
				"Type": "Private",
				"Email": "test@visma.com"
			},
			{
				"Type": "Work",
				"Email": "test2@visma.com"
			}
		]
	},
	"Addresses": [
		{
			"Type": "Home",
			"Country": "NL",
			"Street": "wigsfrfvpb",
			"HouseNumber": "17",
			"HouseNumberAddition": "25",
			"PostalCode": "1234 AB",
			"Municipality": "kkvviybree",
			"Location": "guufgvstcy",
			"Region": "xhcvjoprbh"
		},
		{
			"Type": "Postal",
			"Country": "NL",
			"Street": "golurxcftu",
			"HouseNumber": "13",
			"HouseNumberAddition": "06",
			"PostalCode": "1234 AB",
			"Municipality": "ponccrykpq",
			"Location": "xhfjpfbkmu",
			"Region": "cndsqcxmkt"
		}
	],
	"BankAccounts": [
		{
			"Id": 1,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "tksapvnxfq",
			"AccountType": "01",
			"AccountHolder": "stppb",
			"Amount": "101,5"
		},
		{
			"Id": 2,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "wxrhuivevj",
			"AccountType": "01",
			"AccountHolder": "nqvmq",
			"Amount": "102,5"
		},
		{
			"Id": 3,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "jipeavrepm",
			"AccountType": "01",
			"AccountHolder": "nnfkk",
			"Amount": "103,5"
		},
		{
			"Id": 4,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "wnwifysqin",
			"AccountType": "01",
			"AccountHolder": "gcimf",
			"Amount": "104,5"
		},
		{
			"Id": 5,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "rkqdbeusep",
			"AccountType": "01",
			"AccountHolder": "ckocx",
			"Amount": "105,5"
		}
	],
	"Contract": {
		"CollectiveLabourAgreement": "13155437"
	}
}

As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "d5e5edd9-bdf2-4413-bf53-340982d8f48e"
}

 

This endpoint allows to update an employee. The request body is fixed and the missing fields are ignored. The start date is mandatory.

- Patch: https://api.youserve.nl/hrp/v1.0/employees/10030024

Request body example:

{
	"StartDate": "2023-03-09",
	"PersonalDetails": {
		"EmployeeCode": "120",
		"Initials": "fq",
		"FirstNames": "cafkndvcro",
		"KnownAs": "yuwlr",
		"LastName": "aisejkqi",
		"LastNamePrefix": "ak",
		"MaritalStatus": "1",
		"PartnerName": "hlplocatnw",
		"PartnerNamePrefix": "nf",
		"TitlePrefix": "rm",
		"TitleSuffix": "k",
		"Gender": "1",
		"BirthDate": "2010-03-05T00:00:00",
		"Birthplace": "spain",
		"Nationality": "0001",
		"DateOfDeath": "2023-03-09T00:00:00+01:00",
		"UserUID": "046588",
		"CommunicationLanguage": "NL",
		
		"PhoneNumbers": [
			{
				"Type": "Mobile",
				"Number": "085282265"
			},
			{
				"Type": "Private",
				"Number": "532186503"
			}
		],
		"EmailAddresses": [
			{
				"Type": "Private",
				"Email": "test@visma.com"
			},
			{
				"Type": "Work",
				"Email": "test2@visma.com"
			}
		]
	},
	"Addresses": [
		{
			"Type": "Home",
			"Country": "NL",
			"Street": "wigsfrfvpb",
			"HouseNumber": "17",
			"HouseNumberAddition": "25",
			"PostalCode": "1234 AB",
			"Municipality": "kkvviybree",
			"Location": "guufgvstcy",
			"Region": "xhcvjoprbh"
		},
		{
			"Type": "Postal",
			"Country": "NL",
			"Street": "golurxcftu",
			"HouseNumber": "13",
			"HouseNumberAddition": "06",
			"PostalCode": "1234 AB",
			"Municipality": "ponccrykpq",
			"Location": "xhfjpfbkmu",
			"Region": "cndsqcxmkt"
		}
	],
	"BankAccounts": [
		{
			"Id": 1,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "tksapvnxfq",
			"AccountType": "01",
			"AccountHolder": "stppb",
			"Amount": "100,5"
		},
		{
			"Id": 2,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "wxrhuivevj",
			"AccountType": "01",
			"AccountHolder": "nqvmq",
			"Amount": "100,5"
		},
		{
			"Id": 3,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "jipeavrepm",
			"AccountType": "01",
			"AccountHolder": "nnfkk",
			"Amount": "100,5"
		},
		{
			"Id": 4,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "wnwifysqin",
			"AccountType": "01",
			"AccountHolder": "gcimf",
			"Amount": "100,5"
		},
		{
			"Id": 5,
			"Iban": "GB33BUKB20201555555555",
			"Bic": "MOLUNL22",
			"Description": "rkqdbeusep",
			"AccountType": "01",
			"AccountHolder": "ckocx",
			"Amount": "100,5"
		}
	]
}

As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "c0abf203-f569-445a-823b-921d702785e6"
}

 

Contracts

These endpoints return the data of the contracts. Each field has its own timeline.

 

Get all contracts of a customer:

- Get: https://api.youserve.nl/hrp/v1.0/contracts

 

Get all contracts of an employee:

-  Get: https://api.youserve.nl/hrp/v1.0/contracts?employeeId=10030024

 

Get the data of a contract:

-  Get: https://api.youserve.nl/hrp/v1.0/contracts/10030025

 

Response example:

{
    "employeeId": 10036130,
    "companyCode": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "1"
        }
    ],
    "personCode": [],
    "employeeCode": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "594"
        }
    ],
    "initials": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "GH"
        }
    ],
    "lastName": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "Meer"
        }
    ],
    "contractId": 10030025,
    "employmentCode": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "1"
        }
    ],
    "description": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "TestPatch"
        }
    ],
    "jobProfile": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "Proj_L"
        }
    ],
    "daysPeriod": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "5"
        },
        {
            "startDate": "2022-12-01T00:00:00Z",
            "endDate": "2022-12-31T00:00:00",
            "value": "5"
        },
        {
            "startDate": "2023-01-01T00:00:00Z",
            "endDate": "2023-01-31T00:00:00",
            "value": "4"
        },
        {
            "startDate": "2023-02-01T00:00:00Z",
            "endDate": "2023-03-22T00:00:00",
            "value": "5"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "2023-03-24T00:00:00Z",
            "value": "7"
        },
        {
            "startDate": "2023-03-25T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "7"
        }
    ],
    "hoursPeriod": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "2015-02-28T00:00:00Z",
            "value": "40"
        },
        {
            "startDate": "2015-03-01T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "36"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "2023-03-24T00:00:00Z",
            "value": "3"
        },
        {
            "startDate": "2023-03-25T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "3"
        }
    ],
    "contractType": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "B"
        }
    ],
    "location": [],
    "costCenter": [],
    "collectiveLaborAgreement": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "10027028"
        }
    ],
    "contractEndDate": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "9999-12-31"
        }
    ],
    "department": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "BD"
        }
    ],
    "incomeRelationshipNumber": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "16"
        }
    ],
    "writtenLaborAgreement": [
        {
            "startDate": "2019-10-31T00:00:00Z",
            "endDate": "9999-12-31T00:00:00",
            "value": "J"
        },
        {
            "startDate": "2019-11-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00",
            "value": "J"
        }
    ],
    "onCallAgreement": [
        {
            "startDate": "2019-10-31T00:00:00Z",
            "endDate": "9999-12-31T00:00:00",
            "value": "N"
        },
        {
            "startDate": "2019-11-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00",
            "value": "N"
        }
    ],
    "mainOrAncillaryContract": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "1"
        }
    ],
    "probationaryPeriod": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "0"
        }
    ],
    "hireDate": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "1996-11-01"
        }
    ],
    "firstHireDate": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "1996-11-01"
        }
    ],
    "establishmentUnit": [
        {
            "startDate": "2006-01-01T00:00:00+00:00",
            "endDate": "9999-12-31T00:00:00+00:00",
            "value": "10054050"
        }
    ],
    "organizationalUnit": [
        {
            "startDate": "2023-04-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00",
            "value": "13234918"
        }
    ]
}

This endpoint allows to update an employee. The request body is fixed and the missing fields are ignored. The start date is mandatory.

- Patch: https://api.youserve.nl/hrp/v1.0/contracts/10031392

Request body example:

{
  "startDate": "2023-04-24",
  "employmentCode": "2",
  "description": "stringTest",
  "jobProfile": "AF",
  "daysPeriod": 7,
  "hoursPeriod": 9,
  "contractType": "C",
  "location": "Madrid",
  "costCenter": "01",
  "collectiveLaborAgreement": 10027028,
  "contractEndDate": "2026-01-01",
  "department": "AF",
  "incomeRelationshipNumber": 2,
  "writtenLaborAgreement": "K",
  "onCallAgreement": "Y",
  "mainOrAncillaryContract": "0",
  "probationaryPeriod": "5",
  "hireDate": "2023-04-24",
  "firstHireDate": "2000-01-01",
  "establishmentUnit": "10054051",
  "organizationalUnit": "10641457"
}

As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "2788965b-bafb-4cc8-a235-3dd0efb3ffae"
}

 

Benefits

These endpoints return the data of the benefits: Salary scale or Gross variable. The timeline is associated to the set of fields.

 

Get the Salary scale data of a contract:

- Get: https://api.youserve.nl/hrp/v1.0/contracts/10030338/salaryScale

Response example:

[
    {
        "validFrom": "2006-01-01T00:00:00",
        "validUntil": "2008-06-30T00:00:00",
        "contractId": 10030338,
        "employeeId": 10033542,
        "personCode": null,
        "employeeCode": "592",
        "initials": "M.",
        "lastName": "Ruiter",
        "companyCode": "2",
        "employmentCode": "1",
        "salaryPeriodicity": "13",
        "salaryScale": null,
        "salaryLevel": 0,
        "rsp": 0,
        "category": null,
        "factorToConvertAnnualSalary": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false,
        "blockCollectiveSalaryIncrease": false,
        "assessmentScore": null,
        "blockIncreaseOfSalaryBasedOnAssessment": false,
        "salaryAmount": 0
    },
    {
        "validFrom": "2008-07-01T00:00:00",
        "validUntil": "2012-02-29T00:00:00",
        "contractId": 10030338,
        "employeeId": 10033542,
        "personCode": null,
        "employeeCode": "592",
        "initials": "M.",
        "lastName": "Ruiter",
        "companyCode": "2",
        "employmentCode": "1",
        "salaryPeriodicity": "13",
        "salaryScale": "10",
        "salaryLevel": 0,
        "rsp": 0,
        "category": null,
        "factorToConvertAnnualSalary": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false,
        "blockCollectiveSalaryIncrease": false,
        "assessmentScore": null,
        "blockIncreaseOfSalaryBasedOnAssessment": false,
        "salaryAmount": 500
    },
    {
        "validFrom": "2012-03-01T00:00:00",
        "validUntil": "2012-12-30T00:00:00",
        "contractId": 10030338,
        "employeeId": 10033542,
        "personCode": null,
        "employeeCode": "592",
        "initials": "M.",
        "lastName": "Ruiter",
        "companyCode": "2",
        "employmentCode": "1",
        "salaryPeriodicity": "13",
        "salaryScale": "10",
        "salaryLevel": 0,
        "rsp": 0,
        "category": null,
        "factorToConvertAnnualSalary": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false,
        "blockCollectiveSalaryIncrease": false,
        "assessmentScore": null,
        "blockIncreaseOfSalaryBasedOnAssessment": false,
        "salaryAmount": 500
    },
    {
        "validFrom": "2012-12-31T00:00:00",
        "validUntil": "2013-12-31T00:00:00",
        "contractId": 10030338,
        "employeeId": 10033542,
        "personCode": null,
        "employeeCode": "592",
        "initials": "M.",
        "lastName": "Ruiter",
        "companyCode": "2",
        "employmentCode": "1",
        "salaryPeriodicity": "13",
        "salaryScale": "10",
        "salaryLevel": 0,
        "rsp": 0,
        "category": null,
        "factorToConvertAnnualSalary": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false,
        "blockCollectiveSalaryIncrease": false,
        "assessmentScore": null,
        "blockIncreaseOfSalaryBasedOnAssessment": false,
        "salaryAmount": 500
    },
    {
        "validFrom": "2014-01-01T00:00:00",
        "validUntil": "9999-12-31T00:00:00",
        "contractId": 10030338,
        "employeeId": 10033542,
        "personCode": null,
        "employeeCode": "592",
        "initials": "M.",
        "lastName": "Ruiter",
        "companyCode": "2",
        "employmentCode": "1",
        "salaryPeriodicity": "13",
        "salaryScale": "10",
        "salaryLevel": 0,
        "rsp": 0,
        "category": null,
        "factorToConvertAnnualSalary": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false,
        "blockCollectiveSalaryIncrease": false,
        "assessmentScore": null,
        "blockIncreaseOfSalaryBasedOnAssessment": false,
        "salaryAmount": 2075
    }
]

Get the Gross variable data of a contract:

- Get: https://api.youserve.nl/hrp/v1.0/contracts/10030778/grossVariable

Response example:

 

[
    {
        "validFrom": "2006-01-01T00:00:00",
        "validUntil": "2012-12-30T00:00:00",
        "employeeId": 10033760,
        "personCode": null,
        "employeeCode": "602",
        "initials": "K.",
        "lastName": "Buiten",
        "contractId": 10030778,
        "companyCode": "2",
        "employmentCode": "1",
        "salaryHourlyRate": 0,
        "salaryHoursWorked": 0,
        "salaryDaysWorked": 0,
        "salaryScale": null,
        "salaryLevel": 0,
        "rsp": 0,
        "alternateSalaryHourlyWages": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false
    },
    {
        "validFrom": "2012-12-31T00:00:00",
        "validUntil": "2013-08-31T00:00:00",
        "employeeId": 10033760,
        "personCode": null,
        "employeeCode": "602",
        "initials": "K.",
        "lastName": "Buiten",
        "contractId": 10030778,
        "companyCode": "2",
        "employmentCode": "1",
        "salaryHourlyRate": 0,
        "salaryHoursWorked": 0,
        "salaryDaysWorked": 0,
        "salaryScale": null,
        "salaryLevel": 0,
        "rsp": 0,
        "alternateSalaryHourlyWages": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false
    },
    {
        "validFrom": "2013-09-01T00:00:00",
        "validUntil": "2015-11-30T00:00:00",
        "employeeId": 10033760,
        "personCode": null,
        "employeeCode": "602",
        "initials": "K.",
        "lastName": "Buiten",
        "contractId": 10030778,
        "companyCode": "2",
        "employmentCode": "1",
        "salaryHourlyRate": 0,
        "salaryHoursWorked": 0,
        "salaryDaysWorked": 0,
        "salaryScale": null,
        "salaryLevel": 0,
        "rsp": 0,
        "alternateSalaryHourlyWages": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false
    },
    {
        "validFrom": "2015-12-01T00:00:00",
        "validUntil": "2015-12-31T00:00:00",
        "employeeId": 10033760,
        "personCode": null,
        "employeeCode": "602",
        "initials": "K.",
        "lastName": "Buiten",
        "contractId": 10030778,
        "companyCode": "2",
        "employmentCode": "1",
        "salaryHourlyRate": 10,
        "salaryHoursWorked": 160,
        "salaryDaysWorked": 20,
        "salaryScale": null,
        "salaryLevel": 0,
        "rsp": 0,
        "alternateSalaryHourlyWages": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false
    },
    {
        "validFrom": "2016-01-01T00:00:00",
        "validUntil": "2016-01-31T00:00:00",
        "employeeId": 10033760,
        "personCode": null,
        "employeeCode": "602",
        "initials": "K.",
        "lastName": "Buiten",
        "contractId": 10030778,
        "companyCode": "2",
        "employmentCode": "1",
        "salaryHourlyRate": 10,
        "salaryHoursWorked": 152,
        "salaryDaysWorked": 19,
        "salaryScale": null,
        "salaryLevel": 0,
        "rsp": 0,
        "alternateSalaryHourlyWages": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false
    },
    {
        "validFrom": "2016-02-01T00:00:00",
        "validUntil": "2016-02-29T00:00:00",
        "employeeId": 10033760,
        "personCode": null,
        "employeeCode": "602",
        "initials": "K.",
        "lastName": "Buiten",
        "contractId": 10030778,
        "companyCode": "2",
        "employmentCode": "1",
        "salaryHourlyRate": 10,
        "salaryHoursWorked": 100,
        "salaryDaysWorked": 13,
        "salaryScale": null,
        "salaryLevel": 0,
        "rsp": 0,
        "alternateSalaryHourlyWages": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false
    },
    {
        "validFrom": "2016-03-01T00:00:00",
        "validUntil": "9999-12-31T00:00:00",
        "employeeId": 10033760,
        "personCode": null,
        "employeeCode": "602",
        "initials": "K.",
        "lastName": "Buiten",
        "contractId": 10030778,
        "companyCode": "2",
        "employmentCode": "1",
        "salaryHourlyRate": 10,
        "salaryHoursWorked": 0,
        "salaryDaysWorked": 0,
        "salaryScale": null,
        "salaryLevel": 0,
        "rsp": 0,
        "alternateSalaryHourlyWages": 0,
        "autoIncreaseLevelBasedOnAge": false,
        "autoLevelIncreaseBasedOnYearsInService": false
    }
]

 

This endpoint allows to update the salary scale data of a contract. The request body is fixed and the missing fields are ignored. The start date is mandatory.

- Patch: https://api.youserve.nl/hrp/v1.0/contracts/10030025/salaryScale

Request body example:

{
  "startDate": "2023-03-23",
  "salaryPeriodicity": "13",
  "salaryScale": "2",
  "salaryLevel": 11,
  "rsp": 8,
  "category": "2",
  "factorToConvertAnnualSalary": 1,
  "autoIncreaseLevelBasedOnAge": true,
  "autoLevelIncreaseBasedOnYearsInService": false,
  "blockCollectiveSalaryIncrease": true,
  "blockIncreaseOfSalaryBasedOnAssessment": true,
  "salaryAmount": 1000
}

This endpoint allows to update the gross variable data of a contract. The request body is fixed and the missing fields are ignored. The start date is mandatory.

- Patch: https://api.youserve.nl/hrp/v1.0/contracts/10030025/grossVariable

Request body example:

{
  "startDate": "2023-03-23",
  "salaryHourlyRate": 8,
  "salaryHoursWorked": 8,
  "salaryDaysWorked": 5,
  "salaryScale": "2",
  "salaryLevel": 11,
  "rsp": 8,
  "alternateSalaryHourlyWages": 2,
  "autoIncreaseLevelBasedOnAge": true,
  "autoLevelIncreaseBasedOnYearsInService": false
}

As they are asynchronous operations, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "366c639d-0336-4818-8394-4116f8cf8bbe"
}

 

Value lists

These endpoints return the different value lists used in the employee and contract data. It is possible to set filters for language and reference date.

 

Marital statuses:

- Get: https://api.youserve.nl/hrp/v1.0/maritalStatuses

- Get: https://api.youserve.nl/hrp/v1.0/maritalStatuses?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/maritalStatuses?referenceDate=2023-01-01

 

Genders:

- Get: https://api.youserve.nl/hrp/v1.0/genders

- Get: https://api.youserve.nl/hrp/v1.0/genders?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/genders?referenceDate=2023-01-01

 

Nationalities:

- Get: https://api.youserve.nl/hrp/v1.0/nationalities

- Get: https://api.youserve.nl/hrp/v1.0/nationalities?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/nationalities?referenceDate=2023-01-01

 

Communication Languages:

- Get: https://api.youserve.nl/hrp/v1.0/communicationLanguages

- Get: https://api.youserve.nl/hrp/v1.0/communicationLanguages?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/communicationLanguages?referenceDate=2023-01-01

 

Countries: (Address types: Home or Postal)

- Get: https://api.youserve.nl/hrp/v1.0/countries?addressType=Home

- Get: https://api.youserve.nl/hrp/v1.0/countries?addressType=Home&language=NL

- Get: https://api.youserve.nl/hrp/v1.0/countries?addressType=Home&referenceDate=2023-01-01

 

Account Types: (AccountTypeId: 1 - 10)

- Get: https://api.youserve.nl/hrp/v1.0/accountTypes?accountTypeId=1

- Get: https://api.youserve.nl/hrp/v1.0/accountTypes?accountTypeId=1&language=NL

- Get: https://api.youserve.nl/hrp/v1.0/accountTypes?accountTypeId=1&referenceDate=2023-01-01

 

Job Profiles:

- Get: https://api.youserve.nl/hrp/v1.0/jobProfiles

- Get: https://api.youserve.nl/hrp/v1.0/jobProfiles?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/jobProfiles?referenceDate=2023-01-01

 

 

Contract Types:

- Get: https://api.youserve.nl/hrp/v1.0/contractTypes

- Get: https://api.youserve.nl/hrp/v1.0/contractTypes?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/contractTypes?referenceDate=2023-01-01

 

Locations:

- Get: https://api.youserve.nl/hrp/v1.0/locations

- Get: https://api.youserve.nl/hrp/v1.0/locations?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/locations?referenceDate=2023-01-01

 

Classifications:

- Get: https://api.youserve.nl/hrp/v1.0/classifications

- Get: https://api.youserve.nl/hrp/v1.0/classifications?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/classifications?referenceDate=2023-01-01

 

Cost Centers:

- Get: https://api.youserve.nl/hrp/v1.0/costCenters

- Get: https://api.youserve.nl/hrp/v1.0/costCenters?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/costCenters?referenceDate=2023-01-01

 

Salary Scales:

- Get: https://api.youserve.nl/hrp/v1.0/salaryScales

- Get: https://api.youserve.nl/hrp/v1.0/salaryScales?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/salaryScales?referenceDate=2023-01-01

 

Departments:

- Get: https://api.youserve.nl/hrp/v1.0/departments

- Get: https://api.youserve.nl/hrp/v1.0/departments?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/departments?referenceDate=2023-01-01

 

Written Labor Agreements:

- Get: https://api.youserve.nl/hrp/v1.0/writtenLaborAgreements

- Get: https://api.youserve.nl/hrp/v1.0/writtenLaborAgreements?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/writtenLaborAgreements?referenceDate=2023-01-01

 

On Call Agreements:

- Get: https://api.youserve.nl/hrp/v1.0/onCallAgreements

- Get: https://api.youserve.nl/hrp/v1.0/onCallAgreements?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/onCallAgreements?referenceDate=2023-01-01

 

Main or Ancillary Contracts:

- Get: https://api.youserve.nl/hrp/v1.0/mainOrAncillaryContracts

- Get: https://api.youserve.nl/hrp/v1.0/mainOrAncillaryContracts?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/mainOrAncillaryContracts?referenceDate=2023-01-01

 

Probationary Periods:

- Get: https://api.youserve.nl/hrp/v1.0/probationaryPeriods

- Get: https://api.youserve.nl/hrp/v1.0/probationaryPeriods?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/probationaryPeriods?referenceDate=2023-01-01

 

Employment Types:

- Get: https://api.youserve.nl/hrp/v1.0/employmentTypes

- Get: https://api.youserve.nl/hrp/v1.0/employmentTypes?language=NL

- Get: https://api.youserve.nl/hrp/v1.0/employmentTypes?referenceDate=2023-01-01

 

Response example of the previous value lists:

[
    {
        "code": "0",
        "description": "Unknown"
    },
    {
        "code": "1",
        "description": "Single"
    },
    {
        "code": "2",
        "description": "Wed"
    },
    {
        "code": "3",
        "description": "Divorced"
    },
    {
        "code": "4",
        "description": "Widow/widower"
    },
    {
        "code": "5",
        "description": "Registered partnership"
    },
    {
        "code": "6",
        "description": "Cohabiting"
    },
    {
        "code": "7",
        "description": "Cohabiting without contract"
    },
    {
        "code": "8",
        "description": "Cohabiting with contract"
    }
]

 

Collective Labour Agreements:

- Get: https://api.youserve.nl/hrp/v1.0/collectiveLabourAgreements

- Get: https://api.youserve.nl/hrp/v1.0/collectiveLabourAgreements/10025352

Response example:

{
    "id": 10025352,
    "code": [
        {
            "startDate": "2001-01-01T00:00:00+00:00",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "487"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "codeUpd"
        }
    ],
    "workSchedule": [
        {
            "startDate": "2001-12-30T00:00:00Z",
            "endDate": "2023-03-22T00:00:00",
            "value": "1111122000000000000000000000"
        },
        {
            "startDate": "2001-12-31T00:00:00Z",
            "endDate": "2023-03-22T00:00:00",
            "value": "1111122000000000000000000000"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "workScheduleUpd"
        }
    ],
    "client": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "10029306"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "10029306"
        }
    ],
    "nameImplementationCompany": [
        {
            "startDate": "2001-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "NameImplementationArt"
        }
    ],
    "name": [
        {
            "startDate": "2001-01-01T00:00:00+00:00",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "Raet Demo Administratie NL"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "testName"
        }
    ],
    "workHoursScheduleWeek1": [
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "112"
        }
    ],
    "flexBundleIdentification": [],
    "employerCategory": [],
    "sequenceNumber": [
        {
            "startDate": "2001-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "00002"
        }
    ]
}

This endpoint allows to create a new company collective labour agreement:

Post: https://api.youserve.nl/hrp/v1.0/collectiveLabourAgreements

Request body example:

{
  "companyId": 13155436,
  "startDate": "2023-09-05",
  "code": "CodeArt2",
  "workSchedule": "WorkScheduleArt",
  "client": "10029306",
  "nameImplementationCompany": "NameImplementationArt",
  "name": "Name4",
  "workHoursScheduleWeek1": "112",
  "sequenceNumber": "0007"
}

As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "c2c131ce-59ef-4ab5-b60f-c0a68474fc28"
}

 

This endpoint allows to update a company collective labour agreement. The body is fixed and the missing fields are ignored.

Patch: https://api.youserve.nl/hrp/v1.0/collectiveLabourAgreements/14073663

Request body example:

{
  "startDate": "2023-02-02",
  "code": "CodeArt2",
  "workSchedule": "WorkScheduleArt",
  "client": "10029306",
  "nameImplementationCompany": "NameImplementationArt",
  "name": "Name4",
  "workHoursScheduleWeek1": "112",
  "sequenceNumber": "0008"
}

As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "c2c131ce-59ef-4ab5-b60f-c0a68474fc28"
}

 

Organizational Units:

- Get: https://api.youserve.nl/hrp/v1.0/organizationalUnits

- Get: https://api.youserve.nl/hrp/v1.0/organizationalUnits/10641457

Response example:

{
    "id": 10641457,
    "code": [
        {
            "startDate": "2009-11-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "ILaYVs"
        }
    ],
    "name": [
        {
            "startDate": "2009-11-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "name"
        }
    ],
    "backupManager": [
        {
            "startDate": "2009-11-01T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "10647865"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "13375375"
        }
    ],
    "numberOfFTEs": [
        {
            "startDate": "2009-11-01T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "12"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "1"
        }
    ],
    "manager": [
        {
            "startDate": "2009-11-01T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "10033037"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "10033037"
        }
    ],
    "numberKvK": [],
    "organizationType": [
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "01"
        }
    ],
    "numberOfEmployees": [
        {
            "startDate": "2009-11-01T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "12"
        }
    ],
    "yearEstimation": [
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "1212"
        }
    ],
    "educationBudget": [
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "2121"
        }
    ]
}

 

This endpoint allows to create a new organizational unit:

Post: https://api.youserve.nl/hrp/v1.0/organizationalUnits

Request body example:

{
  "tenantId": 10029872,
  "startDate": "2023-01-01",
  "code": "ART1",
  "name": "name",
  "backupManager": "13375375",
  "numberOfFTEs": "1",
  "manager": "10033037",
  "numberKvK": "11",
  "organizationType": "01",
  "numberOfEmployees": "12",
  "yearEstimation": "2023",
  "educationBudget": "455"
}

As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "99045997-77e5-46b0-8657-8a3612e3f9d8"
}

 

This endpoint allows to update an organizational unit. The body is fixed and the missing fields are ignored.

Patch: https://api.youserve.nl/hrp/v1.0/organizationalUnits/14075602

Request body example:

 

{
  "startDate": "2023-01-01",
  "code": "ART51",
  "name": "nameUp",
  "backupManager": "13375375",
  "numberOfFTEs": "11",
  "manager": "10033037",
  "numberKvK": "111",
  "organizationType": "01",
  "numberOfEmployees": "121",
  "yearEstimation": "20231",
  "educationBudget": "4551"
}

 As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint.

{
    "requestId": "2cec716f-34f7-4602-b81c-a1c074d2937e"
}

 

Establishment Units:

- Get: https://api.youserve.nl/hrp/v1.0/establishmentUnits

- Get: https://api.youserve.nl/hrp/v1.0/establishmentUnits/10054043

Response example:

{
    "id": 10054043,
    "code": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "@710e1"
        }
    ],
    "name": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "Ve8l7t"
        }
    ],
    "numberKvK": [],
    "addresses": [
        {
            "type": "WorkLocation",
            "country": [],
            "regionNameAbroad": [],
            "municipality": [],
            "location": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "2017-12-31T00:00:00Z",
                    "value": "Amersfoort"
                },
                {
                    "startDate": "2018-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "Enschede"
                }
            ],
            "locationDescription": [],
            "street": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "2017-12-31T00:00:00Z",
                    "value": "Vlasblom"
                },
                {
                    "startDate": "2018-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "Rembrandtlaan"
                }
            ],
            "streetHouseNumber": [],
            "houseNumber": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "2017-12-31T00:00:00Z",
                    "value": "34"
                },
                {
                    "startDate": "2018-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "225"
                }
            ],
            "houseNumberSuffix": [],
            "postalCode": [
                {
                    "startDate": "2006-01-01T00:00:00Z",
                    "endDate": "2017-12-31T00:00:00Z",
                    "value": "9999 AA"
                },
                {
                    "startDate": "2018-01-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "7545 ZW"
                }
            ]
        },
        {
            "type": "Mailing",
            "country": [
                {
                    "startDate": "2016-04-01T00:00:00Z",
                    "endDate": "9999-12-31T00:00:00Z",
                    "value": "NL"
                }
            ],
            "regionNameAbroad": [],
            "municipality": [],
            "location": [],
            "locationDescription": [],
            "street": [],
            "streetHouseNumber": [],
            "houseNumber": [],
            "houseNumberSuffix": [],
            "postalCode": []
        }
    ],
    "website": [
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "www.added.com"
        }
    ],
    "emailAddress": [],
    "telephoneNumber": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "2023-03-22T00:00:00Z",
            "value": "033-4506506"
        },
        {
            "startDate": "2023-03-23T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "112"
        }
    ],
    "faxNumber": [
        {
            "startDate": "2006-01-01T00:00:00Z",
            "endDate": "9999-12-31T00:00:00Z",
            "value": "033-4506708"
        }
    ]
}

 

 

Request status

All asynchronous operations return a requestId. This endpoint allows to check the status of the request using the requestId.

 

Get the addresses of all employees of a customer:

- Get: https://api.youserve.nl/hrp/v1.0/requests/31118e5d-cc72-4d43-a644-57a1afbed118

 

Response example: (in failure)

{
    "processStatus": "Finished",
    "timeStamp": "2023-03-27 08:48:39",
    "result": {
        "status": "Failed",
        "errorMessages": [
            "Value in field is not unique within: Company"
        ]
    }
}

 

 

Postman collection and environment

As attachment you can find a zip file with the collection and the environment.

 

 

Medewerkers