Skip to main content

OAS Inquiry Pay Equity

This OpenAPI specification defines a set of APIs for the exchange of the SETU Inquiry Pay Equity.

The APIs are organized into tags for easy navigation and include descriptions for each set of APIs. The available tag includes 'Inquiry Pay Equity,' and the 'Inquiry Pay Equity request*'. Additionally, this API specification also provides tags for different scenarios that might be encountered during the use of the SETU API for Inquiry Pay Equity. These scenarios include 'Scenario 1 | Supplier software APIs' and 'Scenario 2 | Supplier backoffice APIs'. These tags group together the API calls that are available for a specific scenario, making it easier for developers to understand which endpoints are necessary to implement in each case.

The request body of each API call in the OpenAPI specification is also available in Semantic Treehouse. Theese request bodies are standardised message structure, which ensure that the request and response data of the API calls adhere to a common and standardised format, facilitating interoperability and ease of use across different software systems. More information about the SETU standards can be found here.

API docs by Redocly

SETU API for Inquiry Pay Equity (2.0.0)

Download OpenAPI specification:Download

License: MIT

Set of API specifications that allows for exchange of information related to the equal pay of flexworkers. Moreover, the API allows to exchange information regarding salarishuizen, toeslagen regelen, en andere regelingen die van toepassing zijn op 1 of meerdere functies.

More about SETU

Models

Inquiry Pay Equity

required
object (Identifier)

The unique identifier of this arrangement.

object

The version identifier is a customer-specific identifier used to distinguish one version of the SETU Inquiry Pay Equity message from another.

issued
string <date-time>

The datetime the document was issued.

required
object (EffectivePeriod)

Indicates the validity period of this regulation. The period is from the start date up to and including the end date.

required
object (Party)

The customer/hirer of the worker.

Array of objects (BaseDefinition)
object (LabourAgreements)

This container indicates in which sector the staffing customer works and which specific collective labour agreement (CLA) and/or the own employment conditions scheme is leading for the provision of remuneration information.

Array of objects (PositionProfile)
required
Array of objects (RemunerationPackage) non-empty
Array of objects (AllowanceArrangement)
Array of objects (HolidayAllowanceArrangement)
Array of objects (SickPayArrangement)
Array of objects (LeaveArrangement)
Array of objects (IndividualChoiceBudgetArrangement)
Array of objects (PensionArrangement)
Array of objects (SustainableEmployabilityArrangement)
Array of objects (SupplementaryArrangement)
Array of objects (OtherArrangement)
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Condition

One of
conditionType
required
string
Value: "Age"
operator
required
string (Operators)
Enum: "eq" "neq" "gt" "gte" "lt" "lte" "in"

Comparison operator used in conditions

age
required
number

The age of the employee in years. The unit is always in years. Decimals are allowed (e.g. 18.5 years).

Example
{
  • "conditionType": "Age",
  • "operator": "gte",
  • "age": 18
}

Occurrence

One of
occurrenceType
required
string
Value: "Single"
date
required
string <date-time>

Point in time according to ISO 8601-1 format.

Example
{
  • "occurrenceType": "Single",
  • "date": "2026-12-15"
}

Inquiry Pay Equity

Set of APIs for exchanging pay equity information.

Submit or update an inquiry-pay-equity message. In case of an update, the request body replaces all previous shared information of the resource.

path Parameters
id
required
string
Example: c93efb20-1acd-447b-87e7-fadb108d8a0e

This is the resource identifier assigned by the API client to the created resource. This is the id parameter used in path operations, for GET, PUT and DELETE operations.

header Parameters
setuVersionId
required
string
Example: 2.0

Specification of the SETU standard version that is used as body message.

Content-Type
required
string
Value: "application/json"
Example: application/json
Request Body schema: application/json

Complete inquiry-pay-equity message as specified by SETU.

required
object (Identifier)

The unique identifier of this arrangement.

object

The version identifier is a customer-specific identifier used to distinguish one version of the SETU Inquiry Pay Equity message from another.

issued
string <date-time>

The datetime the document was issued.

required
object (EffectivePeriod)

Indicates the validity period of this regulation. The period is from the start date up to and including the end date.

required
object (Party)

The customer/hirer of the worker.

Array of objects (BaseDefinition)
object (LabourAgreements)

This container indicates in which sector the staffing customer works and which specific collective labour agreement (CLA) and/or the own employment conditions scheme is leading for the provision of remuneration information.

Array of objects (PositionProfile)
required
Array of objects (RemunerationPackage) non-empty
Array of objects (AllowanceArrangement)
Array of objects (HolidayAllowanceArrangement)
Array of objects (SickPayArrangement)
Array of objects (LeaveArrangement)
Array of objects (IndividualChoiceBudgetArrangement)
Array of objects (PensionArrangement)
Array of objects (SustainableEmployabilityArrangement)
Array of objects (SupplementaryArrangement)
Array of objects (OtherArrangement)

Responses

Request samples

Content type
application/json
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Response samples

Content type
application/json
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Get the information about an existing inquiry-pay-equity message

path Parameters
id
required
string
Example: c93efb20-1acd-447b-87e7-fadb108d8a0e

This is the resource identifier assigned by the API client to the created resource. This is the id parameter used in path operations, for GET, PUT and DELETE operations.

header Parameters
Content-Type
required
string
Value: "application/json"
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Remove an existing inquiry-pay-equity

path Parameters
id
required
string
Example: 049b4540-620f-434a-bfd1-d09f9e8cdc8c

The resource identifier of the inquiry-pay-equity as a whole

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Scenario 1 | Supplier backoffice APIs

