MAmaqqie
EmploymentContract

Set the start and end date of an existing employment contract

Changed on

Set the start and end date of an existing employment contract. When the end date is not provided, it's automatically calculated based on the provided start date and the duration that was specified when creating the employment contract. This step is necessary before creating placements for this employment contract. It's not possible to change the dates of an employment contract when they are already set

post/public/employment-contract/v1/set-employment-contract-dates

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.

Request body

employmentContractIdstring uuid required

The unique id of the employment contract.

startDatestring date required

The new start date of the employment contract.

endDatestring date

The new end date of the employment contract. When not provided, it will be calculated based on the provided start date and the duration specified when creating the employment contract.

Response

Successfully set the employment contract dates

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

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

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

    • breaking

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

    • info

      added the new optional request property

    • 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 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

    • info

      added the required property to the response with the status

  • 3352b56bb8feRevision changes
    • breaking

      the request's body type changed from object to no type

    • breaking

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

    • breaking

      the response's body 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

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • 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

    • warning

      removed the optional property from the response with the status