ContractsApi

All URIs are relative to https://api-eu1.sesametime.com

Method	HTTP request	Description
createNewContract	POST /contract/v1/contracts	Create a contract
deleteContract	DELETE /contract/v1/contracts/{contractId}	Delete a contract
getByEmployeeId	GET /contract/v1/contracts/{employeeId}	Get contracts by employee
getCurrentContractByEmployeeId	GET /contract/v1/contracts/{employeeId}/current-contract	Get current contract by employeeId
updateContract	PUT /contract/v1/contracts/{contractId}	Update a contract

createNewContract

ContractsCreateNewContractResponse createNewContract(contractsCreateNewContractRequest).execute();

Create a contract

Example

import com.konfigthis.client.ApiClient;
import com.konfigthis.client.ApiException;
import com.konfigthis.client.ApiResponse;
import com.konfigthis.client.SesameHr;
import com.konfigthis.client.Configuration;
import com.konfigthis.client.auth.*;
import com.konfigthis.client.model.*;
import com.konfigthis.client.api.ContractsApi;
import java.util.List;
import java.util.Map;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    Configuration configuration = new Configuration();
    configuration.host = "https://api-eu1.sesametime.com";
    
    // Configure HTTP bearer authorization: Bearer
    configuration.token = "BEARER TOKEN";
    SesameHr client = new SesameHr(configuration);
    UUID employeeId = UUID.randomUUID(); // The ID of the employee
    LocalDate startAt = LocalDate.now(); // Start date of contract
    String code = "code_example"; // Code of the contract
    LocalDate endAt = LocalDate.now(); // end date of contract
    String comment = "comment_example"; // Comments
    try {
      ContractsCreateNewContractResponse result = client
              .contracts
              .createNewContract(employeeId, startAt, code)
              .endAt(endAt)
              .comment(comment)
              .execute();
      System.out.println(result);
      System.out.println(result.getData());
      System.out.println(result.getMeta());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#createNewContract");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }

    // Use .executeWithHttpInfo() to retrieve HTTP Status Code, Headers and Request
    try {
      ApiResponse<ContractsCreateNewContractResponse> response = client
              .contracts
              .createNewContract(employeeId, startAt, code)
              .endAt(endAt)
              .comment(comment)
              .executeWithHttpInfo();
      System.out.println(response.getResponseBody());
      System.out.println(response.getResponseHeaders());
      System.out.println(response.getStatusCode());
      System.out.println(response.getRoundTripTime());
      System.out.println(response.getRequest());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#createNewContract");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
contractsCreateNewContractRequest	ContractsCreateNewContractRequest	Contract object that needs to be created

Return type

ContractsCreateNewContractResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

deleteContract

ContractsDeleteContractResponse deleteContract(contractId).execute();

Delete a contract

Example

import com.konfigthis.client.ApiClient;
import com.konfigthis.client.ApiException;
import com.konfigthis.client.ApiResponse;
import com.konfigthis.client.SesameHr;
import com.konfigthis.client.Configuration;
import com.konfigthis.client.auth.*;
import com.konfigthis.client.model.*;
import com.konfigthis.client.api.ContractsApi;
import java.util.List;
import java.util.Map;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    Configuration configuration = new Configuration();
    configuration.host = "https://api-eu1.sesametime.com";
    
    // Configure HTTP bearer authorization: Bearer
    configuration.token = "BEARER TOKEN";
    SesameHr client = new SesameHr(configuration);
    UUID contractId = UUID.randomUUID(); // Contract ID
    try {
      ContractsDeleteContractResponse result = client
              .contracts
              .deleteContract(contractId)
              .execute();
      System.out.println(result);
      System.out.println(result.getData());
      System.out.println(result.getMeta());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#deleteContract");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }

    // Use .executeWithHttpInfo() to retrieve HTTP Status Code, Headers and Request
    try {
      ApiResponse<ContractsDeleteContractResponse> response = client
              .contracts
              .deleteContract(contractId)
              .executeWithHttpInfo();
      System.out.println(response.getResponseBody());
      System.out.println(response.getResponseHeaders());
      System.out.println(response.getStatusCode());
      System.out.println(response.getRoundTripTime());
      System.out.println(response.getRequest());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#deleteContract");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
contractId	UUID	Contract ID

Return type

ContractsDeleteContractResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Object	-

getByEmployeeId

ContractsGetByEmployeeIdResponse getByEmployeeId(employeeId).limit(limit).page(page).execute();

Get contracts by employee

Example

import com.konfigthis.client.ApiClient;
import com.konfigthis.client.ApiException;
import com.konfigthis.client.ApiResponse;
import com.konfigthis.client.SesameHr;
import com.konfigthis.client.Configuration;
import com.konfigthis.client.auth.*;
import com.konfigthis.client.model.*;
import com.konfigthis.client.api.ContractsApi;
import java.util.List;
import java.util.Map;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    Configuration configuration = new Configuration();
    configuration.host = "https://api-eu1.sesametime.com";
    
    // Configure HTTP bearer authorization: Bearer
    configuration.token = "BEARER TOKEN";
    SesameHr client = new SesameHr(configuration);
    UUID employeeId = UUID.randomUUID(); // Employee ID
    Integer limit = 56; // Limit results
    Integer page = 56; // Request a specific page
    try {
      ContractsGetByEmployeeIdResponse result = client
              .contracts
              .getByEmployeeId(employeeId)
              .limit(limit)
              .page(page)
              .execute();
      System.out.println(result);
      System.out.println(result.getData());
      System.out.println(result.getMeta());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#getByEmployeeId");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }

    // Use .executeWithHttpInfo() to retrieve HTTP Status Code, Headers and Request
    try {
      ApiResponse<ContractsGetByEmployeeIdResponse> response = client
              .contracts
              .getByEmployeeId(employeeId)
              .limit(limit)
              .page(page)
              .executeWithHttpInfo();
      System.out.println(response.getResponseBody());
      System.out.println(response.getResponseHeaders());
      System.out.println(response.getStatusCode());
      System.out.println(response.getRoundTripTime());
      System.out.println(response.getRequest());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#getByEmployeeId");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
employeeId	UUID	Employee ID
limit	Integer	Limit results	[optional]
page	Integer	Request a specific page	[optional]

Return type

ContractsGetByEmployeeIdResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Array of Objects	-

getCurrentContractByEmployeeId

ContractsGetCurrentContractByEmployeeIdResponse getCurrentContractByEmployeeId(employeeId).execute();

Get current contract by employeeId

Example

import com.konfigthis.client.ApiClient;
import com.konfigthis.client.ApiException;
import com.konfigthis.client.ApiResponse;
import com.konfigthis.client.SesameHr;
import com.konfigthis.client.Configuration;
import com.konfigthis.client.auth.*;
import com.konfigthis.client.model.*;
import com.konfigthis.client.api.ContractsApi;
import java.util.List;
import java.util.Map;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    Configuration configuration = new Configuration();
    configuration.host = "https://api-eu1.sesametime.com";
    
    // Configure HTTP bearer authorization: Bearer
    configuration.token = "BEARER TOKEN";
    SesameHr client = new SesameHr(configuration);
    UUID employeeId = UUID.randomUUID(); // Employee ID
    try {
      ContractsGetCurrentContractByEmployeeIdResponse result = client
              .contracts
              .getCurrentContractByEmployeeId(employeeId)
              .execute();
      System.out.println(result);
      System.out.println(result.getData());
      System.out.println(result.getMeta());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#getCurrentContractByEmployeeId");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }

    // Use .executeWithHttpInfo() to retrieve HTTP Status Code, Headers and Request
    try {
      ApiResponse<ContractsGetCurrentContractByEmployeeIdResponse> response = client
              .contracts
              .getCurrentContractByEmployeeId(employeeId)
              .executeWithHttpInfo();
      System.out.println(response.getResponseBody());
      System.out.println(response.getResponseHeaders());
      System.out.println(response.getStatusCode());
      System.out.println(response.getRoundTripTime());
      System.out.println(response.getRequest());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#getCurrentContractByEmployeeId");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
employeeId	UUID	Employee ID

Return type

ContractsGetCurrentContractByEmployeeIdResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

updateContract

ContractsUpdateContractResponse updateContract(contractId, contractsUpdateContractRequest).execute();

Update a contract

Example

import com.konfigthis.client.ApiClient;
import com.konfigthis.client.ApiException;
import com.konfigthis.client.ApiResponse;
import com.konfigthis.client.SesameHr;
import com.konfigthis.client.Configuration;
import com.konfigthis.client.auth.*;
import com.konfigthis.client.model.*;
import com.konfigthis.client.api.ContractsApi;
import java.util.List;
import java.util.Map;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    Configuration configuration = new Configuration();
    configuration.host = "https://api-eu1.sesametime.com";
    
    // Configure HTTP bearer authorization: Bearer
    configuration.token = "BEARER TOKEN";
    SesameHr client = new SesameHr(configuration);
    LocalDate startAt = LocalDate.now(); // Start date of contract
    String code = "code_example"; // Code of the contract
    UUID contractId = UUID.randomUUID(); // Contract ID
    LocalDate endAt = LocalDate.now(); // end date of contract
    String comment = "comment_example"; // Comments
    try {
      ContractsUpdateContractResponse result = client
              .contracts
              .updateContract(startAt, code, contractId)
              .endAt(endAt)
              .comment(comment)
              .execute();
      System.out.println(result);
      System.out.println(result.getData());
      System.out.println(result.getMeta());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#updateContract");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }

    // Use .executeWithHttpInfo() to retrieve HTTP Status Code, Headers and Request
    try {
      ApiResponse<ContractsUpdateContractResponse> response = client
              .contracts
              .updateContract(startAt, code, contractId)
              .endAt(endAt)
              .comment(comment)
              .executeWithHttpInfo();
      System.out.println(response.getResponseBody());
      System.out.println(response.getResponseHeaders());
      System.out.println(response.getStatusCode());
      System.out.println(response.getRoundTripTime());
      System.out.println(response.getRequest());
    } catch (ApiException e) {
      System.err.println("Exception when calling ContractsApi#updateContract");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
contractId	UUID	Contract ID
contractsUpdateContractRequest	ContractsUpdateContractRequest	Contract object that needs to be updated

Return type

ContractsUpdateContractResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

Files

ContractsApi.md

Latest commit

History

ContractsApi.md

File metadata and controls

ContractsApi

createNewContract

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteContract

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getByEmployeeId

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCurrentContractByEmployeeId

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateContract

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details