Set of APIs to be implemented by the backoffice of the supplier.

Submit or update an inquiry-pay-equity message. In case of an update, the request body replaces all previous shared information of the resource.

path Parameters
id
required
string
Example: c93efb20-1acd-447b-87e7-fadb108d8a0e

This is the resource identifier assigned by the API client to the created resource. This is the id parameter used in path operations, for GET, PUT and DELETE operations.

header Parameters
setuVersionId
required
string
Example: 2.0

Specification of the SETU standard version that is used as body message.

Content-Type
required
string
Value: "application/json"
Example: application/json
Request Body schema: application/json

Complete inquiry-pay-equity message as specified by SETU.

required
object (Identifier)

The unique identifier of this arrangement.

object

The version identifier is a customer-specific identifier used to distinguish one version of the SETU Inquiry Pay Equity message from another.

issued
string <date-time>

The datetime the document was issued.

required
object (EffectivePeriod)

Indicates the validity period of this regulation. The period is from the start date up to and including the end date.

required
object (Party)

The customer/hirer of the worker.

Array of objects (BaseDefinition)
object (LabourAgreements)

This container indicates in which sector the staffing customer works and which specific collective labour agreement (CLA) and/or the own employment conditions scheme is leading for the provision of remuneration information.

Array of objects (PositionProfile)
required
Array of objects (RemunerationPackage) non-empty
Array of objects (AllowanceArrangement)
Array of objects (HolidayAllowanceArrangement)
Array of objects (SickPayArrangement)
Array of objects (LeaveArrangement)
Array of objects (IndividualChoiceBudgetArrangement)
Array of objects (PensionArrangement)
Array of objects (SustainableEmployabilityArrangement)
Array of objects (SupplementaryArrangement)
Array of objects (OtherArrangement)

Responses

Request samples

Content type
application/json
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Response samples

Content type
application/json
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Get the information about an existing inquiry-pay-equity message

path Parameters
id
required
string
Example: c93efb20-1acd-447b-87e7-fadb108d8a0e

This is the resource identifier assigned by the API client to the created resource. This is the id parameter used in path operations, for GET, PUT and DELETE operations.

header Parameters
Content-Type
required
string
Value: "application/json"
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Remove an existing inquiry-pay-equity

path Parameters
id
required
string
Example: 049b4540-620f-434a-bfd1-d09f9e8cdc8c

The resource identifier of the inquiry-pay-equity as a whole

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Scenario 2 | Supplier backoffice APIs

Set of APIs to be implemented by the backoffice of the supplier.

Submit or update an inquiry-pay-equity message. In case of an update, the request body replaces all previous shared information of the resource.

path Parameters
id
required
string
Example: c93efb20-1acd-447b-87e7-fadb108d8a0e

This is the resource identifier assigned by the API client to the created resource. This is the id parameter used in path operations, for GET, PUT and DELETE operations.

header Parameters
setuVersionId
required
string
Example: 2.0

Specification of the SETU standard version that is used as body message.

Content-Type
required
string
Value: "application/json"
Example: application/json
Request Body schema: application/json

Complete inquiry-pay-equity message as specified by SETU.

required
object (Identifier)

The unique identifier of this arrangement.

object

The version identifier is a customer-specific identifier used to distinguish one version of the SETU Inquiry Pay Equity message from another.

issued
string <date-time>

The datetime the document was issued.

required
object (EffectivePeriod)

Indicates the validity period of this regulation. The period is from the start date up to and including the end date.

required
object (Party)

The customer/hirer of the worker.

Array of objects (BaseDefinition)
object (LabourAgreements)

This container indicates in which sector the staffing customer works and which specific collective labour agreement (CLA) and/or the own employment conditions scheme is leading for the provision of remuneration information.

Array of objects (PositionProfile)
required
Array of objects (RemunerationPackage) non-empty
Array of objects (AllowanceArrangement)
Array of objects (HolidayAllowanceArrangement)
Array of objects (SickPayArrangement)
Array of objects (LeaveArrangement)
Array of objects (IndividualChoiceBudgetArrangement)
Array of objects (PensionArrangement)
Array of objects (SustainableEmployabilityArrangement)
Array of objects (SupplementaryArrangement)
Array of objects (OtherArrangement)

Responses

Request samples

Content type
application/json
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Response samples

Content type
application/json
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Get the information about an existing inquiry-pay-equity message

path Parameters
id
required
string
Example: c93efb20-1acd-447b-87e7-fadb108d8a0e

This is the resource identifier assigned by the API client to the created resource. This is the id parameter used in path operations, for GET, PUT and DELETE operations.

header Parameters
Content-Type
required
string
Value: "application/json"
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "documentId": {
    },
  • "versionId": {
    },
  • "issued": "2019-08-24T14:15:22Z",
  • "effectivePeriod": {
    },
  • "customer": {
    },
  • "baseDefinition": [
    ],
  • "labourAgreements": {
    },
  • "positionProfile": [
    ],
  • "remuneration": [
    ],
  • "allowance": [
    ],
  • "holidayAllowance": [
    ],
  • "sickPay": [
    ],
  • "leave": [
    ],
  • "individualChoiceBudget": [
    ],
  • "pension": [
    ],
  • "sustainableEmployability": [
    ],
  • "supplementaryArrangement": [
    ],
  • "otherArrangement": [
    ]
}

Remove an existing inquiry-pay-equity

path Parameters
id
required
string
Example: 049b4540-620f-434a-bfd1-d09f9e8cdc8c

The resource identifier of the inquiry-pay-equity as a whole

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Inquiry Pay Equity request

TO BE DEVELOPED