MAmaqqie
EmploymentContract

Get active employment contracts for the given worker

Changed on

Get employment contracts for the given worker. The response is sorted by descending end date of the employment contract, then by descending start date.

get/public/employment-contract/v1/get-active-employment-contracts

Request

  • Base URL
    https://api.maqqie.app (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://maqqie.app/auth/realms/maqqie/protocol/openid-connect/token

Query parameters

workerIdstring uuid required

The unique id of the worker, as returned from the /create-worker endpoint.

Response

Success

employmentContractIdstring uuid required

The unique id of the employment contract.

hoursPerWeeknumber required

The number of hours the worker will work per week for this employment contract.

isPayrollTaxReductionboolean required

Whether the payroll tax reduction applies to this employment contract.

type'PHASE_B' | 'PHASE_C' required

The type of the employment contract

status'PENDING_SIGNATURE' | 'DOCUMENT_SIGNING_PERIOD_EXPIRED' | 'ACTIVE' | 'EXPIRED' required

The status of the employment contract

startDatestring date

The start date of the employment contract.

endDatestring date

The end date of the employment contract. The contract runs up to and including this date.

signingUrlstring

A URL to sign the employment contract. This is only provided when the contract is in PENDING_SIGNATURE status.

signingUrlExpirationTimestring date-time

The timestamp (UTC) at which the signing URL will expire. This is only provided when the contract is in PENDING_SIGNATURE status.

Changes

  • f9510f3f4b22Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 3352b56bb8feRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status